Shipsidekick LogoShipsidekick Docs
API/Shipments

List shipments

Retrieve a list of shipments with pagination and filtering options. Results are filtered to shipments the authenticated user has access to.

GET
/shipments

Query Parameters

limitinteger

Maximum number of items to return per page

Default: 10Minimum: 1Maximum: 100
pageinteger

Page number for pagination

Default: 1Minimum: 1
searchstring

Search term to filter shipments by tracking code

cursorstring

Cursor for pagination (alternative to page-based pagination)

sortBystring

Field to sort by

sortOrderstring

Order to sort by

Default: "desc"Value in: "asc" | "desc"
carrierCodestring

Filter shipments by carrier code

trackingStatusstring

Filter shipments by tracking status

dateRange[from]string

Start date for filtering shipments by creation date

Format: "date"
dateRange[to]string

End date for filtering shipments by creation date

Format: "date"
curl -X GET "https://www.shipsidekick.com/api/v1/shipments?limit=10&page=1&search=string&cursor=string&sortBy=string&sortOrder=asc&carrierCode=string&trackingStatus=string&dateRange%5Bfrom%5D=2019-08-24&dateRange%5Bto%5D=2019-08-24"

Successful operation

{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "trackingCode": "string",
      "returnAddress": {
        "name": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "phone": "string",
        "email": "string"
      },
      "carrierAccount": {
        "carrierCode": "string",
        "description": "string"
      },
      "shippingQuote": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
        "shipToAddress": {
          "name": "string",
          "company": "string",
          "street1": "string",
          "street2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string",
          "phone": "string",
          "email": "string",
          "facilityCode": "string",
          "isResidential": true,
          "isVerified": true,
          "taxIdentifier": "string"
        },
        "shipFromAddress": {
          "name": "string",
          "company": "string",
          "street1": "string",
          "street2": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string",
          "phone": "string",
          "email": "string",
          "facilityCode": "string",
          "isResidential": true,
          "isVerified": true,
          "taxIdentifier": "string"
        },
        "shippingDate": "2019-08-24T14:15:22Z",
        "messages": [
          "string"
        ],
        "packages": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "weight": 0.1,
            "weightUnit": "string",
            "dimensions": {
              "length": 0.1,
              "width": 0.1,
              "height": 0.1
            },
            "dimensionsUnit": "string",
            "packaging": {
              "name": "string",
              "type": "string"
            }
          }
        ],
        "shippingRates": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "serviceCode": "string",
            "rateTotal": 0,
            "rateSurcharges": 0.1,
            "compareAtRate": 0,
            "currency": "string",
            "estDeliveryDays": 0,
            "estDeliveryDate": "2019-08-24T14:15:22Z",
            "deliveryDateGuaranteed": true,
            "message": "string",
            "carrierAccount": {
              "carrierCode": "string",
              "description": "string"
            }
          }
        ],
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "shippingRate": {
        "serviceCode": "string",
        "rateTotal": 0,
        "currency": "string",
        "estDeliveryDays": 0,
        "estDeliveryDate": "2019-08-24T14:15:22Z"
      },
      "tracker": {
        "status": "string",
        "statusDetail": "string",
        "estDeliveryDate": "2019-08-24T14:15:22Z",
        "trackingUrl": "string"
      },
      "order": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": true,
  "totalCount": 0,
  "limit": 0,
  "nextCursor": "string"
}

Get shipment by ID GET

Retrieve a specific shipment by its unique identifier. Results are filtered to shipments the authenticated user has access to.