Public API
Quick answer
The API Reference documents the Shopfront public API at https://api.shopfront.app, with the OpenAPI file at https://docs.shopfront.app/api/openapi.yaml; send your API key as a bearer token, and GET /v1/health needs no key. POST /v1/products/generate is retired and returns 410 Gone, so use POST /v1/listings/generate.
Where is the API reference?
Open the API Reference for every endpoint's request and response schema. The same definition is available as an OpenAPI file.
| Server | URL |
|---|---|
| Production | https://api.shopfront.app |
| Development | https://api-dev.shopfront.app |
Send your key in the Authorization: Bearer header. Create a key in API keys.
Keep your key private
Keep your API key out of client-side code and shared URLs.
How do I check that the API is available?
Call GET /v1/health. It needs no key and returns the API status and version.
Which generation endpoint should I use?
Use POST /v1/listings/generate. It returns 402 when your monthly allowance is used up.
- Sync mode, the default with an API key, returns the generated listing in the response.
- Async mode returns a job ID that you check with
GET /v1/jobs/{id}.
Retired endpoint
POST /v1/products/generate is retired and returns 410 Gone. Jobs it created earlier can still be read with GET /v1/jobs/{id}.
API keys
Owners and admins create API keys in Settings → Workspace → API Keys with Create Key, and must copy the key when it is shown because it cannot be viewed again. Every key has full access to the workspace's API; Premium includes 3 keys, Premium Plus 10, and Free and Pro none.
Troubleshooting
Fixes for failed listings, a missing or outdated extension, a disconnected channel, an undetected sale, a stuck or duplicated import, and a price change that didn't reach the marketplace.