Outbound Shipment Items
Index
Get a list of the items on an outbound shipment.
GET
/shipments/outbound/{SHIPMENT_ID}/outbound-shipment-itemExample Response
Create
Add a new item to an outbound shipment.
POST
/shipments/outbound/{SHIPMENT_ID}/outbound-shipment-item| Parameter | Type | Examples | Description |
|---|---|---|---|
item_id Required | integer | 12 | (required) The ID of the item that you are sending in the shipment. |
quantity Required | integer | 50 | (required) The quantity of the item that you are sending in the shipment. |
expiry_date Optional | date | 2025-12-31 | The expiry date of the item that you are sending in the shipment. |
Example Response
Update
Modify an item on an outbound shipment.
PATCH
/shipments/outbound/{SHIPMENT_ID}/outbound-shipment-item/{OUTBOUND_SHIPMENT_ITEM_ID}| Parameter | Type | Examples | Description |
|---|---|---|---|
quantity Required | integer | 50 | (required) The quantity of the item that you are sending in the shipment. |
expiry_date Optional | date | 2025-12-31 | The expiry date of the item that you are sending in the shipment. |
item_group_configurations Required | array<ItemGroupConfiguration> | [...] | (required) An array of item group configurations that you are sending in the shipment. |
item_group_configurations.*.configuration_id Required | integer | 12 | (required) The configuration ID for the item group configuration. |
item_group_configurations.*.quantity Required | integer | 5 | (required) The number of item groups that you are sending in the shipment. |
item_group_configurations.*.partial_quantity Required | integer | 1 | (required) The extra items not included in a full item group. |
Example Response
Delete
Remove an item from an outbound shipment.
DELETE
/shipments/outbound/{SHIPMENT_ID}/outbound-shipment-item/{OUTBOUND_SHIPMENT_ITEM_ID}