DPD @ shipcloud

Services

Standard

The most basic service. Normal ground shipping without any modifier to speed up the shipping time.

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "carrier": "dpd",
  "service": "standard",
  "create_shipping_label": true
}

Returns

A shipment that the customer sends back to the store / sender

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "to": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "carrier": "dpd",
  "service": "returns",
  "create_shipping_label": true
}

One day

Express shipment that will be delivered the next working day

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "carrier": "dpd",
  "service": "one_day",
  "create_shipping_label": true
}

One day early

Express shipment that will be delivered the next working day before noon

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "carrier": "dpd",
  "service": "one_day_early",
  "create_shipping_label": true
}

Package types

Parcel

The most basic package type for shipping parcels there is.

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "carrier": "dpd",
  "service": "standard",
  "create_shipping_label": true
}

Parcel letter

Everything which is too small for a parcel but larger and heavier than a classical letter

Requirements:

package.type has to be parcel_letter

Show example

POST https://api.shipcloud.io/v1/shipments

{
    "from": {
        "first_name": "Serge",
        "last_name": "Sender",
        "company": "Sender Corp.",
        "street": "Sender Str.",
        "street_no": "99",
        "zip_code": "20148",
        "city": "Hamburg",
        "country": "DE"
    },
    "to": {
        "first_name": "Roger",
        "last_name": "Receiver",
        "street": "Receiver Str.",
        "street_no": "1",
        "city": "Hamburg",
        "zip_code": "20535",
        "country": "DE"
    },
    "package": {
        "weight": 0.5,
        "length": 25,
        "width": 36,
        "height": 5,
        "type": "parcel_letter"
    },
    "carrier": "dpd",
    "service": "standard",
    "create_shipping_label": true
}

Additional services

Drop authorization

When sending packages via DPD the sender can allow the carrier to leave the shipment with someone else in case the receiver isn't present and has allowed the sender to do so.

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "additional_services": [
    {
      "name": "drop_authorization",
      "properties": {
        "message": "Description about where the package should be left"
      }
    }
  ],
  "carrier": "dpd",
  "create_shipping_label": true
}

Food

This is DPDs offering for sending fresh food.

"DPD Food combines the requirements of online grocery retailing with our digital consignee services. Depending on the foodstuffs involved, three different products are available: DPD Food with a delivery time of 1 to 2 days, DPD Food Express with next-day delivery, and DPD Food 12:00 for delivery by noon the next morning."

Requirements:

service has to be standard, one_day or one_day_early
The sender has to be located in Germany
The recipient has to be located in Germany
The additional service advance_notice (predict) is mandtory
you'll have to use your own contract with the carrier

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "additional_services": [
    {
      "name": "dpd_food"
    },
    {
      "name": "advance_notice",
      "properties": {
        "email": "test@example.com",
        "language": "en"
      }
    }
  ],
  "carrier": "dpd",
  "create_shipping_label": true
}

Hazardous goods

There are a couple of ways one can send hazardous goods. For shipments containing only small amounts of an item (based on the "Dangerous goods list" by the UNECE) you can use the limited quantities as the regulation class.

The additional service can't be combined with the additional service drop_authorization

The additional service is curently in beta. Please contact our customer support if you want to use it.

Requirements:

Senders have to use their own contracts with the carrier
Senders still have to attach an LQ label (LQ mark) to the shipments
Senders have to contact their DPD depot in order for them to activate this option
Senders have to be located in Germany
Recipients have to be located in one of the following countries:
- When using standard as service: AT, BE, CH, DK, DE, ES, FR, HR, LV, LI, LU, MC, NL, PL, PT, SI
- When using one_day as service: AT, BE, CH, DK, DE, FR, LV, LI, LU, MC, NL, PL
- When using one_day_early as service: BE, CH, DE, LU, NL

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "additional_services": [
    {
      "name": "hazardous_goods",
      "regulation_class": "limited_quantities"
    }
  ],
  "carrier": "dpd",
  "service": "one_day",
  "create_shipping_label": true
}

Predict

DPD allows recipients to be notified of a pending delivery within the next hour. The so called predict service can be used with shipcloud by specifying it as an additional service. You can either specify the email address or phone number of your customer to be notified.

Requirements:

service has to be standard

Show notification via email example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "additional_services": [
    {
      "name": "advance_notice",
      "properties": {
        "email": "test@example.com",
        "language": "en"
      }
    }
  ],
  "carrier": "dpd",
  "create_shipping_label": true
}

Show notification via sms example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "additional_services": [
    {
      "name": "advance_notice",
      "properties": {
        "sms": "+4917012345678"
      }
    }
  ],
  "carrier": "dpd",
  "create_shipping_label": true
}

Saturday delivery

When sending packages on a Friday you can specify that they should be delivered on Saturday (if the carrier supports this).

Requirements:

service has to be one_day or one_day_early
you'll have to use your own contract with the carrier

Show example

POST https://api.shipcloud.io/v1/shipments

{
  "from": {
    "first_name": "Serge",
    "last_name": "Sender",
    "company": "Sender Corp.",
    "street": "Sender Str.",
    "street_no": "99",
    "zip_code": "20148",
    "city": "Hamburg",
    "country": "DE"
  },
  "to": {
    "first_name": "Roger",
    "last_name": "Receiver",
    "street": "Receiver Str.",
    "street_no": "1",
    "city": "Hamburg",
    "zip_code": "20535",
    "country": "DE"
  },
  "package": {
    "weight": 0.5,
    "length": 20,
    "width": 15,
    "height": 5,
    "type": "parcel"
  },
  "additional_services": [
    {
      "name": "saturday_delivery"
    }
  ],
  "carrier": "dpd",
  "service": "one_day",
  "create_shipping_label": true
}

Label formats

PDF

DIN A5: pdf_a5
DIN A6: pdf_a6

Misc

Trackers

A tracker can be used for tracking shipments that were created using a tool outside of shipcloud. This way you can get notified of shipment changes, even if your shipping label has been created somewhere else.

You can find all the details in our API reference.

Field lengths

shipments
- company: 1 - 35 characters
- last_name: 1 - 35 characters (firstname + last_name <= 35 characters)
- care_of: 0 - 35 characters
- street: 1 - 35 characters
- street_no: 1 - 8 characters
- zip_code: 1 - 9 characters
- city: 1 - 35 characters
- phone: 0 - 30 characters

Shipment Service V4.3

Services

Standard

Returns

One day

One day early

Package types

Parcel

Parcel letter

Additional services

Drop authorization

Food

Hazardous goods

Predict

Saturday delivery

Label formats

PDF

Misc

Trackers

Field lengths

shipments