Skip to main content
GET
/
shipments
Retrieve shipments
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shipments \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "XXX-Shipment-id",
      "order_number": "1234567890",
      "total_order_price": {
        "currency": "EUR",
        "value": "11.11"
      },
      "parcels": [
        {
          "id": 383707309,
          "status": {
            "code": "CANCELLED",
            "message": "Cancelled"
          },
          "documents": [
            {
              "type": "label",
              "size": "a6",
              "link": "https://panel.sendcloud.sc/api/v3/parcels/383707309/documents/label"
            }
          ],
          "dimensions": {
            "width": "15.00",
            "length": "5.00",
            "height": "20.00",
            "unit": "cm"
          },
          "weight": {
            "value": "1.320",
            "unit": "kg"
          },
          "tracking_url": "https://tracking.eu-central-1-0.sendcloud.sc/forward?carrier=postnl&code=3SYZXG5051720&destination=NL&lang=en-us&source=NL&type=parcel&verification=5642+CV&servicepoint_verification=&created_at=2024-06-07",
          "tracking_number": "3SYZXG5051720",
          "additional_carrier_data": {
            "awb_tracking_number": null,
            "box_number": null
          },
          "created_at": "2024-06-07T09:02:18.864105Z",
          "updated_at": "2024-06-07T09:32:22.804278Z",
          "announced_at": "2024-06-07T09:02:19.480225Z",
          "label_notes": [
            "I live at the blue door",
            "The doorbell isn’t working"
          ],
          "parcel_items": [
            {
              "item_id": "5552",
              "description": "T-Shirt XL",
              "quantity": 1,
              "weight": {
                "value": "0.3",
                "unit": "kg"
              },
              "price": {
                "value": "12.65",
                "currency": "EUR"
              },
              "hs_code": "620520",
              "origin_country": "NL",
              "sku": "TS1234",
              "product_id": "19284",
              "mid_code": "NLOZR92MEL",
              "material_content": "100% Cotton",
              "intended_use": "Personal use",
              "dds_reference": "25FIYPEK0A7573",
              "taric_doc_code": "Y142",
              "properties": {
                "size": "XL",
                "color": "green"
              }
            },
            {
              "item_id": "98712",
              "description": "Sneakers 42",
              "quantity": 1,
              "weight": {
                "value": "1.02",
                "unit": "kg"
              },
              "price": {
                "value": "12.65",
                "currency": "EUR"
              },
              "hs_code": "620520",
              "origin_country": "US",
              "sku": "TS1234",
              "product_id": "19284",
              "mid_code": "US1234567",
              "material_content": "100% Cotton",
              "intended_use": "Personal use",
              "dds_reference": "25FIYPEK0A7573",
              "taric_doc_code": "Y142",
              "properties": {
                "size": 42,
                "color": "black"
              }
            }
          ]
        }
      ],
      "from_address": {
        "address_line_1": "Stadhuisplein 10",
        "address_line_2": "2e verdieping",
        "city": "Eindhoven",
        "company_name": "Sendcloud",
        "country_code": "NL",
        "email": "marie.doe@sendcloud.com",
        "house_number": "10",
        "name": "Marie Doe",
        "phone_number": "+31612345678",
        "postal_code": "5611 EM",
        "po_box": "PO Box 678"
      },
      "to_address": {
        "address_line_1": "Insulindelaan",
        "address_line_2": "",
        "city": "Eindhoven",
        "company_name": "Sendcloud",
        "country_code": "NL",
        "email": "john.doe@sendcloud.com",
        "house_number": "115",
        "name": "John Doe",
        "phone_number": "+31612345678",
        "postal_code": "5642 CV",
        "po_box": "PO Box 483"
      },
      "ship_with": {
        "type": "shipping_option_code",
        "properties": {
          "shipping_option_code": "postnl:standard",
          "contract_id": 517
        }
      },
      "customs_information": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

​
parcel_status

Returns shipments that have the requested status. For a list of possible statuses, see the Retrieve a list of parcel statuses endpoint.

​
tracking_number
string

Returns shipments that match a specified tracking number

​
external_reference_id
string

Returns shipments that match a specified external reference

​
order_number
string

Returns a shipment that matches a specific order_number property from your shipments

​
integration_id
string

Returns all shipments that matches a specific integration_id property from your shipments

​
updated_before
string

Returns all shipments which have been updated in our system before a given time. Use the ISO 8601 datetime format.

Example:

"2018-02-26T11:01:47.505309+00:00"

​
updated_after
string

Returns all shipments which have been updated in our system after a given time. Use the ISO 8601 datetime format.

Example:

"2018-02-26T11:01:47.505309+00:00"

​
announced_before
string

Returns all shipments which have been announced to the carrier before the given time. Use the ISO 8601 datetime format.

Example:

"2018-02-26T11:01:47.505309+00:00"

​
announced_after
string

Returns all shipments which have been announced to the carrier after the given time. Use the ISO 8601 datetime format.

Example:

"2018-02-26T11:01:47.505309+00:00"

​
ids
string

Filter results using a comma-separated list of shipments IDs. The list may not contain more than 100 IDs.

Example:

"13579,24680,12345"

​
cursor
string

The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.

There are 3 possible parameters to encode:

  • o: Offset
  • r: Reverse
  • p: Position

For example, r=1&p=300 encoded as a base64 string would be cj0xJnA9MzAw. The query string would then be cursor=cj0xJnA9MzAw.

Example:

"cj0xJnA9MzAw"

​
page_size
integer
default:40

The maximum number of items to be returned in the response.

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

10

Response

OK

Retrieve shipments

​
data
Shipment response Object · object[]
required
Minimum array length: 1