Get Preflight
GET/api/shopify/b2b/:integrationInstance/preflight
Whether this store may publish B2B catalogs right now, and what it will cost.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Reports the plan, whether catalogs can be assigned directly to company locations, the catalog cap, how many catalogs already exist, how many are needed, and the remaining headroom.
issues carries every finding. A blocking issue prevents publishing and always names the groups or locations it refers to. Warnings do not block.
Authentication: requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.