Set Returns Access
PUT/api/shopify/:integrationInstance/returns-access
Toggle whether the Shopify GraphQL returns field should be queried when this integration instance syncs orders. Set to false when the app installation lacks the read_returns permission scope — Shopify rejects the field with "Access denied for returns field" otherwise. The system also auto-flips this to false the first time that error is observed.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Request body:
- has_returns_access (required, boolean): true to include returns in order syncs, false to exclude them.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Unprocessable Entity
Response Headers
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.