GET
/
v1
/
shipping
/
shipments
List all Shipments
curl --request GET \
  --url https://{client_id}.shipstream.app/api/global/v1/shipping/shipments
{
  "collection": [
    {
      "type": "Shipment",
      "id": 3,
      "unique_id": "1100000003",
      "external_id": "<string>",
      "status": "new",
      "shipping_carrier_code": "fedex",
      "shipping_method": "<string>",
      "shipping_method_name": "<string>",
      "shipping_service_code": "<string>",
      "shipping_service_name": "fedex_FEDEX_2_DAY",
      "warehouse": {
        "type": "Warehouse",
        "id": 123
      },
      "order": {
        "type": "Order",
        "id": 123
      },
      "shipping_account": {
        "type": "ShippingAccount",
        "id": 4
      },
      "target_ship_date": "2023-12-25",
      "item_weight": {
        "value": 20,
        "unit": "lb"
      },
      "shipped_weight": {
        "value": 20,
        "unit": "lb"
      },
      "items": [
        {
          "type": "ShipmentItem",
          "id": 123,
          "product": {
            "type": "Product",
            "id": 3
          }
        }
      ],
      "packages": [
        {
          "items": [
            {
              "sku": "KDS2108",
              "quantity": 2,
              "order_item_id": 4,
              "order_item_sku": "KDS2108",
              "order_item_qty": 2,
              "shipment_item_id": 4,
              "weight": {
                "value": 20,
                "unit": "lb"
              },
              "hazmat_unit_weight": {
                "value": 20,
                "unit": "lb"
              },
              "total_customs_value": {
                "amount": 99,
                "currency": "USD"
              }
            }
          ],
          "packaging": [
            {
              "product": {
                "type": "Product",
                "id": 3
              },
              "quantity": 4
            }
          ],
          "collected_data": [
            {
              "order_item_id": 4,
              "label": "<string>",
              "value": "<string>"
            }
          ],
          "created_at": "2017-07-21T17:32:28Z",
          "updated_at": "2017-07-21T17:39:43Z"
        }
      ],
      "packing_solution": {
        "type": "ShipmentPackingSolution",
        "id": 3,
        "containers": [
          {
            "type": "ShipmentPackingSolutionContainer",
            "weight": {
              "value": 20,
              "unit": "lb"
            },
            "dimensions": {
              "length": 8,
              "width": 6,
              "height": 4,
              "unit": "in"
            },
            "volume": {
              "value": 300,
              "unit": "in^3"
            },
            "void_percent": 15.23,
            "regulation_type": "full",
            "items": [
              {
                "type": "ShipmentPackingSolutionContainerItem",
                "sku": "KDS2108",
                "quantity": 2,
                "order_item_id": 4,
                "order_item_sku": "KDS2108",
                "order_item_qty": 2,
                "shipment_item_id": 4,
                "weight": {
                  "value": 20,
                  "unit": "lb"
                }
              }
            ]
          }
        ]
      },
      "picking_class_id": "Default",
      "is_cutoff_date_exception": true,
      "is_manually_processed": true,
      "label_print_target": "label001",
      "scac": "FDEG",
      "carrier_shipping_cost": 3.9,
      "is_international": true,
      "is_documents_required": true,
      "is_electronic_customs": true,
      "infill_product_id": "kraft",
      "max_package_weight": 2.5,
      "packing_solution_providers": [
        "Provider 1",
        "Provider 2"
      ],
      "tpb_group": "ACME Inc",
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:39:43Z",
      "packed_at": "2017-07-21T17:32:28Z",
      "total_weight": {
        "value": 20,
        "unit": "lb"
      }
    }
  ],
  "included": {
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "is_active": true,
        "is_deleted": false,
        "sort_order": 5,
        "created_at": "2017-07-21T17:32:28Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "Order": [
      {
        "type": "Order",
        "id": 3,
        "unique_id": "1100000003",
        "order_ref": "O-382227",
        "state": "new",
        "status": "new",
        "brand": {
          "type": "Brand",
          "id": 4,
          "code": "acme_inc",
          "name": "ACME Inc.",
          "is_active": true,
          "is_deleted": false,
          "sort_order": 0
        },
        "merchant": {
          "type": "Merchant",
          "id": 4,
          "code": "acme_inc",
          "name": "ACME Inc.",
          "is_active": true,
          "is_deleted": false,
          "sort_order": 5,
          "created_at": "2017-07-21T17:32:28Z",
          "brands": [
            {
              "type": "Brand",
              "id": 4
            }
          ],
          "default_brand": {
            "type": "Brand",
            "id": 4
          }
        },
        "carrier_code": "fedex",
        "shipping_method": "fedex_FEDEX_2_DAY",
        "signature_required": "adult",
        "is_saturday_delivery": false,
        "is_overbox_required": false,
        "priority": 50,
        "requested_ship_date": "2021-02-21",
        "is_declared_value_service": true,
        "declared_value": {
          "amount": 99,
          "currency": "USD"
        },
        "shipping_address": {
          "type": "OrderAddress",
          "id": 4,
          "first_name": "Celina",
          "last_name": "Goalley",
          "company": "Thompson-Torp",
          "street": [
            "15491 West Whiteside Street"
          ],
          "city": "Springfield",
          "region": "MO",
          "postcode": "65807",
          "country": "US",
          "telephone": "(417) 123-4567",
          "email": "celina.goalley@example.com",
          "classification": "res",
          "is_valid": true
        },
        "items": [
          {
            "type": "OrderItem",
            "id": 4,
            "sku": "KDS2108",
            "order_item_ref": "<string>",
            "product": {
              "type": "Product",
              "id": 123
            },
            "qty_ordered": 4,
            "qty_assigned": 4,
            "qty_allocated": 0,
            "qty_backordered": 0,
            "qty_processing": 0,
            "qty_picked": 0,
            "qty_shipped": 4,
            "qty_cancel_requested": 0,
            "qty_canceled": 0,
            "row_weight": {
              "value": 20,
              "unit": "lb"
            }
          }
        ],
        "shipments": [
          {
            "type": "Shipment",
            "id": 123
          }
        ],
        "custom_greeting": "<string>",
        "status_history": [
          {
            "type": "OrderStatusHistory",
            "id": 3,
            "status": "new",
            "comment": "Changed shipping method to FedEx Ground",
            "notify_merchant": null,
            "user": {
              "type": "OrganizationUser",
              "id": 3
            },
            "script_id": 123,
            "created_at": "2017-07-21T17:32:28Z"
          }
        ],
        "other_shipping_options": {
          "virtual_excluded_services": [
            "/^ups_/",
            "fedex_FEDEX_2_DAY"
          ]
        },
        "duties_payor": {
          "payor": "third_party",
          "tpb_group_id": 3
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "completed_at": "2017-07-21T17:39:43Z"
      }
    ],
    "OrderItem": [
      {
        "type": "OrderItem",
        "id": 4,
        "sku": "KDS2108",
        "order_item_ref": "<string>",
        "product": {
          "type": "Product",
          "id": 123
        },
        "qty_ordered": 4,
        "qty_assigned": 4,
        "qty_allocated": 0,
        "qty_backordered": 0,
        "qty_processing": 0,
        "qty_picked": 0,
        "qty_shipped": 4,
        "qty_cancel_requested": 0,
        "qty_canceled": 0,
        "row_weight": {
          "value": 20,
          "unit": "lb"
        }
      }
    ],
    "ShipmentItem": [
      {
        "type": "ShipmentItem",
        "id": 123,
        "sku": "KDS2108",
        "product": {
          "type": "Product",
          "id": 123
        },
        "quantity": 4,
        "qty_shipped": 4,
        "qty_picked": 0,
        "qty_canceled": 0,
        "qty_cancel_requested": 0,
        "order_item": {
          "type": "OrderItem",
          "id": 123
        },
        "reservations": [
          {
            "location": {
              "type": "Location",
              "id": 42
            },
            "quantity": 123
          }
        ]
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ],
    "Product": [
      {
        "type": "Product",
        "id": 123,
        "vendor_sku": "Vendor-SKU-1AD2",
        "external_id": "11-993-9048",
        "barcodes": [
          "956623520-4",
          "O-VS-Oregano-p3"
        ],
        "goods_type": "NORMAL",
        "is_available": true,
        "is_visible": true,
        "lot_type": {
          "type": "LotType",
          "id": 4
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "dimensions": {
          "length": 8,
          "width": 6,
          "height": 4,
          "unit": "in"
        },
        "volume": {
          "value": 300,
          "unit": "in^3"
        },
        "inventory": {
          "backorders": true,
          "dynamic_allocation": true,
          "virtual_inventory": "optimistic"
        },
        "export": {
          "description": "Plastic children's toy with steel weights and ball bearings",
          "customs_value": {
            "amount": 99,
            "currency": "USD"
          },
          "country_of_manufacture": "TW",
          "hs_base_code": "8518.30",
          "hs_country_extension": [
            {
              "country_id": "TW",
              "extension": "002"
            },
            {
              "country_id": "US",
              "extension": "011"
            }
          ]
        },
        "regulated_goods": {
          "regulation": {
            "type": "Regulation",
            "id": 123
          },
          "technical_name": "Hydro Polymer Acetylene Coating",
          "additional_information": "Flamable Liquid",
          "net_weight": {
            "value": 20,
            "unit": "lb"
          },
          "container_type": "Plastic Box",
          "container_meets_hazmat_specs": true,
          "regulation_units": 5
        },
        "packaging": {
          "require_packaging": true,
          "require_weight_check": true,
          "require_confirmation_per_item": true,
          "unit_quantity": 1,
          "bulk_quantity": 10,
          "max_per_package": 15,
          "is_ship_separately": true,
          "ship_separately_tag": "PVC",
          "can_tip": true,
          "can_contain_other_items": true,
          "is_handling_surcharge": true
        },
        "custom_fields": [
          {
            "code": "color",
            "value": 13,
            "label": "Red and Black"
          },
          {
            "code": "cost_of_goods",
            "value": 41.32
          },
          {
            "code": "allow_mailer",
            "value": true
          }
        ],
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ]
  },
  "has_more": true,
  "next": "<string>",
  "previous": "<string>",
  "meta": {
    "processing_time": 0.2525252525,
    "cursor_start": 123,
    "cursor_end": 123,
    "count": 123
  }
}

Query Parameters

​
fields
enum<string>[]

Specify additional fields of the Shipment object to be included in the response. See the selecting fields page for more information.

​
fields:items
enum<string>[]

Specify additional fields of the ShipmentItem object to be included in the response. See the selecting fields page for more information.

​
fields:items.product
enum<string>[]

Specify additional fields of the Product objects to be included in the response. See the selecting fields page for more information.

​
fields:items.order_item
enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

​
fields:order
enum<string>[]

Specify additional fields of the Order object to be included in the response. See the selecting fields page for more information.

​
fields:order.items
enum<string>[]

Specify additional fields of the OrderItem object to be included in the response. See the selecting fields page for more information.

​
fields:order.shipments
enum<string>[]

Specify additional fields of the Shipment object to be included in the response. See the selecting fields page for more information.

​
fields:order.merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

​
fields:order.brand
enum<string>[]

Specify additional fields of the Brand object to be included in the response. See the selecting fields page for more information.

​
fields:order.shipping_address
enum<string>[]

Specify additional fields of the OrderAddress object to be included in the response. See the selecting fields page for more information.

​
fields:order.status_history
enum<string>[]

Specify additional fields of the OrderStatusHistory object to be included in the response. See the selecting fields page for more information.

​
fields:warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response. See the selecting fields page for more information.

​
fields:packages
enum<string>[]

Specify additional fields of the ShipmentPackage object to be included in the response. See the selecting fields page for more information.

​
fields:packages.items
enum<string>[]

Specify additional fields of the ShipmentPackageItem object to be included in the response. See the selecting fields page for more information.

​
fields:packing_solution
enum<string>[]

Specify additional fields of the ShipmentPackingSolution object to be included in the response. See the selecting fields page for more information.

​
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • unique_id
  • created_at
  • updated_at
  • packed_at
​
sort
string

The default sort order is descending by primary key (sort=-id). The following fields are available for sorting:

  • id
  • unique_id
  • created_at
  • updated_at
  • packed_at
  • merchant_id
​
count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
​
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

​
cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

​
limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

Response

200
application/json

A dictionary with a collection property that contains an array of up to limit Shipment objects. If no shipments are found the array will be empty.

The response is of type object.