List Your Shops
An integration is handed a key, not a shop id. This is where it learns them. An account may run more than one shop and name the same key on each; when it has, every other vendor call needs ?vendor= to say which, and this endpoint is how a script finds the id rather than having it read out of the website. A shop that is not approved accepts writes but shows nothing publicly.
- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- object[]
The response payload.
- string
Slug of the shop. This is the value to send as
?vendor=. - string
Display name, as the maker writes it.
- string | null
Official website, where one is known.
- string | null
ISO 4217 code the price is in, e.g.
AUD. Prices are integer minor units; format withIntl.NumberFormatat render rather than dividing first. - boolean
Whether staff have approved the shop. An unapproved shop accepts writes but shows nothing publicly.
- 400
VALIDATION_ERROR - 401
UNAUTHORIZED - 403
FORBIDDEN - 429
RATE_LIMITED - 500
INTERNAL_ERROR
A shop that is not approved accepts writes but shows nothing publicly. Nothing is lost while a reviewer is looking.
If exactly one shop names your key, every other call may omit vendor=.
- Minimum tier
- Enterprise
- Monthly quota
- 1,000,000/mo
- Rate limit
- 300/min
- Daily cap
- 50,000
Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.