Create a pickup - Sendcloud API Developer Portal

General

Authentication & account

Shipping

Checkout & delivery options

Tracking & post-purchase

Events & notifications

Carriers & pickups

Financial

Data & insights

Integrations

curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/pickups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "name": "John Doe",
    "company_name": "Sendcloud",
    "country_code": "NL",
    "city": "Eindhoven",
    "email": "example@sendcloud.com",
    "address_line_1": "Stadhuisplein",
    "house_number": "10",
    "address_line_2": "",
    "postal_code": "5611 EM",
    "phone_number": "+310612345678"
  },
  "time_slots": [
    {
      "start_at": "2022-04-06T12:00:00Z",
      "end_at": "2022-04-06T17:00:00Z"
    }
  ],
  "items": [
    {
      "quantity": 20,
      "container_type": "parcel",
      "total_weight": {
        "value": "1.00",
        "unit": "kg"
      }
    }
  ],
  "carrier_code": "dhl_express"
}
'

{
  "data": {
    "id": 294247,
    "address": {
      "name": "John Doe",
      "company_name": "Sendcloud",
      "country_code": "NL",
      "city": "Eindhoven",
      "email": "example@sendcloud.com",
      "address_line_1": "Stadhuisplein",
      "house_number": "10",
      "address_line_2": "",
      "postal_code": "5611 EM",
      "phone_number": "+310612345678"
    },
    "time_slots": [
      {
        "start_at": "2022-04-06T12:00:00Z",
        "end_at": "2022-04-06T17:00:00Z"
      }
    ],
    "items": [
      {
        "quantity": 20,
        "container_type": "parcel",
        "total_weight": {
          "value": "1.00",
          "unit": "kg"
        }
      }
    ],
    "reference": "",
    "special_instructions": "",
    "tracking_number": "",
    "status": "ANNOUNCING",
    "created_at": "2022-03-30T09:20:37.957495Z",
    "cancelled_at": null,
    "carrier_code": "dhl_express",
    "contract_id": 10
  }
}

POST

/

pickups

curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/pickups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "name": "John Doe",
    "company_name": "Sendcloud",
    "country_code": "NL",
    "city": "Eindhoven",
    "email": "example@sendcloud.com",
    "address_line_1": "Stadhuisplein",
    "house_number": "10",
    "address_line_2": "",
    "postal_code": "5611 EM",
    "phone_number": "+310612345678"
  },
  "time_slots": [
    {
      "start_at": "2022-04-06T12:00:00Z",
      "end_at": "2022-04-06T17:00:00Z"
    }
  ],
  "items": [
    {
      "quantity": 20,
      "container_type": "parcel",
      "total_weight": {
        "value": "1.00",
        "unit": "kg"
      }
    }
  ],
  "carrier_code": "dhl_express"
}
'

{
  "data": {
    "id": 294247,
    "address": {
      "name": "John Doe",
      "company_name": "Sendcloud",
      "country_code": "NL",
      "city": "Eindhoven",
      "email": "example@sendcloud.com",
      "address_line_1": "Stadhuisplein",
      "house_number": "10",
      "address_line_2": "",
      "postal_code": "5611 EM",
      "phone_number": "+310612345678"
    },
    "time_slots": [
      {
        "start_at": "2022-04-06T12:00:00Z",
        "end_at": "2022-04-06T17:00:00Z"
      }
    ],
    "items": [
      {
        "quantity": 20,
        "container_type": "parcel",
        "total_weight": {
          "value": "1.00",
          "unit": "kg"
        }
      }
    ],
    "reference": "",
    "special_instructions": "",
    "tracking_number": "",
    "status": "ANNOUNCING",
    "created_at": "2022-03-30T09:20:37.957495Z",
    "cancelled_at": null,
    "carrier_code": "dhl_express",
    "contract_id": 10
  }
}

This endpoint allows you to schedule a pickup with one of the supported carriers. Schedule a pickup time and choose a location, and include any additional instructions to the driver by including the special_instructions parameter. Once a pickup is successfully scheduled, a pickup id will be returned.

If you have more than one active contract for the carrier, you must include the contract field with your desired contract ID in your request. You can get your contract ID from the Retrieve a list of contracts endpoint.

Authorizations

Authorization

string

header

required

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

Body

application/json

time_slots

Time Slot Object · object[]

required

Scheduled time slots for the pickup. One or two time slots can be defined, one for the morning and one for the afternoon.

Required array length: 1 element

Show child attributes

carrier_code

enum<string>

required

Pickup carrier code selected by the user.

Available options:

brt

Example:

"dhl_express"

quantity

integer

required

Number of parcels to pick up.

Required range: x >= 1

total_weight

Weight · object

required

Total weight in kilograms.

Show child attributes

address

Pickup Address Object · object

required

Pickup address information.

Show child attributes

items

Pickup Item Object · object[]

Items scheduled to be picked up.

Minimum array length: 1

Show child attributes

reference

string

Reference number for your administration.

special_instructions

string

Special instructions for the pickup driver.

contract_id

integer | null

Contract ID you want to use for the pickup request.

Response

Created - This means that the data is send to the carrier successfully, to see if the carrier accepted the pickup request check the status of the pickup via the GET endpoint.

data

BRT Pickup Object · object

Show child attributes