Page type:
Reference. Endpoint-level request and response details come from the generated OpenAPI pages under this reference.Base URL
Authentication
Two authentication methods are supported:| Method | Header | Use Case |
|---|---|---|
| Bearer Token (JWT) | Authorization: Bearer {token} | Authenticated user requests |
| Channel API Key | x-channel-access-token: {key} | Server-to-server brand requests |
| Partner API Key | x-partner-access-token: {key} | Creator-facing requests |
API Shape
The API is easiest to understand through two primary access patterns.Channel-Centric (Brand Side)
Endpoints prefixed with/channels/{myshopifyDomain}/ are used by brands to manage their program:
- Channel settings — Read and update channel configuration
- Magic Links — Generate authenticated creator entry links
- Integrations — Connect, disconnect, and list external integrations
- Collabs — List, get, and update collaborations
- Tiers — Retrieve configured collab tiers
- Drops — Update product curation and enhancements
- Custom fields and forms — Manage channel-level field and form definitions
- Campaigns — Create, read, and update channel campaigns
- Metrics — Query session and revenue analytics
Creator-Centric (Creator Side)
Endpoints prefixed with/creators/ are used by creators to manage their own data:
- Collabs — View and update their collaborations
- Drops — Create and manage product curation
- Cart URLs — Generate checkout-ready URLs
- Forms — Fetch creator-facing custom forms
Capability Areas
The OpenAPI spec is organized around these capability areas:| Area | What it covers |
|---|---|
| Channels | Channel retrieval and settings |
| Magic Links | Authenticated creator entry flows |
| Integrations | Connected integration listings and lifecycle |
| Collabs | Brand-side and creator-side collaboration operations |
| Drops | Drop creation, updates, products, and enhancements |
| Custom Field Definitions | Channel-level field definitions |
| Form Definitions | Channel-level form definitions |
| Campaigns | Campaign creation and updates |
| Metrics | Session and revenue reporting |
| Checkout | Creator drop cart URL generation |
| Storage | Upload utility endpoints |
Response Format
All responses are returned in JSON format. Successful responses typically include adata object or the updated resource. Errors follow a consistent error response structure:
Where to Find Endpoint Details
- Use the generated endpoint groups in the navigation for request parameters, request bodies, response schemas, and examples.
- Use Authentication for credential strategy and header usage.
- Use Shopify Flow Actions for workflow automation actions that sit outside the REST endpoint catalog.
Quick Links
Authentication
Setup guide for API keys and JWT tokens
Shopify Flow Actions
Workflow automation actions connected to CreatorCommerce data