Outbound Shipments

Index

Get a list of all outbound shipments, using Pagination.

GET /shipments/outbound

Example Response

{
    "current_page": 1,
    "data": [
        {
            "id": 5657,
            "created_at": "2024-07-24T11:09:48.000000Z",
            "updated_at": "2024-07-24T11:13:07.000000Z",
            "team_id": 1,
            "status": "open",
            "notes": null,
            "name": "Test Plans",
            "warehouse_id": 1,
            "shipped_at": null,
            "internal_notes": null,
            "ship_from_address_id": 1,
            "archived_at": null,
            "currency": "USD",
            "is_case_forwarding": false,
            "sku_count": 1,
            "shipped_items_count": 5,
            "searchable_identifiers": "B00LIRROR6,X00N2VJGHH,Incredibl-746543,Incredible Granite Chair,FBANT8XDAU9CX",
            "searchable_tags": [],
            "tags": [],
            "fba_transport_plans": [
                {
                    "outbound_shipment_id": 5657,
                    "fba_shipment_id": "FBANT8XDAU9CX",
                    "fba_shipment_name": "Test Plans - Split 1",
                    "fba_transport_v0_plan_id": "6d174247-330a-4a55-aaa6-903e3c404026",
                    "transport_status": "estimated"
                }
            ]
        }
    ],
    "first_page_url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
    "path": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 22
}

Index (Archived Shipments)

Get a list of all archived outbound shipments, using Pagination.

GET /shipments/outbound/archived

Example Response

{
    "current_page": 1,
    "data": [
        {
            "id": 5657,
            "created_at": "2024-07-24T11:09:48.000000Z",
            "updated_at": "2024-07-24T11:13:07.000000Z",
            "team_id": 1,
            "status": "open",
            "notes": null,
            "name": "Test Plans",
            "warehouse_id": 1,
            "shipped_at": null,
            "internal_notes": null,
            "ship_from_address_id": 1,
            "archived_at": null,
            "currency": "USD",
            "is_case_forwarding": false,
            "sku_count": 1,
            "shipped_items_count": 5,
            "searchable_identifiers": "B00LIRROR6,X00N2VJGHH,Incredibl-746543,Incredible Granite Chair,FBANT8XDAU9CX",
            "searchable_tags": [],
            "tags": [],
            "fba_transport_plans": [
                {
                    "outbound_shipment_id": 5657,
                    "fba_shipment_id": "FBANT8XDAU9CX",
                    "fba_shipment_name": "Test Plans - Split 1",
                    "fba_transport_v0_plan_id": "6d174247-330a-4a55-aaa6-903e3c404026",
                    "transport_status": "estimated"
                }
            ]
        }
    ],
    "first_page_url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound?page=2",
    "path": "http:\/\/demo.prepbusiness.com\/api\/shipments\/outbound",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 22
}

Show

Retrieve a specific shipment

GET /shipments/outbound/{SHIPMENT_ID}

Example Response

{
    "shipment": {
        "id": 6,
        "created_at": "2024-07-23T06:51:11.000000Z",
        "updated_at": "2024-06-04T12:45:12.000000Z",
        "team_id": 1,
        "status": "closed",
        "notes": null,
        "name": "Triton Tech",
        "warehouse_id": 1,
        "shipped_at": "2024-07-23T06:51:11.000000Z",
        "internal_notes": null,
        "errors": null,
        "ship_from_address_id": null,
        "archived_at": null,
        "currency": "USD",
        "is_case_forwarding": false,
        "is_case_packed": true,
        "outbound_items": [
            {
                "id": 14,
                "created_at": "2024-06-04T06:51:14.000000Z",
                "updated_at": "2024-06-04T06:51:14.000000Z",
                "shipment_id": 6,
                "item_id": 21,
                "quantity": 20,
                "case_quantity": null,
                "expiry_date": null,
                "item": {
                    "id": 21,
                    "created_at": "2024-06-04T06:51:10.000000Z",
                    "updated_at": "2024-06-04T06:51:10.000000Z",
                    "team_id": 1,
                    "merchant_sku": "Crystal-W-283235",
                    "title": "Crystal Wine Decanter",
                    "condition": "new",
                    "condition_note": null,
                    "bundle_id": null,
                    "length_mm": 261,
                    "width_mm": 86,
                    "height_mm": 132,
                    "weight_gm": 709,
                    "fnsku": "X007V73BAF",
                    "asin": "B04Z6GUVL5",
                    "searchableIdentifiers": "6190392150205,B04Z6GUVL5,X007V73BAF",
                    "images": [
                        {
                            "id": 21,
                            "path": null,
                            "large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=21",
                            "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": 21,
                            "imageable_type": "item"
                        }
                    ],
                    "identifiers": [
                        {
                            "id": 61,
                            "created_at": "2024-06-04T06:51:10.000000Z",
                            "updated_at": "2024-06-04T06:51:10.000000Z",
                            "item_id": 21,
                            "identifier": "6190392150205",
                            "identifier_type": "EAN"
                        },
                        {
                            "id": 62,
                            "created_at": "2024-06-04T06:51:10.000000Z",
                            "updated_at": "2024-06-04T06:51:10.000000Z",
                            "item_id": 21,
                            "identifier": "B04Z6GUVL5",
                            "identifier_type": "ASIN"
                        },
                        {
                            "id": 63,
                            "created_at": "2024-06-04T06:51:10.000000Z",
                            "updated_at": "2024-06-04T06:51:10.000000Z",
                            "item_id": 21,
                            "identifier": "X007V73BAF",
                            "identifier_type": "FNSKU"
                        }
                    ]
                }
            }
        ],
        "service_lines": [],
        "attachments": [],
        "tags": []
    }
}

Create

Create a new outbound shipment

POST /shipments/outbound
Parameter Type Examples Description
notes string Inventore iusto facilis aperiam modi est. Shipment notes
name string Walmart Oct 26 The name of the shipment
warehouse_id integer 12 The ID of the warehouse that you are sending the shipment from.

Example Response

{
    "message": "Shipment Created",
    "shipment_id": "22"
}

Attachments

Attach a document to an Outbound Shipment

The Content-Type header must be set to multipart/form-data

POST /shipments/outbound/{OUTBOUND_SHIPMENT_ID}/attachment
Parameter Type Examples Description
file binary Manifest.xml The contents of the file
name string Manifest The name of the file

Example Response

{
    "message": "Attachments have been uploaded to this shipment.",
    "attachments": [
        {
            "path": "attachments\/EZDXv1TmvIOkBKjysyDSiM8keDjs16yP5dYp661c1D6MUSCqSyib0LEydAzWirell2ZauIlBo3AG877UUYGZpcOiKp4cUW7wz9tzvFW13swQLPebryR4Lyxe.png",
            "name": "Manifest.xml",
            "url": "http:\/\/localhost:3001\/storage\/attachments\/EZDXv1TmvIOkBKjysyDSiM8keDjs16yP5dYp661c1D6MUSCqSyib0LEydAzWirell2ZauIlBo3AG877UUYGZpcOiKp4cUW7wz9tzvFW13swQLPebryR4Lyxe.png",
            "attachable_id": 15,
            "attachable_type": "outbound-shipment",
            "updated_at": "2024-05-29T12:39:06.000000Z",
            "created_at": "2024-05-29T12:39:06.000000Z",
            "id": 1
        }
    ]
}