Skip to main content
GET
/
parcels
Retrieve parcels
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/parcels \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": null,
  "previous": null,
  "parcels": [
    {
      "id": 3172,
      "name": "John Doe",
      "company_name": "Sendcloud",
      "contract": 1,
      "address": "Stadhuisplein 10",
      "address_divided": {
        "street": "Stadhuisplein",
        "house_number": "10"
      },
      "city": "Eindhoven",
      "postal_code": "5611 EM",
      "telephone": "0612345678",
      "email": "test@email.com",
      "date_created": "01-01-2018 21:45:30",
      "date_updated": "01-01-2018 21:47:12",
      "date_announced": "01-01-2018 21:47:13",
      "tracking_number": "S0M3TR4Ck1NgNumB3r",
      "customs_declaration": {},
      "weight": "2.000",
      "label": {
        "normal_printer": [
          "https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=0&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
          "https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=1&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
          "https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=2&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4",
          "https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=3&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
        ],
        "label_printer": "https://panel.sendcloud.sc/api/v2/label/label_printer/3172?hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
      },
      "status": {
        "id": 0,
        "message": "Ready to send"
      },
      "data": {},
      "country": {
        "iso_3": "NLD",
        "iso_2": "NL",
        "name": "Netherlands"
      },
      "shipment": {
        "id": 1,
        "name": "PostNL Standard 0-23kg"
      },
      "carrier": {
        "code": "postnl"
      },
      "colli_uuid": "ab3ecb5e-61b6-42b1-8034-7c6befdeaa63",
      "collo_nr": 0,
      "collo_count": 1,
      "reference": "some_reference_123"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
parcel_status
integer

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

​
tracking_number
string

Returns parcels that match a specified tracking number

​
external_reference
string

Returns parcels that match a specified external reference

​
order_number
string

Returns an order that matches a specific order_number property from your parcels

​
updated_after
string

Returns all orders which have been updated in our system after a given time. You can use the value of ISO 8601 DateTime string like this

Example:

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

​
announced_after
string

Returns all orders which have been announced to the carrier after the given time. You can use the value of ISO 8601 DateTime string like this

Example:

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

​
ids
string

Filter results using a list of Parcel IDs. This is a comma separated list of IDs, it may not contain more then 100 IDs.

​
cursor
string

Next and previous token that is used to paginate. The token is included in the response.

​
errors
enum<string>

If you are using this API for development purposes, you might want to use the errors query string in the URL. This allows you to visualize errors from the carrier.

Available options:
verbose-carrier

Response

OK

Retrieve parcels

​
parcels
Parcel Object · object[]
required
Minimum array length: 1
​
next
integer | null
​
previous
integer | null