Update a product in a consignment

Updates the specific product within the consignment.

Notes:

  • If the type is SUPPLIER then:
    • If status is OPEN or SENT, the count value will be updated
    • If status is DISPATCHED, the received quantity will be updated
    • If status is OPEN, SENT or DISPATCHED, the cost can be updated
    • Cannot update a product in RECEIVED or CANCELLED status
    • Any updates to the received quantity field on a product in a SENT consignment, will set the consignment status to DISPATCHED
  • If the type is OUTLET then:
    • If the status is OPEN and there is a cost the cost will be updated.
    • If the status is SENT or DISPATCHED and received is not null the received quantity will be updated.
    • If the status is OPEN or SENT and count is not null then the count quantity will be updated.
  • If the type is RETURN and the status is OPEN or SENT and count is not null then the count quantity will be updated.
  • If the type is STOCKTAKE and the status is STATUS_STOCKTAKE_IN_PROGRESS or STATUS_STOCKTAKE_IN_PROCESS_PROCESSED and received is not null then the received quantity will be updated.

🔒 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 to be updated.

uuid
required

The product id of the product to be added to the consignment.

Body Params
data
object
required
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