- Field names follow Create return shipment:
shipFrom.*isshipment.shipFrom,parcel.*isshipment.parcel, anditems[]isshipment.parcel.items[]. - Weights are in grams and dimensions in centimetres. Lengths are character counts.
- The API orders the three dimensions longest-first before checking, so
lengthis always the longest side. - Truncated to N chars — a longer value is shortened to N characters and the request continues. For a combined limit, characters are removed from the end of the last address line first. Max N chars — a longer value is rejected.
- Every service requires
shipFrom.country,shipFrom.contactName,shipFrom.street1andshipFrom.postalCode. The tables list the rules each service adds. - Optional fields are checked only when sent. Omit an optional field instead of sending an empty string.
United Kingdom
Royal Mail Tracked Returns 48
Service type codes:RETURN_POSTMEN_RM_BIR (Royal Mail Tracked Returns 48), RETURN_RM48_QRCODE_BIR_GBR (Royal Mail Tracked Returns 48 - QR Code)
Parcel constraints:
Item constraints:
DPD
Service type codes:RETURN_GBR_DPD_BIR (DPD), RETURN_DPD_QR_BIR (DPD QR CODE)
Parcel constraints:
Item constraints:
InPost – Locker & Shop Drop-off
Service type code:RETURN_INPOST_QR_BIR
Parcel constraints:
Germany
DHL
Service type code:sdhl
DHL Retoure
Service type codes:RETURN_DHL_ECOMMERCE_DEU (DHL Retoure), RETURN_DHL_ECOMMERCE_INTL_DEU (DHL Retoure International)
No field may contain the | character.
Parcel constraints:
Item constraints:
France
Mondial Relay
Service type codes:RETURN_MONDIALRELAY_FRA (Mondial Relay- Dropoff), RETURN_MONDIALRELAY_EU_FRA (Mondial Relay EU- Dropoff)
Parcel constraints:
Item constraints:
United States
FedEx Ground
Service type codes:fedex_ground (Fedex Ground-NJ), RETURN_FEDEX_GROUND_WA (Fedex Ground-WA), RETURN_FEDEX_GROUND_USCA (FedEx Ground-CA), RETURN_FEDEX_GROUND_TX (FedEx Ground-TX)
Parcel constraints:
Item constraints:
USPS
Length + girth = longest side + 2 × the other two sides.
Parcel constraints:
Canada
Canada Post
Service type code:ubi_ca
Parcel constraints:
Australia
AU Post
Service type code:ubi_au
Parcel constraints:
Hong Kong
SF Express
Service type codes:sf_hk (SF Express), RETURN_SF_EXPRESS_XB_HKG (SF Express Macao-HK)
Parcel constraints:
Item constraints:
DHL Express Worldwide (to Hong Kong)
Service type code:RETURN_SPACESHIP_DHL (DHL- Express Worldwide)
Parcel constraints:
Item constraints:
FedEx International Economy (to Hong Kong)
Service type code:RETURN_SPACESHIP_FEDEX (Fedex- International Economy)
Parcel constraints:
Item constraints:
UPS Worldwide Express Saver (to Hong Kong)
Service type code:RETURN_UPS_SV_HKG (UPS Worldwide Express Saver)
Parcel constraints:
Item constraints:
Japan
Sagawa Express
Service type code:RETURN_SAGAWA_EXPR_JPN
Parcel constraints:
DHL Express Worldwide (to Japan and Singapore)
Service type codes:RETURN_DHL_WPX_PHY_DROP_JPN (DHL Express Worldwide-JP (Physical Label)-Drop Off), RETURN_DHL_WPX_QR_DROP_JPN (DHL Express Worldwide-JP (QR Code)-Drop Off), RETURN_DHL_WPX_PHY_DROP_SGP (DHL Express Worldwide-SG (Physical Label)-Drop Off), RETURN_DHL_WPX_QR_DROP_SGP (DHL Express Worldwide-SG (QR Code)-Drop Off)
Parcel constraints:
Item constraints:
Singapore
SingPost
Service type code:RETURN_SGPPOST_EZY2SHIP
Parcel constraints:
Item constraints:
J&T Express – Drop-off (Point to Door)
Service type code:RETURN_JNT_PUDO_SG
Parcel constraints:
Item constraints:
DHL Express Worldwide (to Singapore)
See DHL Express Worldwide (to Japan and Singapore).Taiwan
Yamato
Service type code:RETURN_YAMATO_TWN
Parcel constraints:
Item constraints:
Malaysia
DHL eCommerce
Service type code:RETURN_DHL_ECOMMERC_MYS
Item constraints:
United Arab Emirates
EMX
Service type code:RETURN_EMX_ARE
Parcel constraints:
Item constraints: