Skip to main content

Archive Faire Order

POST 

/api/faire/orders/:order/archive

Archives a single Faire order — stamps archived_at = now() via the Archive trait. Archived orders are excluded from the auto-create-SKU-orders pipelines (see createSkuOrders) and from the default orders listing (which uses filter[archived]= Active by default).

Idempotent: archiving an already-archived order returns archived: false with a friendly message.

Path Parameters:

  • order — The internal Faire order ID (faire_orders.id)

Response Fields:

  • message — Human-readable result
  • archivedtrue when the call flipped the row, false if it was already archived

Request

Responses

Successful response