v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Consignment Products

Delete an item from a consignment

Removes the specific product from the consignment.

For SUPPLIER workflow:

  • Cannot delete a product from a consignment with a status of DISPATCHED, RECEIVED or CANCELLED

For consignment type OUTLET:

  • Cannot delete a product if the consignment has a status of SENT or RECEIVED

For consignment type RETURN:

  • Cannot delete a product if the consignment has a status of SENT

🔒 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
delete/consignments/{consignment_id}/products/{product_id}

Path parameters

consignment_idstring uuid required

The consignment id to be updated.

product_idstring uuid required

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