Outbound Shipment Items

Index

Get a list of the items on an outbound shipment.

GET /shipments/outbound/{SHIPMENT_ID}/outbound-shipment-item

Example Response

{
    "items": [
        {
            "id": 1387,
            "created_at": "2024-04-08T10:30:57.000000Z",
            "updated_at": "2024-04-08T10:30:57.000000Z",
            "shipment_id": 1455,
            "item_id": 3375,
            "quantity": 80,
            "case_quantity": null,
            "expiry_date": null,
            "cost_per_item": 17.93,
            "item": {
                "id": 3375,
                "created_at": "2024-04-08T10:30:57.000000Z",
                "updated_at": "2024-04-08T10:30:57.000000Z",
                "team_id": 1,
                "merchant_sku": "Mediocre-Ir-932762",
                "title": "Mediocre Iron Shoes",
                "condition": "new",
                "condition_note": null,
                "bundle_id": null,
                "length_mm": 165,
                "width_mm": 125,
                "height_mm": 115,
                "weight_gm": 1098,
                "quantity_in_stock": 0,
                "available_quantity": -80,
                "allocated_quantity": 80,
                "unavailable_quantity": 0,
                "inbound_quantity": 0,
                "fnsku": "X0008OG4VD",
                "asin": "B01MRL790Q",
                "searchableIdentifiers": "B01MRL790Q,X0008OG4VD",
                "prep_instructions": [],
                "images": [
                    {
                        "id": 3367,
                        "path": null,
                        "large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=3375",
                        "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": 3375,
                        "imageable_type": "item"
                    }
                ],
                "identifiers": [
                    {
                        "id": 6947,
                        "created_at": "2024-04-08T10:30:57.000000Z",
                        "updated_at": "2024-04-08T10:30:57.000000Z",
                        "item_id": 3375,
                        "identifier": "B01MRL790Q",
                        "identifier_type": "ASIN"
                    },
                    {
                        "id": 6948,
                        "created_at": "2024-04-08T10:30:57.000000Z",
                        "updated_at": "2024-04-08T10:30:57.000000Z",
                        "item_id": 3375,
                        "identifier": "X0008OG4VD",
                        "identifier_type": "FNSKU"
                    }
                ],
                "bundle": null,
                "listings": [],
                "item_group_configurations": [
                    {
                        "id": 3722,
                        "created_at": "2024-04-08T10:30:57.000000Z",
                        "updated_at": "2024-04-08T10:30:57.000000Z",
                        "item_id": 3375,
                        "quantity": 10,
                        "type": "box",
                        "weight_gm": 1270,
                        "length_mm": 170,
                        "width_mm": 130,
                        "height_mm": 450,
                        "contains": null,
                        "default": false
                    }
                ],
                "tags": []
            },
            "bundle": null,
            "item_group_configurations": [],
            "location_moves": [],
            "company_services": [
                {
                    "id": 474,
                    "created_at": "2024-04-08T10:30:57.000000Z",
                    "updated_at": "2024-04-08T10:30:57.000000Z",
                    "name": "Dietetic Technician SR2315",
                    "type": "outbound_shipment",
                    "unit": "box",
                    "when_to_charge": "attached",
                    "charge": "14.5600",
                    "advanced_options": [],
                    "company_id": 10,
                    "price_records": [],
                    "archived_at": null,
                    "pivot": {
                        "outbound_shipment_item_id": 1387,
                        "company_service_id": 474,
                        "created_at": "2024-04-08T10:30:57.000000Z",
                        "updated_at": "2024-04-08T10:30:57.000000Z"
                    }
                },
                {
                    "id": 475,
                    "created_at": "2024-04-08T10:30:57.000000Z",
                    "updated_at": "2024-04-08T10:30:57.000000Z",
                    "name": "Electromechanical Equipment Assembler SR4789",
                    "type": "outbound_shipment",
                    "unit": "bag",
                    "when_to_charge": "attached",
                    "charge": "2.3800",
                    "advanced_options": [],
                    "company_id": 10,
                    "price_records": [],
                    "archived_at": null,
                    "pivot": {
                        "outbound_shipment_item_id": 1387,
                        "company_service_id": 475,
                        "created_at": "2024-04-08T10:30:57.000000Z",
                        "updated_at": "2024-04-08T10:30:57.000000Z"
                    }
                }
            ],
            "always_company_services": [
                {
                    "id": 5,
                    "created_at": "2024-03-01T11:25:57.000000Z",
                    "updated_at": "2024-03-01T11:25:57.000000Z",
                    "name": "Base Per Outbound Shipment Item",
                    "type": "outbound_shipment_item",
                    "unit": "item",
                    "when_to_charge": "always",
                    "charge": "0.9900",
                    "advanced_options": null,
                    "company_id": 1,
                    "price_records": [],
                    "archived_at": null,
                    "laravel_through_key": 1455
                }
            ]
        }
    ]
}

Create

Add a new item to an outbound shipment.

POST /shipments/outbound/{SHIPMENT_ID}/outbound-shipment-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.
expiry_date date 2025-12-31 The expiry date of the item that you are sending in the shipment.

Example Response

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

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 integer 50 (required) The quantity of the item that you are sending in the shipment.
expiry_date date 2025-12-31 The expiry date of the item that you are sending in the shipment.
item_group_configurations array<ItemGroupConfiguration> [...] (required) An array of item group configurations that you are sending in the shipment.
item_group_configurations.*.configuration_id integer 12 (required) The configuration ID for the item group configuration.
item_group_configurations.*.quantity integer 5 (required) The number of item groups that you are sending in the shipment.
item_group_configurations.*.partial_quantity integer 1 (required) The extra items not included in a full item group.
location_moves array<LocationMoves> [...] (required) An array of location moves for the items that you are sending in the shipment. Please contact us if you need more details on this, otherwise pass in an empty array.

Example Response

{
    "message": "Item updated"
}

Delete

Remove an item from an outbound shipment.

DELETE /shipments/outbound/{SHIPMENT_ID}/outbound-shipment-item/{OUTBOUND_SHIPMENT_ITEM_ID}

Example Response

{
    "message": "Item deleted"
}