MasonHub ERP Integration home pagelight logo
  1. Inbound Shipments/ASN
  2. Get Inbound Shipments
GET
/inbound_shipments
curl --request GET \
     --url https://sandbox.masonhub.co/dragonfly-cosmetics-demo/api/v1/inbound_shipments \
     --header 'Authorization: Bearer <token>'

The Inbound Shipments API, also known as ASN (Advance Ship Notice), manages incoming inventory shipments to MasonHub distribution centers. This endpoint allows you to retrieve inbound shipment information with powerful filtering capabilities.

Inbound shipments automatically update expected inventory totals and trigger skuInventoryChange callbacks when created.

​
Query Parameters

id
UUID[]

MasonHub UUID strings. Supports batching 1-30 IDs per request.

cid
string[]

Customer identifiers. Supports batching 1-30 identifiers per request.

cpid
string[]

Customer purchase order IDs for filtering shipments.

status
string

Filter by shipment status. Options:

  • open - Shipment created, awaiting arrival
  • onDock - Shipment has arrived at facility
  • receivingStarted - Receiving process has begun
  • receivingComplete - All items have been received
sdt
string

Start date/time filter in RFC3339 format (e.g., 2018-12-01T00:00:00Z).

edt
string

End date/time filter in RFC3339 format (e.g., 2018-12-31T23:59:59Z).

offset
default:0
integer

Pagination offset for retrieving subsequent pages of results.

limit
default:30
integer

Number of results to return. Range: 1-100.

list_type
default:detail
string

Response detail level. Options:

  • detail - Full shipment information including all fields
  • summary - Condensed view with essential fields only
curl -X GET "https://app.masonhub.co/{account}/api/v1/inbound_shipments?status=open&sdt=2018-12-01T00:00:00Z&limit=25" \
  -H "Authorization: Bearer your_jwt_token"

{
  "limit": 25,
  "offset": 0,
  "list_type": "detail",
  "data": [
    {
      "id": "bf7bb516-ce52-8950-2a8b-9008f0091d93",
      "customer_identifier": "shipment32432",
      "customer_purchase_order_id": "po234532",
      "inventory_location_id": "bf7bb516-ce52-8950-2a8b-9008f0091d93",
      "status": "open",
      "expected_arrival_date": "2018-12-11T10:00:00Z",
      "shipper_name": "Freddie's Pirate Army",
      "tracking_number": "356732154",
      "shipper_city": "Kalamazoo",
      "shipper_locale": "MI",
      "shipper_country": "US",
      "carrier_information": {
        "name": "Frankie's Red Hot Carrier",
        "type": "TL",
        "contact_name": "John Jacob",
        "driver_name": "Donny James Jr",
        "driver_phone": "555-343-4213"
      },
      "special_instructions": "Fold using provided template during put away",
      "comments": "Shipments often not labeled but carrier is reliable",
      "line_items": [
        {
          "customer_sku_id": "10000",
          "quantity": 80
        },
        {
          "customer_sku_id": "10001",
          "quantity": 20
        }
      ],
      "created_at": "2018-12-01T08:30:00Z",
      "updated_at": "2018-12-01T08:30:00Z"
    }
  ]
}

​
Shipment Status Lifecycle

Understanding the status progression helps you track shipments effectively:

1

Open

Shipment created, awaiting arrival at the facility

2

On Dock

Shipment has arrived at the facility and is awaiting processing

3

Receiving Started

The receiving process has begun - items are being processed

4

Receiving Complete

All items have been received and processed into inventory

​
Batch Queries

You can query multiple shipments in a single request using arrays:

# Query by multiple customer identifiers
GET /inbound_shipments?cid=shipment001&cid=shipment002&cid=shipment003

# Query by date range and status
GET /inbound_shipments?status=open&sdt=2018-12-01T00:00:00Z&edt=2018-12-31T23:59:59Z

Maximum 30 identifiers per batch request for id, cid, or cpid parameters. Exceeding this limit will result in a 400 error.

​
Performance Tips

Use Date Ranges

Filter by sdt and edt to narrow down results instead of retrieving all shipments.

Filter by Status

Use the status parameter to retrieve only shipments in specific states.

Summary Lists

Use list_type=summary when you only need basic shipment information.

Appropriate Limits

Use reasonable limit values to avoid timeouts on large datasets.