Create a parcel or parcels

curl --request POST \
  --url https://panel.sendcloud.sc/api/v2/parcels \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parcel": {
    "name": "John Doe",
    "company_name": "Sendcloud",
    "address": "Stadhuisplein",
    "house_number": "10",
    "city": "Eindhoven",
    "postal_code": "5611 EM",
    "telephone": "+31612345678",
    "request_label": true,
    "email": "john@doe.com",
    "data": {},
    "country": "NL",
    "shipment": {
      "id": 8
    },
    "weight": "10.000",
    "order_number": "1234567890",
    "insured_value": 0,
    "total_order_value_currency": "GBP",
    "total_order_value": "11.11",
    "quantity": 1,
    "shipping_method_checkout_name": "DHL Express Domestic"
  }
}
'

{
  "parcel": {
    "id": 3,
    "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": "",
    "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",
    "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"
    },
    "documents": [
      {
        "type": "label",
        "size": "a6",
        "link": "https://panel.sendcloud.sc/api/v2/parcels/3/documents/label"
      }
    ],
    "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"
    },
    "is_return": false,
    "total_order_value_currency": "GBP",
    "total_order_value": "11.11",
    "colli_uuid": "88296eff-595c-4c62-9b6f-075112bf54f6",
    "collo_nr": 0,
    "collo_count": 1,
    "awb_tracking_number": null,
    "box_number": null,
    "length": null,
    "width": null,
    "height": null,
    "shipping_method_checkout_name": "DHL Express Domestic",
    "reference": "some_reference_123"
  }
}

POST

parcels

curl --request POST \
  --url https://panel.sendcloud.sc/api/v2/parcels \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parcel": {
    "name": "John Doe",
    "company_name": "Sendcloud",
    "address": "Stadhuisplein",
    "house_number": "10",
    "city": "Eindhoven",
    "postal_code": "5611 EM",
    "telephone": "+31612345678",
    "request_label": true,
    "email": "john@doe.com",
    "data": {},
    "country": "NL",
    "shipment": {
      "id": 8
    },
    "weight": "10.000",
    "order_number": "1234567890",
    "insured_value": 0,
    "total_order_value_currency": "GBP",
    "total_order_value": "11.11",
    "quantity": 1,
    "shipping_method_checkout_name": "DHL Express Domestic"
  }
}
'

{
  "parcel": {
    "id": 3,
    "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": "",
    "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",
    "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"
    },
    "documents": [
      {
        "type": "label",
        "size": "a6",
        "link": "https://panel.sendcloud.sc/api/v2/parcels/3/documents/label"
      }
    ],
    "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"
    },
    "is_return": false,
    "total_order_value_currency": "GBP",
    "total_order_value": "11.11",
    "colli_uuid": "88296eff-595c-4c62-9b6f-075112bf54f6",
    "collo_nr": 0,
    "collo_count": 1,
    "awb_tracking_number": null,
    "box_number": null,
    "length": null,
    "width": null,
    "height": null,
    "shipping_method_checkout_name": "DHL Express Domestic",
    "reference": "some_reference_123"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

Sendcloud-Partner-Id

string

If you are an official Sendcloud Tech Partner, send your unique Sendcloud Partner UUID as a request header for the system to recognize you.

The header is not required but if it is set, the system will check it. An unknown or invalid UUID will cause a 400 error.

Query Parameters

errors

enum<string>

When making an API request, the errors query parameter can be used to determine the type of errors that should be included in the response. If verbose is specified, the response will only contain errors that Sendcloud has validated. These errors may include shipment details such as invalid addresses or missing postal codes. On the other hand, if verbose-carrier is specified, the response will include errors originating from the carriers side of the shipping process. These errors may result from technical or validation problems, such as connection failures or issues with the carrier`s systems, that prevent the shipment from being processed. More details are described on the page Handling parcel errors.

Available options:

verbose-carrier,

verbose

Body

application/json

Create a single parcel
Create a batch of parcels

parcel

Parcel Creation Object · object

Parcel object for a parcel creation

Show child attributes

Response

Failed to create parcels response
Single parcel created response
Batch of parcels created response

Create a parcel

failed_parcels

object[]

Show child attributes

Retrieve a return portal url Cancel a parcel

⌘I

Getting started

Air Waybill API

Analytics API

Auth API

Brands API

Contracts API

Dynamic Checkout API

Integrations API

Invoices API

Labels API

Parcel documents API

Parcel statuses API

Parcels API

Pickups API

Reporting API

Return portal API

Returns API

Sender addresses API

Service points API

Shipping methods API

Shipping prices API

Shipping products API

Tracking API

Users API

Webhooks

Authorizations

Headers

Query Parameters

Body

Response