Inbound Shipments

Index

Get a list of all inbound shipments, using Pagination.

GET /shipments/inbound

Example Response

{
    "current_page": 1,
    "data": [
        {
            "id": 39,
            "created_at": "2022-03-26T10:23:55.000000Z",
            "updated_at": "2022-03-28T12:52:00.000000Z",
            "team_id": 2,
            "name": "Crooks, Reilly and Predovic",
            "notes": "Ipsam et quaerat voluptates iure quae. Dolorum quasi ipsum saepe est sunt exercitationem et. Maiores eum ea officia quas. Autem dolores non delectus.",
            "status": "shipped",
            "warehouse_id": 1,
            "received_at": null,
            "internal_notes": null,
            "archived_at": null,
            "expected_quantity": 680,
            "sku_count": 7,
            "actual_quantity": 0,
            "unsellable_quantity": 4,
            "received_quantity": 4,
            "reference_id": "INSH-032622-39",
            "searchable_identifiers": "B01N1KM25E,X00FK2YTUF,0751765057210"
        }
    ],
    "first_page_url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
    "path": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 30
}

Index (Archived Shipments)

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

GET /shipments/inbound/archived

Example Response

{
    "current_page": 1,
    "data": [
        {
            "id": 39,
            "created_at": "2022-03-26T10:23:55.000000Z",
            "updated_at": "2022-03-28T12:52:00.000000Z",
            "team_id": 2,
            "name": "Crooks, Reilly and Predovic",
            "notes": "Ipsam et quaerat voluptates iure quae. Dolorum quasi ipsum saepe est sunt exercitationem et. Maiores eum ea officia quas. Autem dolores non delectus.",
            "status": "shipped",
            "warehouse_id": 1,
            "received_at": null,
            "internal_notes": null,
            "archived_at": null,
            "expected_quantity": 680,
            "sku_count": 7,
            "actual_quantity": 0,
            "unsellable_quantity": 4,
            "received_quantity": 4,
            "reference_id": "INSH-032622-39",
            "searchable_identifiers": "B01N1KM25E,X00FK2YTUF,0751765057210"
        }
    ],
    "first_page_url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound?page=2",
    "path": "http:\/\/dashboard.domain.com\/api\/shipments\/inbound",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 30
}

Show

Retrieve a specific shipment

GET /shipments/inbound/{SHIPMENT_ID}

Example Response

{
    "shipment": {
        "id": 19,
        "created_at": "2024-01-26T14:51:01.000000Z",
        "updated_at": "2024-01-29T07:18:52.000000Z",
        "team_id": 1,
        "name": "Binary Burst 12",
        "notes": "Validate shipment contents against packing list to ensure accuracy.",
        "warehouse_id": 1,
        "received_at": null,
        "internal_notes": null,
        "archived_at": null,
        "shipped_at": "2024-01-26T14:51:01.000000Z",
        "checked_in_at": null,
        "deleted_at": null,
        "currency": "USD",
        "eta": "2024-01-23 09:51:01",
        "expected_quantity": 310,
        "sku_count": 5,
        "shipment_id": null,
        "actual_quantity": 0,
        "unsellable_quantity": 0,
        "received_quantity": 0,
        "reference_id": "INSH-012624-19",
        "status": "shipped",
        "tracking_numbers": [
            {
                "status": "unknown",
                "number": "4D6BRJR59XI1Y1771X0M",
                "carrier": "shippo",
                "service_level": null,
                "eta": null,
                "transit_at": null,
                "delivered_at": null,
                "returned_at": null,
                "failed_at": null,
                "package_identifier": null,
                "tracking_url": "https:\/\/t.17track.net\/en#nums=4D6BRJR59XI1Y1771X0M",
                "id": 43
            }
        ],
        "attachments": [],
        "service_lines": [],
        "warehouse": {
            "id": 1,
            "name": "NY Warehouse",
            "service_provider_id": 1,
            "default_address_id": 1,
            "deletable": false,
            "default_address": {
                "id": 1,
                "created_at": "2024-01-23T14:50:59.000000Z",
                "updated_at": "2024-01-23T14:50:59.000000Z",
                "addressable_type": "warehouse",
                "addressable_id": 1,
                "address_line_1": "1000 State Route 36",
                "address_line_2": "Suite 370",
                "address_line_3": null,
                "city": "Hornell",
                "state_province": "NY",
                "country_code": "US",
                "postal_code": "14843-2651",
                "phone_number": null,
                "is_residential": false
            }
        },
        "tags": []
    }
}

Create

Create a new inbound shipment

POST /shipments/inbound
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"
}

Update

Update a shipment name and notes

PUT /shipments/inbound/{SHIPMENT_ID}
Parameter Type Examples Description
notes string Inventore iusto facilis aperiam modi est. Shipment notes
internal_notes string Inventore iusto facilis aperiam modi est. Warehouse / staff notes
name string Walmart Oct 26 The name of the shipment

Example Response

{
    "message": "Shipment updates saved",
    "shipment": {
        "id": 46,
        "created_at": "2021-10-19T07:48:05.000000Z",
        "updated_at": "2021-10-26T17:29:18.000000Z",
        "team_id": 2,
        "name": "Lindgren-Cormier",
        "notes": "Inventore iusto facilis aperiam modi est. Aut id quasi numquam consectetur. Explicabo et officia minus consequatur quia sapiente doloribus. a",
        "status": "shipped",
        "warehouse_id": 1,
        "received_at": null,
        "internal_notes": null
    }
}

Submit

Add tracking numbers to a shipment and change the status to shipped

POST /shipments/inbound/{SHIPMENT_ID}/submit
Parameter Type Examples Description
tracking_numbers array<string> [9405500205903080427328] An array of alphanumeric strings. Required unless carrier is set to no_tracking
carrier string usps Valid values: canada_post, dhl_express, fedex, usps,ups,shippo,no_tracking,other

Example Response

{
    "message": "Shipment submitted"
}

Receive

Change the status of the shipment to received. No parameters are required.

POST /shipments/inbound/{SHIPMENT_ID}/receive

Example Response

{
    "message": "Shipment received"
}

Batch Archive

Archive one or more shipments.

POST /shipments/inbound/batch/archive
Parameter Type Examples Description
shipment_ids array See shipment_ids.* parameters An array of shipment IDS
shipment_ids.* int 21 The ID of the shipment

Example Response

{
    "message": "Shipments archived"
}