Skip to main content

Update order status

Update orders in Propeller to keep Backoffice users, sales reps and end customers in sync with what is happening in external systems. This is typically used after an order has been exported to an ERP or WMS and the logistics process is underway.

When to update order status​

After an order is exported to a third-party system for fulfillment, that system manages the logistics. As the order progresses (picking, packing, shipping, delivery), you want those status changes reflected in Propeller so everyone sees the current state of the order.

For adding shipment details and track and trace links, see Import order shipments.

Update an order​

Use the PATCH endpoint to update one or more fields on an existing order. Only the fields included in the request body are changed. Existing values are preserved for fields that are not included.

PATCH /v2/orders/id/35
{
    "status": "PLANNING"
}

Order statuses are configured per tenant in the Backoffice. Use the status values that match your environment's configuration.

Updating other fields​

The same endpoint can update other order fields in the same call. Common fields to update from an external system:

{
    "status": "PROCESSING",
    "reference": "ERP-REF-2026-0042",
    "remarks": "Priority shipment requested by customer"
}
  • reference: a reference number visible to the customer (for example a PO number or ERP reference)
  • remarks: internal notes on the order

For updating export metadata (exportStatus, exportMessage, exportedAt), see Export orders.

See also​