Update a consignment

Updates the given consignment.

If the type is SUPPLIER then:

  • Cannot change from SUPPLIER to a different consignment type
  • SUPPLIER workflow: OPEN -> SENT -> DISPATCHED -> RECEIVED
  • Can be CANCELLED at any time, except from RECEIVED
  • Cannot update a SUPPLIER consignment that has the status RECEIVED or CANCELLED
  • Cannot update status if there are no products in the order
  • At least one product should have non-zero received quantity before updating to RECEIVED

🔒 Requires: One of the following scopes:

  • consignments:write:stock_order scope for SUPPLIER and RETURN consignments
  • consignments:write:stock_transfer scope for OUTLET consignments
  • consignments:write:inventory_count scope for STOCKTAKE consignments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The consignment id

Body Params
data
object
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json