shipcloud
Purpose
This connection buys labels through the shipcloud shipping platform from inside the shipping process. shipcloud is an aggregator: one account books with DHL, DPD, UPS, Hermes, GLS and other carriers — which one is given by the product in the form carrier:service, for example dhl:standard or ups:one_day.
Scope
- Age verification (visual check from 16 or 18) for articles with an age limit — as the additional
service visual_age_check; shipcloud offers it through DHL only, so a product of another carrier is refused.
- Create labels as PDF or ZPL — the format is set by the integration, not by the shipment.
- Choose the product: on the shipment (shipping method field) or as the integration default;
dhl
alone means dhl:standard. Without either, no label is created.
- Return labels through shipcloud's returns service, customs data for third-country shipments.
- Cancellation: shipcloud deletes the shipment until the carrier's cut-off; after that the refusal
comes back with its reason, not as a success.
- Tracking with status mapping.
Additional services and delivery locations
What is possible depends on the carrier of the product — the connection checks it before booking and refuses with the reason instead of buying a label without the service. Booked in the Ship dialog of shipping.
| Service | Carriers | Condition |
|---|---|---|
| Cash on delivery | DHL, GLS, Hermes, UPS | DHL and Hermes only within Germany, GLS Germany and Austria; with DHL the brand's bank account is the payout account |
| Higher insurance | DHL, UPS | goods value as declared_value |
| Age verification | DHL | visual check from 16 or 18 |
| Packstation, post office | DHL | with the recipient's post number |
| Parcel shop | GLS, Hermes | with GLS, the recipient's e-mail address for the notification |
| Access point | UPS | with the recipient's e-mail address |
Amounts go out in euros; a foreign currency is converted by shipping at the rate frozen on the order.
Setup
Credentials live as an integration under Integrations — provider shipcloud.
| Setting | Required | Meaning |
|---|---|---|
shipcloud_api_key | yes | API key. Stored encrypted and never shown again. The key decides test or live mode: a sandbox key buys no real labels. |
default_product | no | Product when the shipment names none, e.g. dhl:standard. |
label_format | no | shipcloud label format, e.g. pdf_a6 or zpl2_4x6in_203dpi; empty = carrier default. |
default_package | no | Default dimensions in centimetres (length, width, height) for parcels without their own. |
sender | no | Sender address in shipcloud field names; empty = default sender of the account. |
The module is switched off by default and is switched on under the feature flags.
Product selection
The connection itself tells which products the account may book: GET /v1/carrier-shipcloud/products returns the code (code), display name and label formats per carrier and service. The code is exactly the value that goes onto the shipment as shipping method. In the interface the same list sits under Settings → Shipping → shipcloud products (permission shipping.shipment.manage or shipping.config.manage) — with carrier, service, code to copy and label formats. If the integration is not set up yet, the card says so and leads to the integrations.
Settings & permissions
- Creating the integration and entering the key requires
platform.integration.manage. - The product selection is visible to whoever ships (
shipping.shipment.manage) or sets up shipping
(shipping.config.manage).
- Shipping uses the permissions of Shipping; the connection brings no
permissions of its own.
Interplay
The connection sits inside Shipping: that is where the shipment is created, where the label is bought and where tracking runs. shipcloud keeps the label on a server of its own; it is fetched without credentials and only from exactly that server. In the integration hub, the "Create label" step registers the shipment through our own interface. When a label is produced is decided by automations.
Limits
- The real run is still outstanding. What is verified is that we ask correctly and read the answer
correctly — with prepared responses. That shipcloud accepts the request is not proven.
- One parcel per shipment, and shipcloud requires length, width and height — without dimensions
only with the integration's default dimensions.
- Additional services only where shipcloud carries them per carrier — for example no cash on
delivery through DPD and no higher insurance through GLS or Hermes; the pre-check refuses such bookings.
- Prices do not come from here — they are in the contract with shipcloud.