Skip to main content
GET
/
shipments
/
{id}
Retrieve a shipment
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/shipments/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": {
    "id": "XXX-Shipment-id",
    "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 478"
    },
    "ship_with": {
      "type": "shipping_option_code",
      "properties": {
        "shipping_option_code": "dhl_express:worldwide/incoterm=dap",
        "contract_id": 4195
      }
    },
    "customs_information": null,
    "errors": [],
    "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/383559021/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=3SYZXG8498635&destination=NL&lang=en-us&source=NL&type=parcel&verification=5642+CV&servicepoint_verification=&created_at=2024-06-06",
        "tracking_number": "3SYZXG8498635",
        "additional_carrier_data": {
          "awb_tracking_number": null,
          "box_number": null
        },
        "created_at": "2024-06-06T17:11:14.616615Z",
        "updated_at": "2024-06-06T17:41:16.998357Z",
        "announced_at": "2024-06-06T17:11:15.247645Z",
        "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"
            }
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The id of the shipment you want to retrieve

Response

OK

data
Shipment response Object · object

Shipment response object model