Check Archiveable Products
POST/api/shopify/:integrationInstance/products/archiveable
Checks which of the given Shopify products can be archived. Products that appear on synced Shopify orders cannot be archived; the response lists each product with a boolean and the blocking reason (false when archiveable).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Body fields:
- ids (array of integers): SKU.io row IDs of Shopify products on this instance. Required unless mode is "all".
- mode (string, optional): "all" targets every product on the instance and ignores ids.
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.