Skip to main content

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)).

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 result
  • archived_count — Number of rows actually flipped (excludes IDs that were already archived or belong to other instances)

Request​

Responses​

Successful response