Shipments

Endpoints for retrieving your outbound shipments — orders being shipped out of your warehouse.

GET/api/v1/shipments

List shipments

Retrieve a paginated list of your shipments.

Query parameters

Name
offset
Type
integer
Description
Pagination offset. Defaults to 0.
Name
limit
Type
integer
Description
Maximum number of records to return. Defaults to 200.
Name
sort_key
Type
string
Description
Field to sort by. Defaults to created_at.
Name
sort_order
Type
string
Description
Sort direction: asc or desc. Defaults to desc.
Name
fulfillment_types
Type
array
Description
Filter by fulfillment type: fba, fbm, manual, wfs, shopify.
Name
statuses
Type
array
Description
Filter by shipment status: working, requested, picking, picked, shipped.
Name
shipment_id
Type
string
Description
Filter to a specific shipment by ID.

Request

GET

/api/v1/shipments

curl -G https://api.example.com/api/v1/shipments \
  -H "Authorization: ApiKey {your-api-key}" \
  -H "X-Warehouse-Id: {warehouse_id}" \
  -d limit=50 \
  -d offset=0

Response

{
  "status": "success",
  "message": "Fetched shipments.",
  "data": {
    "shipments": [
      {
        "shipment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "status": "shipped",
        "created_at": "2025-03-28T11:00:00Z",
        "shipped_at": "2025-03-30T14:30:00Z",
        "name": "FBA Shipment - March",
        "fulfillment_type": "fba",
        "stage": null,
        "notes": null,
        "shipping_method": "client",
        "shipping_address": {},
        "latest_ship_date": "2025-04-05T00:00:00Z",
        "total_quantity_shipped": 50,
        "trackings": [
          {
            "tracking_number": "1Z999AA10123456784",
            "carrier": "UPS",
            "tracking_status": "in_transit"
          }
        ],
        "tags": [
          { "tag": "urgent", "value": "true" }
        ],
        "full_name": "Client Name"
      }
    ],
    "results": {
      "offset": 0,
      "limit": 50,
      "total_results": 12
    }
  }
}

GET/api/v1/shipments/:shipment_id

Get a shipment

Retrieve the full details of a specific shipment, including its orders, boxes, services, and tracking information.

The response includes the same fields as the list endpoint, plus these additional detail fields:

Name
orders
Type
array
Description
Array of order items in the shipment. Each item includes order_id, item_name, quantity_shipped, asin, amazon_sku, sold_as, and units_per_pack.
Name
boxes
Type
array
Description
Array of boxes used in the shipment. Each box includes box_id, name, quantity, and price_per_unit.
Name
services
Type
array
Description
Array of services applied. Each service includes service_id, name, quantity, and price_per_unit.
Name
seller_central_linked
Type
boolean
Description
Whether the shipment is linked to Amazon Seller Central.
Name
wfs_linked
Type
boolean
Description
Whether the shipment is linked to Walmart WFS.
Name
unit_services_summary
Type
object
Description
Per-item service breakdown.
Name
trackings
Type
array
Description
Full tracking details including tracking_id, tracking_number, carrier, tracking_status, rate_id, and created_at.

Request

GET

/api/v1/shipments/:shipment_id

curl https://api.example.com/api/v1/shipments/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: ApiKey {your-api-key}" \
  -H "X-Warehouse-Id: {warehouse_id}"

Response

{
  "status": "success",
  "message": "Fetched shipment.",
  "data": {
    "shipment": {
      "shipment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "shipped",
      "created_at": "2025-03-28T11:00:00Z",
      "shipped_at": "2025-03-30T14:30:00Z",
      "name": "FBA Shipment - March",
      "fulfillment_type": "fba",
      "total_quantity_shipped": 50,
      "shipping_method": "client",
      "seller_central_linked": true,
      "wfs_linked": false,
      "orders": [
        {
          "order_id": "64c65048-...",
          "item_name": "Widget A",
          "quantity_shipped": 24,
          "asin": "B08N5WRWNW",
          "amazon_sku": "WA-BLU-M-FBA",
          "sold_as": "individual",
          "units_per_pack": 1
        }
      ],
      "boxes": [
        {
          "box_id": "box-001",
          "name": "Medium Box",
          "quantity": 2,
          "price_per_unit": 1.50
        }
      ],
      "services": [
        {
          "service_id": "svc-001",
          "name": "Poly Bag",
          "quantity": 24,
          "price_per_unit": 0.50
        }
      ],
      "trackings": [
        {
          "tracking_id": "trk-001",
          "tracking_number": "1Z999AA10123456784",
          "carrier": "UPS",
          "tracking_status": "in_transit",
          "rate_id": "rate-001",
          "created_at": "2025-03-30T14:30:00Z"
        }
      ],
      "unit_services_summary": {},
      "tags": [],
      "full_name": "Client Name"
    }
  }
}