Edit ecommerce index settings

Context

You want to change an ecommerce index’s settings (e.g. search/collection params, merchandising fields, ecom API feature flags) for a customer or internal prod index to tweak the behaviour of the ecommerce API.

Common Examples

See Ecommerce Customer Details

• SwimOutlet: swimoutlet-prod (swimoutlet-prod)
• Internal SwimOutlet test index: swimoutlet-prod (internal)
• Kicks Crew: kickscrew-prod (kickscrew-prod)

Process

1. Use Escalator: Self-Service Admin to gain admin permission to the production Controller account (”Prod Controller Admin”), then sign into the prod Controller account as admin.
2. Navigate to the prod-EcomIndexSettingsTable item explorer, and find your target index’s record (query with pk = the index’s system account ID if necessary).

3. Click the pk value to open the record for editing.

   

4. Edit the fields you need to change (one at a time or all at once). The most common fields to change are search_config (controls default search params), collections_config.default (for default collections params), and add_docs_config (for indexing settings like merchandising fields)

   • Updating a single field should be straightforward.

   • To sanity check larger changes, you can use a tool like https://www.diffchecker.com/ to compare the configs before and after:

     • Use the “JSON view” with “View DynamoDB JSON” disabled, and copy the content as your “before”.
     • Make the changes (either in JSON or in the “Form” view) then copy the resulting JSON as your “after”.
     • Inspect the diffs to validate they are as expected.
     • If you made the changes in another tool before pasting in as your “after”, paste the “after” JSON into the DDB JSON editor.

     

5. Click the “Save” button to commit the changes.