Inbound Shipment Items
Index
Get a list of the items on an inbound shipment.
GET
/shipments/inbound/{SHIPMENT_ID}/itemsExample Response
Add
Add a new item to an inbound shipment.
POST
/shipments/inbound/{SHIPMENT_ID}/add-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. |
Example Response
Update
Modify an item on an inbound shipment.
POST
/shipments/inbound/{SHIPMENT_ID}/update-item| Parameter | Type | Examples | Description |
|---|---|---|---|
item_id Required | integer | 12 | (required) The ID of the item that you are updating |
expected Required | array<ExpectedItem> | [...] | (required) An array of expected items that you are receiving in the shipment. |
expected.quantity Required | integer | 50 | (required) The quantity of the item that you are receiving in the shipment. |
expected.item_group_configurations Required | array<ItemGroupConfiguration> | [...] | (required) An array of item group configurations that you are receiving in the shipment. If you pass the item group configurations, the passed item quantity will be ignored and the quantity will be calculated based on the item group configurations. |
expected.item_group_configurations.*.configuration_id Required | integer | 12 | (required) The configuration ID for the item group configuration. |
expected.item_group_configurations.*.quantity Required | integer | 5 | (required) The number of item groups that you are receiving in the shipment. |
expected.item_group_configurations.*.partial_quantity Required | integer | 1 | (required) The extra items not included in a full item group. |
actual Required | array<ActualItem> | [...] | (required) An array of actual items that you are receiving in the shipment. |
actual.quantity Required | integer | 50 | (required) The quantity of the item that you have received in the shipment. |
actual.item_group_configurations Required | array<ItemGroupConfiguration> | [...] | (required) An array of item group configurations that you have received in the shipment. |
actual.item_group_configurations.*.configuration_id Required | integer | 12 | (required) The configuration ID for the item group configuration. |
actual.item_group_configurations.*.quantity Required | integer | 5 | (required) The number of item groups that you have received in the shipment. |
actual.item_group_configurations.*.partial_quantity Required | integer | 1 | (required) The extra items not included in a full item group. |
Example Response
Remove
Remove an item from an inbound shipment.
POST
/shipments/inbound/{SHIPMENT_ID}/remove-item| Parameter | Type | Examples | Description |
|---|---|---|---|
item_id Required | integer | 12 | (required) The ID of the item that you are updating |