Skip to content
v0.3

order.shipment.mark_ready_for_pickup

Mark ONE parcel as waiting at its pickup point — the retrieval sibling of marking it shipped. Refused with document_required when the instance requires a document before dispatch and none is attached, while the order has an active hold, and on a parcel that is not being picked up. Idempotent by state. The ORDER advances only when every one of its parcels has gone.

  • Scope: order.write
  • System: no
  • Reachable from: POST /v1/commands/order.shipment.mark_ready_for_pickup (tenant credential) · MCP tool order.shipment.mark_ready_for_pickup · SDK client.call('order.shipment.mark_ready_for_pickup', …)
  • Events: shipment.ready_for_pickup, order.preparing, order.shipped
{
"properties": {
"order_id": {
"minLength": 1,
"type": "string"
},
"shipment_id": {
"minLength": 1,
"type": "string"
}
},
"required": [
"order_id",
"shipment_id"
],
"type": "object"
}
{
"additionalProperties": false,
"properties": {
"order_id": {
"type": "string"
},
"order_status": {
"type": "string"
},
"ready_for_pickup_at": {
"type": "string"
},
"shipment_id": {
"type": "string"
}
},
"required": [
"order_id",
"shipment_id",
"ready_for_pickup_at",
"order_status"
],
"type": "object"
}

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)