Archive Products (Bulk)

PUT 
/api/amazon/:integrationInstance/products/archive

Bulk-archives Amazon products. Body accepts either an explicit ID list, or mode: "all" to archive every product for this integration instance.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Body:

• ids (array<int>, required unless mode = all) — validated against existing IDs for this integration instance.
• mode (string, optional) — set to "all" to bypass ids and operate on every product.

Named route: amazon.products.archive.

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

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

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.

429

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.