Overview

Admin, Storefront, Auth, and UCP resolve authentication and context differently. Use the endpoint reference as the contract and these guides to implement the full workflow.

Choose an API

API	What it is for	Main context
Admin	Manage catalog, orders, inventory, and settings.	OAuth token plus store or seller context.
Storefront	Read the store and run shopper flows.	`x-Store-Domain` header; some operations also require a session.
Auth	Issue tokens and manage user accounts.	OAuth application or user session, depending on the operation.
UCP	Connect agents to catalog, cart, and checkout.	UCP profile plus OAuth or API key, depending on the operation.

The Auth token endpoint uses an OAuth form. Do not assume its errors or request body match Admin endpoints.

Start here

Set up an integration

Create an OAuth application, get a token, and call Admin.

Authentication

Use client credentials, protect the secret, and renew access.

Context and hierarchy

Resolve organization, store, and seller for each API.

Implement the workflow

Pagination

Distinguish cursor, page/pageSize, and limit-only queries.

Webhook events

Choose events, verify deliveries, and process retries.

Operate safely

Errors

Distinguish Problem Details, OAuth errors, and infrastructure failures.

Error codes

Look up documented codes and the status that produces them.

Rate limits

Handle request-rate limits, concurrency limits, and 429 responses.

Agent tools

Combine Markdown and OpenAPI without inventing fields or permissions.

Before you start

For an Admin integration, create an OAuth application in the dashboard. The application provides a client_id and client_secret; an API key is a different credential and does not replace them.
Identify the correct store. At the central gateway, Storefront uses x-Store-Domain with the slug or a configured domain. Admin gets its context from token claims.
Read the endpoint page before coding. It defines authentication, parameters, pagination, request body, and responses.