Reference
Public entry point for REST reference pages, OpenAPI specs, and Search GraphQL reference guidance.
Find exact REST endpoints, OpenAPI contracts, and Search GraphQL details from the route that matches your job.
Start here
Open the shortcut that matches the job:
- Product work across storefront and admin boundaries: Products.
- Order operations across management and auth boundaries: Orders.
- Identity and authenticated shopper state: Auth.
- Search GraphQL query guidance: Search GraphQL reference.
- Known API with schema-level detail: OpenAPI specs.
This area has two browse patterns:
- Browse by API when you already know whether the caller needs Management, Shopper, Auth, DAM, Integrations, or Search.
- Browse by subject when you know the job to do, such as Products, Variants, Categories, or Orders, and need the endpoint page to confirm the exact API.
REST endpoint pages and OpenAPI specs own method, path, parameters, request bodies, and response schemas. Subject hubs can include more than one API; each operation page shows the API, method, and path.
Choose a reference area
| Area | Start here | Use it for |
|---|---|---|
| Popular shortcuts | Popular reference | A compact, curated fast-entry page for the most common hubs before you drill into exact contracts. |
| API contracts | Management OpenAPI, Shopper OpenAPI, Auth, DAM | Start here when you already know which API owns the work and want the cleanest path to exact contracts. |
| Catalog subject hubs | Products, variants, categories, collections, brands | Subject-oriented hubs for catalog and merchandising work. Some hubs include both shopper reads and management writes, so use the endpoint page to confirm the API before implementing. |
| Commerce subject hubs | Orders, cart, wishlist, bundle rules, tax groups | Subject-oriented hubs for shopper and order work. Orders currently mixes auth and management operations; the endpoint page still owns the exact contract. |
| Users and access | Auth, users, merchant users, organisations, custom roles | Authentication, user records, team or organisation access, and role-related endpoints. |
| Media and assets | DAM, files, folders, images, videos, shareable links | Asset management and media metadata endpoints. For conceptual DAM guidance, use the Media guide; for fields and contracts, use reference. |
| Channels, markets, and groups | Channels, markets, store groups, customer groups, customer group pricing, translations, redirects | Market, channel, customer grouping, localization, routing, and storefront context endpoints. |
| Operations | Scheduling, logs | Operational endpoints that support scheduled work and system visibility. |
| OpenAPI specs | OpenAPI specs, Management, Shopper, Auth, DAM | Schema-level details, examples, and complete API contracts. |
| Search GraphQL | Search GraphQL reference | Search GraphQL routing guidance, root fields, operations, fragments, and SDK helper coverage. |
Fast path by question
| If the next question is... | Open this first | Why |
|---|---|---|
| “Which product endpoint owns this job?” | Products | Product work often crosses shopper and management boundaries, so the endpoint page should confirm the API. |
| “Which order endpoint owns this job?” | Orders | Orders currently mix management and auth operations; the endpoint page is the fastest authority check. |
| “What is the exact login or token endpoint?” | Auth | Auth is already grouped around exact endpoint lookup rather than broader workflow prose. |
| “I already know the API and want schema-level detail.” | OpenAPI specs | Open the complete contract for that API. |
| “I need Search fields, documents, or schema shape.” | Search GraphQL reference | Search uses GraphQL, not REST endpoint pages. |
Exact lookup
Use endpoint pages and OpenAPI specs for copy-paste-safe request and response details. Use prose guides for workflow, setup, and integration context.
What REST pages contain
Endpoint pages normally include:
- Operation summary
- Method and path with parameterized route placeholders
- Parameters for path, query, and headers
- Request body content type and schema reference when the operation accepts a body
- Responses with status codes, descriptions, and response schemas
Endpoint paths use colon-prefixed placeholders for path parameters, for example :team_slug or :app_id. Replace placeholders with real values from your app, team, market, or resource context before making a request.
API contracts
- Management API: reference, OpenAPI JSON.
- Shopper API: reference, OpenAPI JSON.
- Auth API: endpoint reference, OpenAPI JSON.
- DAM public reads: Folders, Media, Shareable Links, and OpenAPI JSON.
- Management DAM administration: DAM and Management OpenAPI JSON.
- Search GraphQL: Search GraphQL reference for fields, inputs, enums, fragments, operations, and nullability.
Exact contract lookup
For REST endpoints, prefer the endpoint page for the specific operation. If you need the complete schema graph or embedded examples, use the OpenAPI spec for that API.
For Search GraphQL, use the Search GraphQL reference route for exact fields, inputs, enum values, nullability, fragments, and operation shapes.
If a prose guide and a reference page disagree about a REST endpoint contract, trust the reference page and OpenAPI spec.