GO! @ shipcloud

Services

One day

Express shipment that will be delivered the next working day

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": "go",
  "service": "one_day",
  "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": "go",
  "service": "standard",
  "create_shipping_label": true
}

Additional services

Delivery Date

Requirements:

you’ll have to use your own contract with the carrier
the sender has to be located in Germany
date is mandatory and must not be more than 30 days in the future

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": "delivery_date",
      "properties": {
        "date": "2020-02-19"
      }
    }
  ],
  "carrier": "go",
  "service": "standard",
  "create_shipping_label": true
}

Delivery Note

Requirements:

you’ll have to use your own contract with the carrier
the sender has to be located in Germany
message can contain up to 128 characters, but it is possible that not all characters will be printed on the shipping label

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": "delivery_note",
      "properties": {
        "message": "This is a delivery note"
      }
    }
  ],
  "carrier": "go",
  "service": "standard",
  "create_shipping_label": true
}

Delivery Time

Requirements:

you'll have to use your own contract with the carrier
the sender has to be located in Germany
either time_of_day_earliest or time_of_day_latest MUST be specified

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": "delivery_time",
      "properties": {
          "time_of_day_earliest": "08:00",
          "time_of_day_latest": "09:00"
      }
    }
  ],
  "carrier": "go",
  "service": "standard",
  "create_shipping_label": true
}

Label formats

PDF

DIN A5: pdf_a5

Pickup Requests

Shipments with Pickup Requests

Since GO! doesn't provide regular pickups, you will always have to provide a pickup object, when creating a shipment.

Requirements:

the date for pickup_time.earliest and pickup_time.latest has to be the same
supplying a pickup_address is optional
supplying a package.description is mandatory

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": 1.5,
      "length": 20,
      "width": 20,
      "height": 20,
      "description": "industrial bolts"
  },
  "pickup": {
    "pickup_time": {
      "earliest": "2015-09-15T09:00:00+02:00",
      "latest": "2015-09-15T18:00:00+02:00"
    },
    "pickup_address": {
      "company": "Sender Ltd.",
      "first_name": "Jane",
      "last_name": "Doe",
      "street": "Musterstraße",
      "street_no": "42",
      "zip_code": "54321",
      "city": "Musterstadt",
      "country": "DE"
     }
  },
  "carrier": "go",
  "service": "one_day",
  "create_shipping_label": true
}

Field lengths

last_name: 0 - 60 characters (firstname + last_name <= 60 characters)
company: 2 - 60 characters
care_of: 0 - 40 characters
street: 1 - 35 characters
street_no: 1 - 10 characters
zip_code: 1 - 9 characters
city: 1 - 30 characters
country: 3 characters
phone: 1 - 10 characters

Express Connect

Services

One day

Package types

Parcel

Additional services

Delivery Date

Delivery Note

Delivery Time

Label formats

PDF

Pickup Requests

Shipments with Pickup Requests

Field lengths