Skip to main content

Admin API — Common Workflows

Golden operational paths for the Admin API. Each workflow should list the ordered calls and link to the matching operation in the interactive reference.

Stub — add real workflows.

Capture the admin/ops workflows the team performs most and link each step to the reference.

Suggested workflows to document:

  1. Onboard an account — create the account and configure limits/settings.
  2. Manage an index — inspect settings/infrastructure, adjust limits.
  3. Trigger a reindex — kick off and monitor a reindexing run.
  4. Connect a Shopify store — onboarding and store configuration.

For authentication, see Authentication.