Sign in
fulfillment-orders

Update a fulfillment order status (synchronous)

Transitions the fulfillment order to a new status, validated against the state machine version pinned on the FO at creation. On a valid transition it appends an immutable timeline event (FulfillmentOrderTrackingEvent) — the status change and the timeline entry run in a single transaction. Inventory effects are not applied by this endpoint. CANCELLED and REJECTED are not allowed here: they require a reason and go through the dedicated reject/cancel endpoint. accountCode and the actor (user or service account) come from the JWT.

patch/api/v1/fulfillment-orders/{id}/status

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Fulfillment order identifier (UUID).

Request body

metadataobject nullable
statusstring required

Response

Fulfillment order status updated.

idstring required
statusstring required
previous_statusstring required
updated_atstring required
event_idstring required

Changes

Changed in 2 of the 9 revisions of this API.16

  • a3b4750a505f15See the full diff
    • ▲

      added the new required request property status

      new-required-request-property

    • ○

      added the required property event_id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property previous_status to the response with the 200 status

      response-required-property-added

    • ○

      added the required property status to the response with the 200 status

      response-required-property-added

    • ○

      added the required property updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 84194c31ab851See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog