Inbound Shipment Items
List items for an inbound shipment
Get the list of items (expected, actual, and unsellable) for an inbound shipment.
GET
/shipments/inbound/{inbound_shipment}/items| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
item_ids Optional | array<integer> | | Filter to a specific list of item IDs |
Example Response
Add an item to an inbound shipment
Add an inventory item with a specified quantity to an inbound shipment.
POST
/shipments/inbound/{inbound_shipment}/add-item| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
item_id Required | integer | 42 | The ID of the inventory item to add |
quantity Required | integer | 10 | The expected quantity of the item |
Example Response
Update an item on an inbound shipment
Update the expected and actual quantities for an item on an inbound shipment.
POST
/shipments/inbound/{inbound_shipment}/update-item| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
item_id Required | integer | 42 | The ID of the inventory item to update |
expected Required | object | | Expected quantity update |
expected.quantity Required | integer | 10 | The new expected quantity |
expected.item_group_configurations Optional | array<ItemGroupConfiguration> | | Group configuration summaries |
expected.item_group_configurations.*.configuration_id Optional | integer | | |
expected.item_group_configurations.*.quantity Optional | integer | | |
expected.item_group_configurations.*.partial_quantity Optional | integer | | |
actual Optional | object | | Actual quantity update (only available to service provider staff) |
actual.quantity Required | integer | 8 | The new actual received quantity |
actual.item_group_configurations Optional | array<ItemGroupConfiguration> | | Group configuration summaries |
actual.item_group_configurations.*.configuration_id Optional | integer | | |
actual.item_group_configurations.*.quantity Optional | integer | | |
actual.item_group_configurations.*.partial_quantity Optional | integer | | |
actual.moves Optional | array<Move> | | Stock move data |
Example Response
Remove an item from an inbound shipment
Remove an inventory item from an inbound shipment.
POST
/shipments/inbound/{inbound_shipment}/remove-item| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
item_id Required | integer | 42 | The ID of the inventory item to remove |