Inbound Shipment Items

Index

Get a list of the items on an inbound shipment.

GET /shipments/inbound/{SHIPMENT_ID}/items

Example Response

{
    "items": [
        {
            "id": 1,
            "item_id": 1,
            "shipment_id": 629,
            "expected": {
                "quantity": 10,
                "item_group_configurations": [],
                "id": 1072
            },
            "actual": {
                "quantity": 10,
                "item_group_configurations": [],
                "location_moves": [],
                "id": 830
            },
            "unsellable": {
                "quantity": 0
            },
            "item": {
                "id": 1,
                "created_at": "2024-03-01T11:25:57.000000Z",
                "updated_at": "2024-03-01T11:25:57.000000Z",
                "team_id": 1,
                "merchant_sku": "Silicone-223984",
                "title": "1 - Silicone Baking Mats",
                "condition": "new",
                "condition_note": null,
                "bundle_id": null,
                "length_mm": 127,
                "width_mm": 50,
                "height_mm": 81,
                "weight_gm": 1570,
                "fnsku": "X00RKD6OEZ",
                "asin": "B03Z7PEHQ4",
                "searchableIdentifiers": "8743265185191,B03Z7PEHQ4,X00RKD6OEZ",
                "prep_instructions": [],
                "images": [
                    {
                        "id": 1,
                        "path": null,
                        "large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=1",
                        "thumbnail_url": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAjVBMVEX\/\/\/8jHyAAAAAWEBJ7eXkTDA4QCAvp6OiLiYogHB0cFxgdGBkeGhsYExQJAADx8fHAv78MAAX5+fmTkZK\/vr7Hxsb09PRIRUbNzMxBPj9samva2dm4t7eYlpdPTE12dHXU1NRbWVlkYmIsKCmdnJw3NDXi4uKvrq4zMDGGhIVNSkqnpqZfXV1VU1NFQkOurYy8AAAJQUlEQVR4nO2da3uqOhCFJVRaBKF4r5ZqrbX3\/f9\/3ol6rBdmYTKCYJ9ZX7ey83bW5EYyNhoikUgkEolEIpFIJBKJRCKRSCQSiUSEOrPRrFN1I8rU4l0p9b6ouhllabBIIt9xHD+JFoOqG1OCBgtnzbeSH\/npX2PsLN5\/+TaML38rjgs\/2edbMyZB+lf6nMGiHR3zbeLYXMRVN64ADb5eSL4No3P1jJ0U8\/2fj1ft1c7Cy+RfhtFLrrZfHSzC3Pjt+px2eo1eHSxof7bpfLw+xtSh+HxPTZVH\/UPid6tuso0Gi4jKP98L7+LGoJsdHDfwVxPH\/fnZYZjuNghxF3wguApGkH++F3Vvfz8UpwnpVT121L1f7aQubcHm3WHTO12XZPSa3TozxgsX+LObtd8AdEaJR3y4Horp\/HOS1p4\/D76Q6mGCYgxrmY9gfqa7yJyQxCkYO5zaeTVOwfgQ3OU3tQPHjlp5ddCFw\/jpZsYoH93aMA7Sl4RIJ0d3i3T+HStO22QctVfrwNhJkc3uzJuHTOAFleej7ipoPt+yaYOuU8d8jNOAXP\/5r4xmgbmc41WXjwPQJMcJhzPOA3WHjMaOKhgH9NTyf0T1M+M8tNNt0\/kYXTwf47SZvz\/RUs8jzoPRXM5LLhpHPYSd3H9x2uqbxRinITX4rPrVSzF26G6PYIx+mIxg7PBPTJCKEfrv3RbB2FJPLEbwR7zE2BF326SFEufjR9GM3DiCscOzmEgw\/lv0p\/VW87P7TxUSbWqr5z7rP0vBGtkvjXGAluXRNj3uH8g4ttUnr1\/tevR\/6JaSj3HXZDjuPwGv8vIRTCpWk16zSb254m6L7D+T8Dj171E+cr0K8tF04WImu2lx\/5P2avTEZIRjR1H5iPzptVA6QK8OmWNHQDfAZoGGFXebjPV7n\/ZqoHhxxHO5s\/Nx+eGT82u4f\/ar\/jMaH5lebdFzudbHkvO8rZA\/lclUfzREXuXFEewDNKMz3ul0FRgfDF\/bjn4U9TItUA8sRjSXU2zEJfE8s\/2zX42eASOzXyXHRz\/hGjXNOt9LbLejRygfn+45bVrN5TIPS1LOo7TGmT+\/zzlWALzaUv94Xk0zj2qPOQ9qkIQfrM559A28OmTE8fajOMKpm3lWM7pheX40R\/loybj88JqZx7hTTpu0brKEmtGdsuI4o\/ucllUcb2+aTaI3dW84LWoAQr2aV1NWHGfIqw+GjMupovgKJ1w9kcs4jyjGUA17p7+8vFGwPYUTaq960wnnkTOUj5+P+V+cTIn8K5NQPzUas+I4QfmY59XlNMF8ZRGuNifGrDhO5hH14FC9Aq8ux9CfxRHSK3wu44xuckDm42RKfthPdlOlAgjdjzf6FKybMOM4RnOAx+MPkvnnR97bx6555xM27xqdr5eI3iycM70K4rjvVeDP1cnbTuPuF70YQq2vd7AhymQcJzTjQ2\/7ATLQfvTytZoel0Co4\/hOrRhX+ThjMU5JhHDtVZCsvnr52iy\/yyBcMQY0Y\/TNiuOSDpOey8092p\/u13Z5Uw5hI8erzzMeI+1ValEZan\/uvlkaoY7jK\/DqnMU4mZKM2fip16\/95Wl5hJrx7QUxsjZEwZB3xOe8HS6\/yyTU0oyFevUEYxg5X8ffKZlQM76qgGgL9wX+cupRj9vwqfe37DdKJ9SMD6RXW8wX+Msh5Yp1\/r1R20MXIGw0HoFXOS\/wZ98gfsf5t9VFCDXjK8lo\/cJwhjaPKX9udCHCtVdpRos4gk1VvaCCfBckbHQeUT4avoTp04tilH9bXY6wAfPRyKtgwziMVGZ8ONRFCTXjAxg7Tmxsj+gXxkGuPze6MKFmHJKMQZ5XwUvGUP07yVcBYaPRQ3EEG9t94E\/1fmLjbaMKCHMY\/2UZwYEG3X8a8VVEqBn\/gbw62izs0y+I9ecM+Soj1Iz04a9APe02YMChG51\/xnwVEq4Pf+V6FfvTYHN\/pwoJNSPyqmYAh99avxtQpqqUUHuVPjQUKh\/MDT4t+SonXB+MorxKze94L4MrJ9SMtFezfKYvEA9VA0J4wG1f3ANENSGE48KO78k6\/7aqCWFuHAN2\/FaqDaFeP8DDmGfw1YpwNcfOvMBvMQ9+7VQrwvWhof045q6pDFUzwtVafofY+jybr4aEjXh35M4r4vRy\/Qhv9wiLOGcvhAYSQksJoa2E0EBCaCkhtJUQGkgILSWEthJCAwmhpYTQVkJoICG0lBDaSggNJISWEkJbCaGBhNBSQmgrITSQEFqq1oQO8+L2gYolXI53tcALucvdVrwL+HsqkvDwLlhBt9Xd5Mw4Fke4PCo\/UNh9fFedxVgUYfb6M5swW2PoLK8WQ7gk7g4n3N+qmxB1\/d2IdwG\/UQzhZEzVY4jYf\/apyj6NXRCjAEJwZ1hxC\/BozUG1zjmH8VxCcO87UHPGw371OASXYRn5eB4huLsfWB3vJwUuiTDy8RzC5Zi8nm9+\/SRXPfrCbzuyLBbBJ1yS\/Yvx9SEDPdIHti0LYnAJYf6ZX68x0COqgmxREINHCO7q212vMVKPvgzrmnuVQ0iPf6urKUXzrQQrPRsy2hMa1bApVNqrZJ9j5lVbwtzaLqWpR18UdU0Y7QiBP8Ni+xdK\/LHDhhCMD0Fx40OeYD6eKMJjTrik69bZX29jq0df2jqRj6aEM3r8C0\/W5StU93Q+aq\/O4HfMCEG9uuBy8duqb+1VE8IJqqt4cb6VeqC6PCqmdJoQlC9rlTs+5Oke5SPJeIoQ5F\/AuF5aoMClZnKek08Ix7\/S5i+mAhdFiYJReYQg\/\/Jrfl5M4BJlxquYEPqTf\/2yYPXRfPV7tvcpRDhD4wNRaqI6Qa\/uMdKEE7q2MPf6c4lCv0yyy0eKcELXhyZLhVQvnI+bQkNZwvrn37H6YC638eoxIfBnWM\/4bQWKsqy9ekgI\/Vm7\/DsW9mpvF9\/WPZqf1daf++r\/0F7df5OVFPM7ApUJ5GO+uL\/NUpFGw8ik6MdO55YfqEDgF58Q38+1+HNfBoVNtv4s4np+JQK\/+HQcv6vKv2MRBTGO+a6m\/0QChQO3\/jy\/PEYNBIq3nFueplbSjFmvXuH4kKeMV690fMjTaH985P7uWs012u51hMzfI7sCjR6U226qB1a57ytR\/2Z881fjJxKJRCKRSCQSiUQikUgkEolEIpHoTP0HQMK6qG8e9HsAAAAASUVORK5CYII=",
                        "imageable_id": 1,
                        "imageable_type": "item"
                    }
                ],
                "identifiers": [
                    {
                        "id": 1,
                        "created_at": "2024-03-01T11:25:57.000000Z",
                        "updated_at": "2024-03-01T11:25:57.000000Z",
                        "item_id": 1,
                        "identifier": "8743265185191",
                        "identifier_type": "EAN"
                    },
                    {
                        "id": 2,
                        "created_at": "2024-03-01T11:25:57.000000Z",
                        "updated_at": "2024-03-01T11:25:57.000000Z",
                        "item_id": 1,
                        "identifier": "B03Z7PEHQ4",
                        "identifier_type": "ASIN"
                    },
                    {
                        "id": 3,
                        "created_at": "2024-03-01T11:25:57.000000Z",
                        "updated_at": "2024-03-01T11:25:57.000000Z",
                        "item_id": 1,
                        "identifier": "X00RKD6OEZ",
                        "identifier_type": "FNSKU"
                    }
                ],
                "company_services": [],
                "listings": [
                    {
                        "id": 1,
                        "created_at": "2024-03-01T11:25:57.000000Z",
                        "updated_at": "2024-03-01T11:25:57.000000Z",
                        "channel_id": 1,
                        "channel_identifier": "Silicone-223984",
                        "item_id": 1,
                        "status": "synced",
                        "channel_data": []
                    }
                ],
                "bundle": null,
                "item_group_configurations": [
                    {
                        "id": 1,
                        "created_at": "2024-03-01T11:25:57.000000Z",
                        "updated_at": "2024-03-01T11:25:57.000000Z",
                        "item_id": 1,
                        "quantity": 6,
                        "type": "box",
                        "weight_gm": 500,
                        "length_mm": 1720,
                        "width_mm": 2560,
                        "height_mm": 2880,
                        "contains": null,
                        "default": false
                    }
                ]
            }
        }
    ]
}

