Consignment Products
Add a product to a consignment
Add a product to the given consignment.
If the type is SUPPLIER then:
- Cannot add a product to a RECEIVED or CANCELLED order
- Cannot add a composite product to the order
- If a received value is provided for a consignment product for a SENT Supplier Order - the order will be automatically marked as DISPATCHED
If the type is OUTLET then:
- If a cost value is not provided for a consignment product on an OPEN Outlet order - the cost will be automatically populated after the fact using the most accurate average cost of the product at the time of marking the consignment as 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
post/consignments/{consignment_id}/products
Path parameters
consignment_idstring uuid required
The consignment id
Request body
Response
OK