To give you a better understanding of how the shipcloud api could be used you can find a few examples on this page. Sometimes there's also a certain chain of calls you need to perform to achieve a specific goal.

Advance notice

Some carriers provide the option to notify the recipient of a shipment of its arrival date and / or time. We currently support advance notices for Cargo International, DHL and DPD. While DHL supports notifications via email DPD also allows the recipient to be notified via SMS. When using Cargo International you only have the option to be notified via a phone call.

Available for the following carriers:

Cash on delivery

When you want your customer to be able to pay the goods directly with the carrier when receiving their shipment you can use the additional service cash on delivery.

Available for the following carriers:

Identity check

If you want the carrier to only deliver the shipment to a specific person are a person of a specific age you can use a variety of identity checking services with the carriers we provide.

You can use the following identity check services:

Order API

The order api allows you to send order data to shipcloud so it can be used for a variety of different use cases within your organization. Within shipcloud you can use it first and foremost for our return portal plus.

Return portal plus

The return portal plus allows your customers to return items to you by giving them the option to select items from an order they've created at your shop. They then can create a returns shipping label for returning items back to you. For this the returns portal will create a shipment that contains the returned items and the reason the customer is returning them.

Data flow

return portal plus data flow

pakadoo

pakadoo is a service that lets you receive personal packages at work. For this a so called pakadoo point is being installed in your companies office rooms. For more information visit http://www.pakadoo.de.

There are 2 ways you can create a shipment that’s going to be send to a pakadoo point:

  • create an address and use the id that’s returned for the address to create a shipment
  • create a shipment by specifying the pakadoo ID in the to address object of the shipments call.

In both cases you can either specify the pakadoo ID as pakadoo_id or you simply use the care_of attribute with "PAK" as a prefix to the pakadoo ID (e.g PAK 5KQTPH5).

Create a pakadoo address and shipment using the pakadoo_id

If the pakadoo user has been identified, shipcloud will return an address object, containing the currently selected delivery address for said pakadoo user.

Create Address Request

/v1/addresses 

{
  "pakadoo_id": "5KQTPH5"
}

Create Address Response 

{
  "id": "71f2522f-be6f-4606-8eda-67997edfe2ac",
  "pakadoo_id": "5KQTPH5",
  "company": "LGI GmbH",
  "street": "Hewlett-Packard-Str.",
  "street_no": "1/1",
  "zip_code": "71083",
  "city": "Herrenberg",
  "country": "DE"
}

Like with every other address you can then use its unique address id to create a new shipment with it.

Create Shipment Request

/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": {
    "id": "71f2522f-be6f-4606-8eda-67997edfe2ac"
  },
  "package": {
    "height": "23",
    "length": "30",
    "width": "20",
    "weight": "1.5",
  },
  "carrier": "dhl",
  "create_shipping_label": true,
  "metadata": {
    "pakadoo": {
      "shop_name": "The shopname",
      "order_number": "123456",
      "order_date": "2015-06-01",
      "e_mail_shop": "user@example.com",
      "order_total": {
        "amount": 42.12,
        "currency": "EUR"
      }
    }
  }
}

Create a shipment using the pakadoo ID in the care_of attribute

You can use this if e.g. you don't want to amend your checkout process. Your customers can use your existing address form to specify the pakadoo point address by entering their pakadoo ID in the care_of field (e.g. PAK 5KQTPH5).

We're checking the care_of attribue for the "PAK" prefix. If it's found, we then check if a valid pakadoo (7 character long) userid is present, validate it using the pakadoo system and return the users' selected pakadoo point address, if available.

Create Shipment Request

/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": {
    "care_of": "PAK 5KQTPH5",
    "company": "LGI GmbH",
    "street": "Hewlett-Packard-Str.",
    "street_no": "1/1",
    "zip_code": "71083",
    "city": "Herrenberg",
    "country": "DE",
  },
  "package": {
    "height": "23",
    "length": "30",
    "width": "20",
    "weight": "1.5",
  },
  "carrier": "dhl",
  "create_shipping_label": true,
  "metadata": {
    "pakadoo": {
      "shop_name": "The shopname",
      "order_number": "123456",
      "order_date": "2015-06-01",
      "e_mail_shop": "user@example.com",
      "order_total": {
        "amount": 42.12,
        "currency": "EUR"
      }
    }
  }
}

Saturday delivery

For carriers who don't support saturday delivery naturally, you will have to specify that delivery on a saturday has to happen.

Available for the following carriers: