Archive Products
PUT/api/big-commerce/:integrationInstance/products/archive
Archive BigCommerce products (soft-delete). Products are marked as archived and hidden from default listings.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Fields:
- ids (required, array): Array of BigCommerce product IDs to archive. Must belong to this integration instance.
Bulk selection contract:
- {"ids": [1, 2]} — act on the given channel product IDs
- {"mode": "all"} — act on all products for the integration instance
- {"apply_to_all": true, "filters": {...}} — act only on products matching the filters. The filters object accepts the same filter keys as the corresponding products list endpoint (bare column keys) and/or a "filter_groups" tree (base64-encoded JSON). With apply_to_all and no filters, all products for the instance are targeted.
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.