List Shipments

Search for shipments based on tracking numbers, reference IDs, or internal shipment IDs.

Endpoint: GET /api/shipments

Required Scope: shipments:read

Request Specification (Query Parameters)

Parameter	Type	Required	Description
Numbers	string	Yes	Comma , separated list of numbers to search for.
NumberType	string	No	Type of numbers provided (ShipmentId, TrackingNumber, ReferenceId). Default value is ShipmentId.
Page	int	No	Page number (default: 1).
PageSize	int	No	Items per page (default: 10).

Response Specification

Returns a paged list of Shipment objects wrapped in Result.

Property	Type	Description
Elements	Shipment[]	List of shipments matching the criteria.
TotalItemCount	int	Total number of shipments found.
PageNumber	int	Current page number.
PageSize	int	Number of items per page.

Sample JSON

Request

GET /api/shipments?Numbers=9234690327908700395257&NumberType=TrackingNumber

Response

{
  "Data": {
    "Elements": [
      {
        "Id": "2603XSHPT00001CE",
        "AccountNo": "DAC0001",
        "ReferenceId": "API-TESTREF20260323002",
        "ShippingProductId": "TEST_01",
        "ToAddress": {
          "Company": "Receiver Corp",
          "Street1": "123 Main St",
          "Street2": "Suite 456",
          "Street3": "",
          "City": "Los Angeles",
          "Province": "CA",
          "CountryCode": "US",
          "Postcode": "90001",
          "ContactName": "John Doe",
          "Tel": "628 212 8833",
          "Email": "[email protected]",
          "TaxId": ""
        },
        "FromAddress": {
          "Company": "Online Seller",
          "Street1": "136 E De La Guerra St",
          "Street2": "",
          "Street3": "",
          "City": "Santa Barbara",
          "Province": "CA",
          "CountryCode": "US",
          "Postcode": "93101",
          "ContactName": "Jane Smith",
          "Tel": "423 877 8832",
          "Email": "[email protected]",
          "TaxId": ""
        },
        "ReturnAddress": null,
        "Weight": {
          "Value": 1.0,
          "Unit": "LB"
        },
        "Size": {
          "Length": 25.4,
          "Width": 12.7,
          "Height": 7.62,
          "Unit": "IN"
        },
        "DeclaredValue": {
          "Code": "USD",
          "Value": 20.0
        },
        "ShipDate": "2026-03-23",
        "Notes": "",
        "Quote": {
          "QuotationType": "Basic",
          "Fees": [
            {
              "FeeType": "BASE",
              "Amount": 9.09
            },
            {
              "FeeType": "REGISTRATION",
              "Amount": 5.0
            },
            {
              "FeeType": "NON_STANDARD_LENGTH",
              "Amount": 4.5
            }
          ],
          "Total": 18.59,
          "Weight": 1.0,
          "DimensionalWeight": 14.808,
          "FeeWeight": 14.808,
          "FeeWeightType": "DimensionalWeight",
          "PriceZone": "2",
          "WeightUnit": "LB",
          "LengthUnit": "IN",
          "CurrencyCode": "USD"
        },
        "Carrier": {
          "Status": "Created",
          "Barcode": "420900019234690327908700395257",
          "Message": ""
        },
        "TrackingNumber": "9234690327908700395257",
        "CreateAt": "2026-03-23T08:48:36Z"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalItemCount": 2
  },
  "Succeeded": true,
  "Error": null,
  "CapturedValues": {}
}