Outbound Shipment Items
List items in an outbound shipment
GET
/shipments/outbound/{outbound_shipment}/outbound-shipment-item| Parameter | Type | Examples | Description |
|---|---|---|---|
outbound_shipment Required | integer | 1 | The ID of the outbound shipment |
Example Response
Add an item to an outbound shipment
POST
/shipments/outbound/{outbound_shipment}/outbound-shipment-item| Parameter | Type | Examples | Description |
|---|---|---|---|
outbound_shipment Required | integer | 1 | The ID of the outbound shipment |
item_id Required | integer | 1 | The ID of the inventory item to add |
quantity Required | integer | 10 | The quantity of the item to add |
expiry_date Optional | string | 2025-01-01 | The expiry date for this item in YYYY-MM-DD format |
Example Response
Update an item in an outbound shipment
PATCH
/shipments/outbound/{outbound_shipment}/outbound-shipment-item/{outbound_shipment_item}| Parameter | Type | Examples | Description |
|---|---|---|---|
outbound_shipment Required | integer | 1 | The ID of the outbound shipment |
outbound_shipment_item Required | integer | 1 | The ID of the outbound shipment item |
quantity Optional | integer | 10 | The updated quantity of the item |
expiry_date Optional | string | 2025-01-01 | The updated expiry date in YYYY-MM-DD format |
Example Response
Remove an item from an outbound shipment
DELETE
/shipments/outbound/{outbound_shipment}/outbound-shipment-item/{outbound_shipment_item}| Parameter | Type | Examples | Description |
|---|---|---|---|
outbound_shipment Required | integer | 1 | The ID of the outbound shipment |
outbound_shipment_item Required | integer | 1 | The ID of the outbound shipment item |