latestOpenAPI 3.1.0MIT2026-08-104712182.1 KB

c71c20d26559

shipments

List shipments

Obtains a list of shipments that match the specified criteria.

Note: Only valid shipments with labels generated in ShipStation will be returned. Orders that have been marked as Shipped through the UI or API will not appear as they are considered external shipments.

get/shipments

Query parameters

recipientNamestring

Returns shipments shipped to the specified recipient name

recipientCountryCodestring

Returns shipments shipped to the specified country code (two-letter ISO)

orderNumberstring

Returns shipments whose orders have the specified order number

orderIdinteger

Returns shipments whose orders have the specified order ID

carrierCodestring

Returns shipments shipped with the specified carrier

serviceCodestring

Returns shipments shipped with the specified shipping service

trackingNumberstring

Returns shipments with the specified tracking number

createDateStartstring date-time

Returns shipments created on or after the specified date

createDateEndstring date-time

Returns shipments created on or before the specified date

shipDateStartstring date

Returns shipments with shipDate on or after the specified date

shipDateEndstring date

Returns shipments with shipDate on or before the specified date

voidDateStartstring date-time

Returns shipments voided on or after the specified date

voidDateEndstring date-time

Returns shipments voided on or before the specified date

storeIdinteger

Returns shipments whose orders belong to the specified store ID

includeShipmentItemsboolean

Specifies whether to include shipment items with results

sortBy'ShipDate' | 'CreateDate'

Sort the responses by a set value. If left empty, the response will be sorted by ascending createDate.

sortDir'ASC' | 'DESC'

Sort direction

pageinteger

Page number

pageSizeinteger

Number of results per page. Maximum 500.

Response

List of shipments retrieved successfully

totalinteger

Total number of shipments

pageinteger

Current page number

pagesinteger

Total number of pages

Example response

{
  "shipments": [
    {
      "shipmentId": 33974374,
      "orderId": 43945660,
      "orderKey": "8061c220f0794a9b92460b8bae6837e4",
      "userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
      "orderNumber": "100038-1",
      "createDate": "2014-10-03T06:51:33Z",
      "shipDate": "2014-10-03",
      "shipmentCost": 1.93,
      "trackingNumber": "9400111899561704681189",
      "batchNumber": "100301",
      "carrierCode": "stamps_com",
      "serviceCode": "usps_first_class_mail",
      "packageCode": "package",
      "confirmation": "delivery",
      "warehouseId": 16079,
      "marketplaceNotified": true,
      "shipTo": {
        "name": "John Doe",
        "company": "Acme Corp",
        "street1": "123 Main St",
        "street2": "Apt 4B",
        "street3": "Building B",
        "city": "Austin",
        "state": "TX",
        "postalCode": "78701",
        "country": "US",
        "phone": "512-555-1234",
        "residential": true,
        "addressVerified": "Address validated successfully"
      },
      "weight": {
        "value": 24,
        "units": "ounces"
      },
      "dimensions": {
        "length": 7,
        "width": 5,
        "height": 6,
        "units": "inches"
      },
      "insuranceOptions": {
        "provider": "carrier",
        "insureShipment": true,
        "insuredValue": 200
      },
      "advancedOptions": {
        "warehouseId": 98765,
        "parentId": 93348442,
        "storeId": 12345,
        "customField1": "Custom data that you can add to an order",
        "customField2": "Per UI settings, this can appear on some carrier labels",
        "customField3": "https://help.shipstation.com/hc/en-us/articles/206639957",
        "source": "Webstore",
        "billToParty": "third_party",
        "billToAccount": "123456789",
        "billToPostalCode": "78701",
        "billToCountryCode": "US",
        "movementIndicator": "b2c"
      }
    }
  ],
  "total": 2,
  "page": 1,
  "pages": 1
}