commerce

Mark an order ready for collection

Tell the buyer of a paid collection order that it is ready to collect: one email in the business's name, with the shop's collection note.

A malformed UUID answers 400 validation_failed before resource access; a well-formed unknown UUID or one outside your workspace answers 404.

Only a paid order with fulfilment.method collection that has not been collected can be marked; anything else answers 409 conflict with the reason. It takes no body.

The buyer is emailed once, as the ready_for_collection kind in the order's emails: subject "Your order #1043 is ready to collect", with the collection note from the shop's fulfilment settings read when it is sent. A failed send is tried again automatically. Editing the collection note afterwards does not send it again.

Marking an order that is already ready answers 200 with its first ready_for_collection_at and already_ready: true, and sends nothing again. Retrying the call is safe.

There is no undo. Mark the order fulfilled with PATCH /api/v1/commerce/orders/{id}/fulfilment when the buyer collects it; a refund ends it too.

post/api/v1/commerce/orders/{id}/ready-for-collection

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/commerce/orders/{id}/ready-for-collection
  • Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Response

Success

okboolean required
ready_for_collection_atstring date-time required
already_readyboolean required

Example response

{
  "ok": true,
  "ready_for_collection_at": "2026-08-03T10:15:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.