Get Shop Plan
GET/api/shopify/:integrationInstance/shop-plan
Fetch the shop plan from Shopify and return whether the store has Customer PII access via GraphQL. Basic/Starter plans do not have PII access — when false, customer email/addresses are excluded from order syncs.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Returns 500 if the Shopify GraphQL call fails.
Request
Responses
- 200
- 401
- 403
- 404
- 429
- 500
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.
Internal Server Error