v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Consignment Products

Bulk update consignment products

Add or update the products in a consignment in bulk.

Note: Must include either count or received for each product.

Note: It is not recommended to update more than 500 products at a time, as this may lead to server timeouts.

Note:

If the type is SUPPLIER then:

  • Cannot add a composite product by this api
  • Cannot update products if the consignment has a status of RECEIVED or CANCELLED
  • If status is OPEN or SENT, the count value will be accumulated
  • If status is DISPATCHED, the received quantity will be accumulated
  • If status is OPEN, SENT or DISPATCHED, the cost will be updated
  • If a received field is provided for consignment products in an OPEN or SENT Supplier Order - the order will be automatically marked as DISPATCHED. Remove the received field if you don't intend to dispatch the OPEN or SENT purchase order

🔒 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}/bulk

Path parameters

consignment_idstring uuid required

The consignment id

Request body

coststring nullable

The cost of the item.

countstring nullable

Expected item count.

created_atstring

The creation timestamp in UTC.

deleted_atstring nullable

The deletion timestamp in UTC.

is_includedboolean

Indicated whether the item was included via a filter. Can be null. For full count (no filters) always true.

product_idstring uuid required

The ID of the product.

product_skustring nullable

The SKU of the product.

receivedstring

Observed item count.

statusstring

The status of the item. One of: PENDING, SUCCESS.

updated_atstring

Last update timestamp in UTC.

versioninteger

Auto-incrementing object version number.

Response

OK