Bulk Archive Faire Orders
POST/api/faire/instances/:integrationInstance/orders/bulk-archive
Archives multiple Faire orders for the given integration instance. Scoped to active orders only — already-archived rows are silently skipped, and IDs from foreign integration instances are NOT affected (the controller filters where('integration_instance_id', $instance->id)).
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Operates in chunks of 100 to keep the query small.
Path Parameters:
integrationInstance— The ID of the integration instance
Body:
ids(required, array of integers) — Faire order IDs to archive. Must be a non-empty array.
Response Fields:
message— Human-readable resultarchived_count— Number of rows actually flipped (excludes IDs that were already archived or belong to other instances)
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.