Ship Webservice

Services

Standard

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

One day

Express shipment that will be delivered the next working day

One day early

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

Returns

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

Requirements:

  • the parameter package.description is mandatory

Expedited

If you want to send less urgent shipments to destinations outside of Europe you can use the UPS service expedited to reach more than 220 countries and territories.

Requirements:

  • description is mandatory
  • service has to be ups_expedited
  • The recipient has to be located outside of the EU, Liechtenstein, Norway or Switzerland

Express 12:00

The UPS service Express 12:00 ensures a next business day delivery by noon throughout the country.

Requirements:

  • The sender and recipient have to be located in Germany
  • service has to be ups_express_1200
  • Label size can be A5 & A6

Package types

Parcel

The most basic package type for shipping parcels there is.

Additional services

Carbon neutral

For climate friendly shipping you can use the additional service carbon neutral. "UPS's carbon neutral option supports projects that offset the emissions of the shipment's transport."

Requirements:

  • service has to be standard, one_day, one_day_early, returns, ups_expedited or ups_express_1200
  • you'll have to use your own contract with the carrier

Cash on delivery

Requirements:

  • only collection of cash is available for now, no collection of checks
  • you'll have to use your own contract with the carrier
  • available for shipments within the European Union and Switzerland

Adult signature

When sending packages via UPS you can specify that the receiver needs to be an adult, and prove the fact with his or her signature.

Requirements:

  • you'll have to use your own contract with the carrier

Saturday delivery

Requirements:

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

Direct delivery only

To make sure that a shipment only gets delivered to the address provided you can use the additional service direct delivery only.

Direct Delivery Only ensures that a package is delivered to the residential or commercial address you provide. This service stops recipients from redirecting packages and prevents our drivers from rerouting deliveries when recipients are not at home, that includes UPS Access Points.

Requirements:

  • service has to be standard, one_day, one_day_early, ups_express_1200 or ups_expedited
  • you'll have to use your own contract with the carrier

Signature required

When sending packages with the UPS additional service signature required you can make sure that the receiver needs to supply a signature upon receiving the shipment.

Requirements:

  • service has to be standard, one_day, one_day_early, ups_express_1200 or ups_expedited
  • you'll have to use your own contract with the carrier

Other attributes

Billing options

Using the billing_options attribut, you can determine who is responsible for paying for transportation and/or duties and taxes for a given shipment.

The following options are available:

  • sender, the sender of the shipment will pay
  • receiver, the receiver of the shipment will pay
  • third_party, a third party will pay

Requirements:

  • You'll have to use your own UPS contract
  • When receiver or third_party has to pay, you will have to provide the attributes account_number, zip_code and country
  • Determining who will pay for transportation is applicable for domestic and international shipments
  • Determining who will pay for duties_and_taxes is only applicable for international shipments

Common use cases:

Transportation charges Duties and taxes String on label Description
Sender - P/P Shipper pays transportation charges (also referred to as "Prepaid")
Sender Sender F/D Shipper pays all charges (also referred to as "Free Domicile")
Sender Third party P/P TPR + Acc# + ISO-Code Shipper pays transportation charges; a third party (could be in another country) pays the duties and taxes
Receiver - F/C BILL RECEIVER + Acc# + ISO-Code Receiver pays transportation charges
Receiver Receiver F/C RECEIVER + Acc# Receiver pays all charges (also referred to as "Freight Collect")
Third Party - P/P TPS + Acc# + ISO-Code A third party pays transportation charges
Third Party Third Party F/D TPS + Acc# + ISO-Code A third party pays all charges

Customs declaration

If you want to send a shipment to a country where a customs declaration is necessary you can specify this the following way. Detailed information about the parameters can be found in our documentation of creating a shipment.

Requirements:

  • description is mandatory
  • customs_declaration.currency has to be EUR

Declared value

By using UPS declared value you can insure your parcel beyond the usual liability limits of EUR 510.

Caution:
  • Additional fees will be charged by UPS. Check your UPS contract or ask your account manager to get a quote.
  • You shouldn't specify "declared_value" when creating a shipment up to EUR 510 or lesser value unless you actually want the insurance instead of the liability.

Requirements:

  • You'll have to use your own UPS contract

Label formats

PDF

  • DIN A5: pdf_a5
  • DIN A6: pdf_a6

ZPL

  • ZPL2 4x6in 203dpi: zpl2_4x6in_203dpi
  • ZPL2 4x8in 203dpi: zpl2_4x8in_203dpi

Misc

Access point delivery

When using UPS as a carrier it is possible to let shipments be delivered to a UPS access point. This way recipients do not have to be at home for receiving their shipments but can collect them from the access point at a later time.

Requirements:

  • the recipients address has to be provided as you normally would using the to attribute
  • to.first_name is manadatory
  • to.last_name is manadatory
  • to.email is manadatory
  • drop_off_point.drop_off_point_id is manadatory and has to be 9 characters long (can be determined through our pudo provider)
  • the attribute drop_off_point.type has to be parcel_shop

Cutoff times

When requesting a pickup by UPS, the carrier is validating your request if it's possible for them to reach you within the requested time period. This validation factors in if there is enough time for the driver to come to you and how far their depot is located from you.

UPS also has a list of cutoff times for postcodes in Germany, you can find within a service pdf which is provided as a download on the UPS website.

Rules

  • If one of the following conditions is true, the parameter description is mandatory:
    • from and to countries are not the same
    • from and/or to countries are not in the EU
    • from and to countries are in the EU and the shipments service is not standard

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 (only 30 characters will be printed on the label)
    • last_name: 1 - 35 characters (firstname + last_name <= 35 characters - only 30 characters will be printed on the label)
    • care_of: 0 - 35 characters (only 30 characters will be printed on the label)
    • street: 1 - 35 characters (street + street_no <= 35 characters - only 30 characters will be printed on the label)
    • zip_code: 1 - 9 characters
    • city: 1 - 30 characters (only 15 characters will be printed on the label)
    • state: 2 characters
    • phone: 0 - 15 characters
    • reference_number: 0 - 35 characters
  • pickup requests

    • company: 27 characters
    • last_name: 22 characters (firstname + last_name <= 22 characters)
    • street: 1 - 73 characters (street + street_no <= 73 characters)
    • zip_code: 1 - 8 characters
    • city: 1 - 50 characters
    • state: 0 - 50 characters