Skip to main content
GET
/
integrations
/
{id}
/
shipments
Retrieve a list of shipments
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/integrations/{id}/shipments \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "address": "Lansdown Glade",
      "address_2": "string",
      "allowed_shipping_methods": [
        0
      ],
      "barcode": "string",
      "city": "Oss",
      "company_name": "string",
      "country": "AW",
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "EUR",
      "customs_invoice_nr": "120",
      "customs_shipment_type": 0,
      "email": "user@example.com",
      "external_order_id": "555413",
      "external_shipment_id": "777413",
      "house_number": "15",
      "integration": 0,
      "name": "John Doe",
      "order_number": "OXSDFGHTD-12",
      "order_status": {
        "id": "fulfilled",
        "message": "Fulfilled"
      },
      "parcel_items": [
        {
          "description": "Very orange color",
          "hs_code": "01013000",
          "origin_country": "AW",
          "product_id": "1458734634",
          "properties": {
            "size": "small",
            "colour": "red"
          },
          "quantity": 2,
          "sku": "WW-DR-GR-XS-001",
          "value": "3.5",
          "weight": "1",
          "mid_code": "NLOZR92MEL",
          "material_content": "100% Cotton",
          "intended_use": "Personal use"
        }
      ],
      "payment_status": {
        "id": "paid",
        "message": "Paid"
      },
      "postal_code": "5341",
      "sender_address": 12345,
      "shipment_uuid": "6b436cb2-65a4-482c-9d25-38be7868ff00",
      "shipping_method": 12345,
      "shipping_method_checkout_name": "string",
      "telephone": "string",
      "to_post_number": "string",
      "to_service_point": 0,
      "to_state": "string",
      "total_order_value": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "weight": "string",
      "checkout_payload": {
        "sender_address_id": 0,
        "shipping_product": {
          "code": "postnl:standard",
          "name": "PostNL Standard",
          "selected_functionalities": {
            "age_check": 18,
            "last_mile": "home_delivery",
            "first_mile": "pickup_dropoff",
            "multicollo": true,
            "form_factor": "parcel",
            "service_area": "domestic",
            "weekend_delivery": "saturday",
            "delivery_deadline": "best_effort",
            "direct_contract_only": false
          }
        },
        "delivery_method_type": "string",
        "delivery_method_data": {
          "delivery_date": "2019-08-24T14:15:22Z",
          "formatted_delivery_date": "string",
          "parcel_handover_date": "2019-08-24T14:15:22Z"
        }
      },
      "width": "string",
      "height": "string",
      "length": "string",
      "customs_details": {
        "discount_granted": "3.99",
        "insurance_costs": "9.99",
        "freight_costs": "5.99",
        "other_costs": "2.99",
        "tax_numbers": {
          "sender": [
            {
              "tax_number": {
                "name": "VAT",
                "country": "NL",
                "value": "NL987654321B02"
              }
            }
          ],
          "receiver": [
            {
              "tax_number": {
                "name": "VAT",
                "country": "DE",
                "value": "DE123456789B03"
              }
            }
          ],
          "importer_of_records": [
            {
              "tax_number": {
                "name": "VAT",
                "country": "NL",
                "value": "NL975318642B01"
              }
            }
          ]
        }
      },
      "shipment_created_at": "2019-09-25T14:15:22Z",
      "shipment_updated_at": "2019-09-25T14:15:22Z"
    }
  ]
}
Note that the orders are not affected by shipping rules at the time of retrieval, unless enabled explicitly. This endpoint is paginated, meaning that you can navigate through the results via the URLs provided within the next and previous fields.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

The id of the integration to which the shipments belong

Query Parameters

​
cursor
string

The cursor query string will be used as the pivot value to filter results. If no value is provided, the service must return the first page. The value is Base64 encoded GET parameters. example: For a cursor string there are 3 possible parameters to encode:

Example:

"cj0xJnA9MzAw"

​
start_date
string<date>

Displays orders from the given start_date, including the set date. It defaults to one year ago.

​
end_date
string<date>

Displays orders up to the given end_date, including the set date. It defaults to the current date.

​
external_order_ids
string[]

Filters results to shipments where their external_order_id matches one of the user provided ones.

​
external_shipment_ids
string[]

Filters results to shipments where their external_shipments_id matches one of the user provided ones.

​
shipping_rules
boolean

Enable shipping rules when retrieving orders. This will have an impact on the allowed_shipping_methods.

​
order_number
string

Filters results to shipments on order_number.

​
sender_address
integer

Allows to specify a sender address id to display proper allowed_shipping_methods.

Response

OK

​
next
string<uri>

Cursor based pagination url to go forward. By following this URL you can get a next batch of shipments

​
previous
string<uri>

Cursor based pagination url to go backwards. By following this URL you can get a previous batch of shipments

​
results
Shipment Blob Order Object · object[]