Add

Add a new item to an inbound shipment.

POST /shipments/inbound/{SHIPMENT_ID}/add-item
Parameter Type Examples Description
item_id integer 12 (required) The ID of the item that you are sending in the shipment.
quantity integer 50 (required) The quantity of the item that you are sending in the shipment.

Example Response

{
    "message": "Item added to shipment"
}

Update

Modify an item on an inbound shipment.

POST /shipments/inbound/{SHIPMENT_ID}/update-item
Parameter Type Examples Description
item_id integer 12 (required) The ID of the item that you are updating
expected array<ExpectedItem> [...] (required) An array of expected items that you are receiving in the shipment.
expected.quantity integer 50 (required) The quantity of the item that you are receiving in the shipment.
expected.item_group_configurations 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 integer 12 (required) The configuration ID for the item group configuration.
expected.item_group_configurations.*.quantity integer 5 (required) The number of item groups that you are receiving in the shipment.
expected.item_group_configurations.*.partial_quantity integer 1 (required) The extra items not included in a full item group.
expected.location_moves array<LocationMoves> [...] (required) An array of location moves for the items that you are receiving in the shipment. Please contact us if you need more details on this, otherwise pass in an empty array.
actual array<ActualItem> [...] (required) An array of actual items that you are receiving in the shipment.
actual.quantity integer 50 (required) The quantity of the item that you have received in the shipment.
actual.item_group_configurations array<ItemGroupConfiguration> [...] (required) An array of item group configurations that you have received in the shipment.
actual.item_group_configurations.*.configuration_id integer 12 (required) The configuration ID for the item group configuration.
actual.item_group_configurations.*.quantity integer 5 (required) The number of item groups that you have received in the shipment.
actual.item_group_configurations.*.partial_quantity integer 1 (required) The extra items not included in a full item group.
actual.location_moves array<LocationMoves> [...] (required) An array of location moves for the items that you have received in the shipment. Please contact us if you need more details on this, otherwise pass in an empty array.

Example Response

{
    "message": "Item updated"
}

Remove

Remove an item from an inbound shipment.

POST /shipments/inbound/{SHIPMENT_ID}/remove-item
Parameter Type Examples Description
item_id integer 12 (required) The ID of the item that you are updating

Example Response

{
    "message": "Item removed from shipment"
}