Action Documentation
POST - api/shipment
Book a shipment
Body Models
ShipmentBookingRequest
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Pieces | array of Piece |
must not be empty. The specified condition was not met for . |
|
| ReadyByDate | date | DateTime provided must included the Time and be in GMT format. |
must not be empty. must be greater than or equal to . |
| Hawb | string | The Hawb (House Airway Bill) is your own unique reference number for the shipment, for example it could be the order reference. |
must not be empty. |
| Description | string |
must be between 0 and 90 characters. must not be empty. |
|
| Value | decimal number | Total value of the shipment (ex. VAT) |
must not be empty. must not be empty. |
| Currency | string | Currency of the shipment value as a three letter ISO code. If left unspecified then GBP will be used. |
Currency Code must be a valid three letter ISO code |
| NonDox | boolean | Uses to indicate of the shipment is documents or non-documents. | |
| DDP | boolean | ||
| Pallet | boolean | ||
| Invoice | string | Optional - Base64 string can be provided to use PLT services with DHL for select countries. | |
| Requestor | Requester | The customer the shipment is being made on behalf of. | |
| Consignee | Address | The destination of the shipment |
must not be empty. |
| Collection | CollectionAddress | Pickup address required for collection services. | |
| Shipper | ShipperAddress | Shipper address | |
| Service | Service |
must not be empty. |
|
| Specials | Specials | Optional - Additional special enhancements to the shipment, e.g. Timed Delivery, Dangerous Goods | |
| Picking | Picking | Optional - Only used for picking | |
| LabelFormat | string of "Pdf, Epl, Png, Zpl" | Format of labels defaults to PDF | |
| Site | SiteDetails | (optional) Location the shipment is being booked from | |
| ExportCustoms | ExportCustoms |
must not be empty. |
|
| CustomDeclarations | Declarations | Optional - Additional declarations for customs purposes | |
| LabelSize | string of "A4, FourBySix, FourByEight" | Size of labels defaults to 4x6. |
Piece
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Depth | decimal number | The depth/length specified in CM |
must not be empty. must be greater than 0. |
| Height | decimal number | The height specified in CM |
must not be empty. must be greater than 0. |
| Width | decimal number | The width specified in CM |
must not be empty. must be greater than 0. |
| Weight | decimal number | The weight specified in KG |
must not be empty. must be greater than 0. must not be empty. must be less than or equal to 1000. |
| NumberOfPieces | integer | The number of packages with the same dimensions |
must not be empty. must be greater than 0. |
| Products | array of Product | Product detail list in a Piece |
Product
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| ProductDescription | string |
must not be empty. must be between 2 and 150 characters. |
|
| CountryOfManufacture | string | Country of manufacture specifed as a two letter ISO code |
must not be empty. Country Code must be a valid two letter ISO code |
| HSCode | string | ||
| ProductUnitValue | decimal number |
must be greater than 0. |
|
| Currency | string | If left unspecified then GBP will be used. |
Currency Code must be a valid three letter ISO code |
| ProductUnitWeight | decimal number | Product weight specified in KG |
must be greater than 0. must be less than or equal to 1000. |
| ProductQuantity | integer |
must be greater than 0. |
Requester
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Name | string | ||
| PhoneNumber | string |
Address
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| VAT | string | Optional |
must be between 2 and 15 characters. The specified condition was not met for . |
| EORI | string | Optional |
must be between 0 and 17 characters. The specified condition was not met for . |
| TaxId | string | Optional |
must be between 0 and 20 characters. The specified condition was not met for . |
| ContactName | string |
must not be empty. must be between 2 and 35 characters. |
|
| Company | string |
must be between 0 and 35 characters. |
|
| Address1 | string |
must not be empty. must be between 2 and 45 characters. |
|
| Address2 | string |
must be between 0 and 45 characters. |
|
| Address3 | string |
must be between 0 and 45 characters. |
|
| City | string |
must not be empty. must be between 2 and 35 characters. |
|
| Division | string |
must be between 0 and 35 characters. |
|
| string |
must be between 0 and 50 characters. is not a valid email address. |
||
| DivisionCode | string | ||
| PhoneNumber | string |
must be between 0 and 20 characters. |
|
| Fax | string | ||
| Zipcode | string |
must not be empty. must be between 3 and 12 characters. |
|
| MobileNumber | string | ||
| CountryCode | string | Country specifed as a two letter ISO code |
must not be empty. Country Code must be a valid two letter ISO code |
CollectionAddress
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| PackageLocation | string |
must not be empty. |
|
| CloseTime | LocalTime | Time the collection location closes specifed as 24 hour time in format hh:mm |
must not be empty. |
| PickupType | string of "Pickup" | ||
| ContactName | string |
must not be empty. must be between 2 and 35 characters. |
|
| Company | string |
must be between 0 and 35 characters. |
|
| Address1 | string |
must not be empty. must be between 2 and 45 characters. |
|
| Address2 | string |
must be between 0 and 45 characters. |
|
| Address3 | string |
must be between 0 and 45 characters. |
|
| City | string |
must not be empty. must be between 2 and 35 characters. |
|
| Division | string |
must be between 0 and 35 characters. |
|
| string |
must be between 0 and 50 characters. is not a valid email address. |
||
| DivisionCode | string | ||
| PhoneNumber | string |
must be between 0 and 20 characters. |
|
| Fax | string | ||
| Zipcode | string |
must not be empty. must be between 3 and 12 characters. |
|
| MobileNumber | string | ||
| CountryCode | string | Country specifed as a two letter ISO code |
must not be empty. Country Code must be a valid two letter ISO code |
ShipperAddress
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| IOSS | string | Government Issued IOSS Number, used for shipping to the EU with shipments under 150EUR. |
must be 12 characters in length. The specified condition was not met for . The specified condition was not met for . |
| VAT | string | Optional |
must be between 2 and 15 characters. The specified condition was not met for . |
| EORI | string | Optional |
must be between 0 and 17 characters. The specified condition was not met for . |
| TaxId | string | Optional |
must be between 0 and 20 characters. The specified condition was not met for . |
| ContactName | string |
must not be empty. must be between 2 and 35 characters. |
|
| Company | string |
must be between 0 and 35 characters. |
|
| Address1 | string |
must not be empty. must be between 2 and 45 characters. |
|
| Address2 | string |
must be between 0 and 45 characters. |
|
| Address3 | string |
must be between 0 and 45 characters. |
|
| City | string |
must not be empty. must be between 2 and 35 characters. |
|
| Division | string |
must be between 0 and 35 characters. |
|
| string |
must be between 0 and 50 characters. is not a valid email address. |
||
| DivisionCode | string | ||
| PhoneNumber | string |
must be between 0 and 20 characters. |
|
| Fax | string | ||
| Zipcode | string |
must not be empty. must be between 3 and 12 characters. |
|
| MobileNumber | string | ||
| CountryCode | string | Country specifed as a two letter ISO code |
must not be empty. Country Code must be a valid two letter ISO code |
Service
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Code | string |
must not be empty. Service Code is not valid |
|
| Enhancements | array of Enhancement |
The specified condition was not met for . |
|
| Supplier | string | Optional preferred supplier code | |
| Route | string | Optional routing code |
Enhancement
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Code | string |
Specials
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| TimedDelivery | string of "None, Pre9, Pre12" |
Picking
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Instructions | string | Instructions to be added to picking label |
SiteDetails
Location the shipment is being booked from
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Location | string | (optional) Location code such as airport code | |
| ContainerReference | string | (optional) A reference to a container the shipment is intended to arrive in |
ExportCustoms
Invoice Information
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| InvoiceNumber | string |
must not be empty. |
|
| PayeeOfGST | string |
must be between 1 and 35 characters. |
|
| InvoiceType | string of "Proforma, Commercial" | ||
| TermsOfPayment | string |
The specified condition was not met for . must not be empty. |
|
| CurrencyCode | string |
Currency Code must be a valid three letter ISO code |
|
| TypeOfExport | string of "Permanent, Temporary, Gift, Repair, Sample, Return, InterCompanyData, Others" | ||
| TermsOfTrade | string |
The specified condition was not met for . must not be empty. |
|
| InvoiceConsignee | string |
must be between 1 and 35 characters. |
Declarations
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| PreferentialOrigin | string |
Country Code must be a valid two letter ISO code |
|
| TransportationCost | Money | ||
| FreightCost | Money |
Money
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Value | decimal number | ||
| Currency | string |
Options For Select Fields
CountryCode
| AF | AFGHANISTAN | Requires PLT for DHL |
| AL | ALBANIA | Requires PLT for DHL |
| DZ | ALGERIA | Requires PLT for DHL |
| AS | AMERICAN SAMOA | Requires PLT for DHL |
| AD | ANDORRA | Requires PLT for DHL |
| AO | ANGOLA | Requires PLT for DHL |
| AI | ANGUILLA | Requires PLT for DHL |
| AQ | ANTARCTICA | Requires PLT for DHL |
| AG | ANTIGUA AND BARBUDA | Requires PLT for DHL |
| AR | ARGENTINA | Requires PLT for DHL |
| AM | ARMENIA | Requires PLT for DHL |
| AW | ARUBA | Requires PLT for DHL |
| AU | AUSTRALIA | Requires PLT for DHL |
| AT | AUSTRIA | Requires PLT for DHL |
| AZ | AZERBAIJAN | Requires PLT for DHL |
| BS | BAHAMAS | Requires PLT for DHL |
| BH | BAHRAIN | Requires PLT for DHL |
| BD | BANGLADESH | Requires PLT for DHL |
| BB | BARBADOS | Requires PLT for DHL |
| BY | BELARUS | Requires PLT for DHL |
| BE | BELGIUM | Requires PLT for DHL |
| BZ | BELIZE | Requires PLT for DHL |
| BJ | BENIN | Requires PLT for DHL |
| BM | BERMUDA | Requires PLT for DHL |
| BT | BHUTAN | Requires PLT for DHL |
| BO | BOLIVIA | Requires PLT for DHL |
| BA | BOSNIA AND HERZEGOVINA | Requires PLT for DHL |
| BW | BOTSWANA | Requires PLT for DHL |
| BV | BOUVET ISLAND | Requires PLT for DHL |
| BR | BRAZIL | Requires PLT for DHL |
| IO | BRITISH INDIAN OCEAN TERRITORY | Requires PLT for DHL |
| BN | BRUNEI DARUSSALAM | Requires PLT for DHL |
| BG | BULGARIA | Requires PLT for DHL |
| BF | BURKINA FASO | Requires PLT for DHL |
| BI | BURUNDI | Requires PLT for DHL |
| KH | CAMBODIA | Requires PLT for DHL |
| CM | CAMEROON | Requires PLT for DHL |
| CA | CANADA | Requires PLT for DHL |
| CV | CAPE VERDE | Requires PLT for DHL |
| KY | CAYMAN ISLANDS | Requires PLT for DHL |
| CF | CENTRAL AFRICAN REPUBLIC | Requires PLT for DHL |
| TD | CHAD | Requires PLT for DHL |
| CL | CHILE | Requires PLT for DHL |
| CN | CHINA | Requires PLT for DHL |
| CX | CHRISTMAS ISLAND | Requires PLT for DHL |
| CC | COCOS (KEELING,NULL) ISLANDS | Requires PLT for DHL |
| CO | COLOMBIA | Requires PLT for DHL |
| KM | COMOROS | Requires PLT for DHL |
| CG | CONGO | Requires PLT for DHL |
| CD | CONGO, DEMOCRATIC REPUBLIC | Requires PLT for DHL |
| CK | COOK ISLANDS | Requires PLT for DHL |
| CR | COSTA RICA | Requires PLT for DHL |
| CI | IVORY COAST | Requires PLT for DHL |
| HR | CROATIA | Requires PLT for DHL |
| CU | CUBA | Requires PLT for DHL |
| CY | CYPRUS | Requires PLT for DHL |
| CZ | CZECH REPUBLIC | Requires PLT for DHL |
| DK | DENMARK | Requires PLT for DHL |
| DJ | DJIBOUTI | Requires PLT for DHL |
| DM | DOMINICA | Requires PLT for DHL |
| DO | DOMINICAN REPUBLIC | Requires PLT for DHL |
| EC | ECUADOR | Requires PLT for DHL |
| EG | EGYPT | Requires PLT for DHL |
| SV | EL SALVADOR | Requires PLT for DHL |
| GQ | EQUATORIAL GUINEA | Requires PLT for DHL |
| ER | ERITREA | Requires PLT for DHL |
| EE | ESTONIA | Requires PLT for DHL |
| ET | ETHIOPIA | Requires PLT for DHL |
| FK | FALKLAND ISLANDS | Requires PLT for DHL |
| FO | FAROE ISLANDS | Requires PLT for DHL |
| FJ | FIJI | Requires PLT for DHL |
| FI | FINLAND | Requires PLT for DHL |
| FR | FRANCE | Requires PLT for DHL |
| GF | FRENCH GUIANA | Requires PLT for DHL |
| PF | FRENCH POLYNESIA | Requires PLT for DHL |
| TF | FRENCH SOUTHERN TERRITORIES | Requires PLT for DHL |
| GA | GABON | Requires PLT for DHL |
| GM | GAMBIA | Requires PLT for DHL |
| GE | GEORGIA | Requires PLT for DHL |
| DE | GERMANY | Requires PLT for DHL |
| GH | GHANA | Requires PLT for DHL |
| GI | GIBRALTAR | Requires PLT for DHL |
| GR | GREECE | Requires PLT for DHL |
| GL | GREENLAND | Requires PLT for DHL |
| GD | GRENADA | Requires PLT for DHL |
| GP | GUADELOUPE | Requires PLT for DHL |
| GU | GUAM | Requires PLT for DHL |
| GT | GUATEMALA | Requires PLT for DHL |
| GN | GUINEA | Requires PLT for DHL |
| GW | GUINEA-BISSAU | Requires PLT for DHL |
| GY | GUYANA | Requires PLT for DHL |
| HT | HAITI | Requires PLT for DHL |
| HM | HEARD ISLAND AND MCDONALD ISLANDS | Requires PLT for DHL |
| VA | VATICAN CITY | Requires PLT for DHL |
| HN | HONDURAS | Requires PLT for DHL |
| HK | HONG KONG | Requires PLT for DHL |
| HU | HUNGARY | Requires PLT for DHL |
| IS | ICELAND | Requires PLT for DHL |
| IN | INDIA | Requires PLT for DHL |
| ID | INDONESIA | Requires PLT for DHL |
| IR | IRAN, ISLAMIC REPUBLIC OF | Requires PLT for DHL |
| IQ | IRAQ | Requires PLT for DHL |
| IE | IRELAND | Requires PLT for DHL |
| IL | ISRAEL | Requires PLT for DHL |
| IT | ITALY | Requires PLT for DHL |
| JM | JAMAICA | Requires PLT for DHL |
| JP | JAPAN | Requires PLT for DHL |
| JO | JORDAN | Requires PLT for DHL |
| KZ | KAZAKHSTAN | Requires PLT for DHL |
| KE | KENYA | Requires PLT for DHL |
| KI | KIRIBATI | Requires PLT for DHL |
| KP | KOREA, DEMOCRATIC PEOPLES REPUBLIC | Requires PLT for DHL |
| KR | KOREA, REPUBLIC OF | Requires PLT for DHL |
| KW | KUWAIT | Requires PLT for DHL |
| KG | KYRGYZSTAN | Requires PLT for DHL |
| LA | LAO PEOPLES DEMOCRATIC REPUBLIC | Requires PLT for DHL |
| LV | LATVIA | Requires PLT for DHL |
| LB | LEBANON | Requires PLT for DHL |
| LS | LESOTHO | Requires PLT for DHL |
| LR | LIBERIA | Requires PLT for DHL |
| LY | LIBYA | Requires PLT for DHL |
| LI | LIECHTENSTEIN | Requires PLT for DHL |
| LT | LITHUANIA | Requires PLT for DHL |
| LU | LUXEMBOURG | Requires PLT for DHL |
| MO | MACAU | Requires PLT for DHL |
| MK | NORTH MACEDONIA | Requires PLT for DHL |
| MG | MADAGASCAR | Requires PLT for DHL |
| MW | MALAWI | Requires PLT for DHL |
| MY | MALAYSIA | Requires PLT for DHL |
| MV | MALDIVES | Requires PLT for DHL |
| ML | MALI | Requires PLT for DHL |
| MT | MALTA | Requires PLT for DHL |
| MH | MARSHALL ISLANDS | Requires PLT for DHL |
| MQ | MARTINIQUE | Requires PLT for DHL |
| MR | MAURITANIA | Requires PLT for DHL |
| MU | MAURITIUS | Requires PLT for DHL |
| YT | MAYOTTE | Requires PLT for DHL |
| MX | MEXICO | Requires PLT for DHL |
| FM | MICRONESIA | Requires PLT for DHL |
| MD | MOLDOVA | Requires PLT for DHL |
| MC | MONACO | Requires PLT for DHL |
| MN | MONGOLIA | Requires PLT for DHL |
| MS | MONTSERRAT | Requires PLT for DHL |
| MA | MOROCCO | Requires PLT for DHL |
| MZ | MOZAMBIQUE | Requires PLT for DHL |
| MM | MYANMAR | Requires PLT for DHL |
| NA | NAMIBIA | Requires PLT for DHL |
| NR | NAURU | Requires PLT for DHL |
| NP | NEPAL | Requires PLT for DHL |
| NL | NETHERLANDS | Requires PLT for DHL |
| XC | CURACAO | Requires PLT for DHL |
| NC | NEW CALEDONIA | Requires PLT for DHL |
| NZ | NEW ZEALAND | Requires PLT for DHL |
| NI | NICARAGUA | Requires PLT for DHL |
| NE | NIGER | Requires PLT for DHL |
| NG | NIGERIA | Requires PLT for DHL |
| NU | NIUE | Requires PLT for DHL |
| NF | NORFOLK ISLAND | Requires PLT for DHL |
| MP | NORTHERN MARIANA ISLANDS | Requires PLT for DHL |
| NO | NORWAY | Requires PLT for DHL |
| OM | OMAN | Requires PLT for DHL |
| PK | PAKISTAN | Requires PLT for DHL |
| PW | PALAU | Requires PLT for DHL |
| PS | PALESTINIAN OCCUPIED TERRITORY | Requires PLT for DHL |
| PA | PANAMA | Requires PLT for DHL |
| PG | PAPUA NEW GUINEA | Requires PLT for DHL |
| PY | PARAGUAY | Requires PLT for DHL |
| PE | PERU | Requires PLT for DHL |
| PH | PHILIPPINES | Requires PLT for DHL |
| PN | PITCAIRN | Requires PLT for DHL |
| PL | POLAND | Requires PLT for DHL |
| PT | PORTUGAL | Requires PLT for DHL |
| PR | PUERTO RICO | Requires PLT for DHL |
| QA | QATAR | Requires PLT for DHL |
| RE | REUNION | Requires PLT for DHL |
| RO | ROMANIA | Requires PLT for DHL |
| RU | RUSSIAN FEDERATION | Requires PLT for DHL |
| RW | RWANDA | Requires PLT for DHL |
| SH | SAINT HELENA | Requires PLT for DHL |
| KN | SAINT KITTS AND NEVIS | Requires PLT for DHL |
| LC | SAINT LUCIA | Requires PLT for DHL |
| PM | SAINT PIERRE AND MIQUELON | Requires PLT for DHL |
| VC | SAINT VINCENT AND THE GRENADINES | Requires PLT for DHL |
| WS | SAMOA | Requires PLT for DHL |
| SM | SAN MARINO | Requires PLT for DHL |
| ST | SAO TOME AND PRINCIPE | Requires PLT for DHL |
| SA | SAUDI ARABIA | Requires PLT for DHL |
| SN | SENEGAL | Requires PLT for DHL |
| RS | SERBIA | Requires PLT for DHL |
| SC | SEYCHELLES | Requires PLT for DHL |
| SL | SIERRA LEONE | Requires PLT for DHL |
| SG | SINGAPORE | Requires PLT for DHL |
| SK | SLOVAKIA | Requires PLT for DHL |
| SI | SLOVENIA | Requires PLT for DHL |
| SB | SOLOMON ISLANDS | Requires PLT for DHL |
| SO | SOMALIA | Requires PLT for DHL |
| ZA | SOUTH AFRICA | Requires PLT for DHL |
| GS | SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS | Requires PLT for DHL |
| ES | SPAIN | Requires PLT for DHL |
| LK | SRI LANKA | Requires PLT for DHL |
| SD | SUDAN | Requires PLT for DHL |
| SR | SURINAME | Requires PLT for DHL |
| SJ | SVALBARD AND JAN MAYEN | Requires PLT for DHL |
| SZ | SWAZILAND | Requires PLT for DHL |
| SE | SWEDEN | Requires PLT for DHL |
| CH | SWITZERLAND | Requires PLT for DHL |
| SY | SYRIAN ARAB REPUBLIC | Requires PLT for DHL |
| TW | TAIWAN | Requires PLT for DHL |
| TJ | TAJIKISTAN | Requires PLT for DHL |
| TZ | TANZANIA | Requires PLT for DHL |
| TH | THAILAND | Requires PLT for DHL |
| TL | TIMOR-LESTE | Requires PLT for DHL |
| TG | TOGO | Requires PLT for DHL |
| TK | TOKELAU | Requires PLT for DHL |
| TO | TONGA | Requires PLT for DHL |
| TT | TRINIDAD AND TOBAGO | Requires PLT for DHL |
| TN | TUNISIA | Requires PLT for DHL |
| TR | TURKEY | Requires PLT for DHL |
| TM | TURKMENISTAN | Requires PLT for DHL |
| TC | TURKS AND CAICOS ISLANDS | Requires PLT for DHL |
| TV | TUVALU | Requires PLT for DHL |
| UG | UGANDA | Requires PLT for DHL |
| UA | UKRAINE | Requires PLT for DHL |
| AE | UNITED ARAB EMIRATES | Requires PLT for DHL |
| GB | UNITED KINGDOM | N/A |
| US | UNITED STATES | Requires PLT for DHL |
| UM | UNITED STATES MINOR OUTLYING ISLANDS | Requires PLT for DHL |
| UY | URUGUAY | Requires PLT for DHL |
| UZ | UZBEKISTAN | Requires PLT for DHL |
| VU | VANUATU | Requires PLT for DHL |
| VE | VENEZUELA | Requires PLT for DHL |
| VN | VIETNAM | Requires PLT for DHL |
| VG | VIRGIN ISLANDS, BRITISH | Requires PLT for DHL |
| VI | VIRGIN ISLANDS, U.S. | Requires PLT for DHL |
| WF | WALLIS AND FUTUNA | Requires PLT for DHL |
| EH | WESTERN SAHARA | Requires PLT for DHL |
| YE | YEMEN | Requires PLT for DHL |
| ZM | ZAMBIA | Requires PLT for DHL |
| ZW | ZIMBABWE | Requires PLT for DHL |
| KV | KOSOVO | Requires PLT for DHL |
| ME | MONTENEGRO | Requires PLT for DHL |
| UI | CHANNEL ISLANDS | Requires PLT for DHL |
| XY | SAINT BARTHELEMEY | Requires PLT for DHL |
| IC | CANARY ISLANDS | Requires PLT for DHL |
| IM | ISLE OF MAN | Requires PLT for DHL |
| XM | ST MAARTEN | Requires PLT for DHL |
| XS | SOMALILAND | Requires PLT for DHL |
| SS | SOUTH SUDAN | Requires PLT for DHL |
| XB | BONAIRE | Requires PLT for DHL |
| GG | GUERNSEY | Requires PLT for DHL |
| JE | JERSEY | Requires PLT for DHL |
| MF | SAINT MARTIN | Requires PLT for DHL |
CurrencyCode
| AED | United Arab Emirates, Dirhams | |
| AFA | Afghanistan, Afghanis | |
| ALL | Albania, Leke | |
| AMD | Armenia, Drams | |
| ANG | Netherlands Antilles, Guilders (also called Florins) | |
| AOA | Angola, Kwanza | |
| ARS | Argentina, Pesos | |
| AUD | Australia, Dollars | |
| AWG | Aruba, Guilders (also called Florins) | |
| AZM | Azerbaijan, Manats | |
| BAM | Bosnia and Herzegovina, Convertible Marka | |
| BBD | Barbados, Dollars | |
| BDT | Bangladesh, Taka | |
| BGN | Bulgaria, Leva | |
| BHD | Bahrain, Dinars | |
| BIF | Burundi, Francs | |
| BMD | Bermuda, Dollars | |
| BND | Brunei Darussalam, Dollars | |
| BOB | Bolivia, Bolivianos | |
| BRL | Brazil, Brazil Real | |
| BSD | Bahamas, Dollars | |
| BTN | Bhutan, Ngultrum | |
| BWP | Botswana, Pulas | |
| BYR | Belarus, Rubles | |
| BZD | Belize, Dollars | |
| CAD | Canada, Dollars | |
| CDF | Congo/Kinshasa, Congolese Francs | |
| CHF | Switzerland, Francs | |
| CLP | Chile, Pesos | |
| CNY | China, Yuan Renminbi | |
| COP | Colombia, Pesos | |
| CRC | Costa Rica, Colones | |
| CSD | Serbia, Dinars | |
| CUP | Cuba, Pesos | |
| CVE | Cape Verde, Escudos | |
| CYP | Cyprus, Pounds | |
| CZK | Czech Republic, Koruny | |
| DJF | Djibouti, Francs | |
| DKK | Denmark, Kroner | |
| DOP | Dominican Republic, Pesos | |
| DZD | Algeria, Algeria Dinars | |
| EEK | Estonia, Krooni | |
| EGP | Egypt, Pounds | |
| ERN | Eritrea, Nakfa | |
| ETB | Ethiopia, Birr | |
| EUR | Euro Member Countries, Euro | |
| FJD | Fiji, Dollars | |
| FKP | Falkland Islands (Malvinas), Pounds | |
| GBP | United Kingdom, Pounds | |
| GEL | Georgia, Lari | |
| GGP | Guernsey, Pounds | |
| GHC | Ghana, Cedis | |
| GIP | Gibraltar, Pounds | |
| GMD | Gambia, Dalasi | |
| GNF | Guinea, Francs | |
| GTQ | Guatemala, Quetzales | |
| GYD | Guyana, Dollars | |
| HKD | Hong Kong, Dollars | |
| HNL | Honduras, Lempiras | |
| HRK | Croatia, Kuna | |
| HTG | Haiti, Gourdes | |
| HUF | Hungary, Forint | |
| IDR | Indonesia, Rupiahs | |
| ILS | Israel, New Shekels | |
| IMP | Isle of Man, Pounds | |
| INR | India, Rupees | |
| IQD | Iraq, Dinars | |
| IRR | Iran, Rials | |
| ISK | Iceland, Kronur | |
| JEP | Jersey, Pounds | |
| JMD | Jamaica, Dollars | |
| JOD | Jordan, Dinars | |
| JPY | Japan, Yen | |
| KES | Kenya, Shillings | |
| KGS | Kyrgyzstan, Soms | |
| KHR | Cambodia, Riels | |
| KMF | Comoros, Francs | |
| KPW | Korea (North), Won | |
| KRW | Korea (South), Won | |
| KWD | Kuwait, Dinars | |
| KYD | Cayman Islands, Dollars | |
| KZT | Kazakhstan, Tenge | |
| LAK | Laos, Kips | |
| LBP | Lebanon, Pounds | |
| LKR | Sri Lanka, Rupees | |
| LRD | Liberia, Dollars | |
| LSL | Lesotho, Maloti | |
| LTL | Lithuania, Litai | |
| LVL | Latvia, Lati | |
| LYD | Libya, Dinars | |
| MAD | Morocco, Dirhams | |
| MDL | Moldova, Lei | |
| MGA | Madagascar, Ariary | |
| MKD | Macedonia, Denars | |
| MMK | Myanmar (Burma), Kyats | |
| MNT | Mongolia, Tugriks | |
| MOP | Macau, Patacas | |
| MRO | Mauritania, Ouguiyas | |
| MTL | Malta, Liri | |
| MUR | Mauritius, Rupees | |
| MVR | Maldives (Maldive Islands), Rufiyaa | |
| MWK | Malawi, Kwachas | |
| MXN | Mexico, Pesos | |
| MYR | Malaysia, Ringgits | |
| MZM | Mozambique, Meticais | |
| NAD | Namibia, Dollars | |
| NGN | Nigeria, Nairas | |
| NIO | Nicaragua, Cordobas | |
| NOK | Norway, Krone | |
| NPR | Nepal, Nepal Rupees | |
| NZD | New Zealand, Dollars | |
| OMR | Oman, Rials | |
| PAB | Panama, Balboa | |
| PEN | Peru, Nuevos Soles | |
| PGK | Papua New Guinea, Kina | |
| PHP | Philippines, Pesos | |
| PKR | Pakistan, Rupees | |
| PLN | Poland, Zlotych | |
| PYG | Paraguay, Guarani | |
| QAR | Qatar, Rials | |
| RON | Romania, New Lei | |
| RUB | Russia, Rubles | |
| RWF | Rwanda, Rwanda Francs | |
| SAR | Saudi Arabia, Riyals | |
| SBD | Solomon Islands, Dollars | |
| SCR | Seychelles, Rupees | |
| SDD | Sudan, Dinars | |
| SEK | Sweden, Kronor | |
| SGD | Singapore, Dollars | |
| SHP | Saint Helena, Pounds | |
| SIT | Slovenia, Tolars | |
| SKK | Slovakia, Koruny | |
| SLL | Sierra Leone, Leones | |
| SOS | Somalia, Shillings | |
| SPL | Seborga, Luigini | |
| SRD | Suriname, Dollars | |
| STD | São Tome and Principe, Dobras | |
| SVC | El Salvador, Colones | |
| SYP | Syria, Pounds | |
| SZL | Swaziland, Emalangeni | |
| THB | Thailand, Baht | |
| TJS | Tajikistan, Somoni | |
| TMM | Turkmenistan, Manats | |
| TND | Tunisia, Dinars | |
| TOP | Tonga, Pa'anga | |
| TRL | Turkey, Liras [being phased out] | |
| TRY | Turkey, New Lira | |
| TTD | Trinidad and Tobago, Dollars | |
| TVD | Tuvalu, Tuvalu Dollars | |
| TWD | Taiwan, New Dollars | |
| TZS | Tanzania, Shillings | |
| UAH | Ukraine, Hryvnia | |
| UGX | Uganda, Shillings | |
| USD | United States of America, Dollars | |
| UYU | Uruguay, Pesos | |
| UZS | Uzbekistan, Sums | |
| VEB | Venezuela, Bolivares | |
| VND | Viet Nam, Dong | |
| VUV | Vanuatu, Vatu | |
| WST | Samoa, Tala | |
| XAF | Communauté Financière Africaine BEAC, Francs | |
| XAG | Silver, Ounces | |
| XAU | Gold, Ounces | |
| XCD | East Caribbean Dollars | |
| XDR | International Monetary Fund (IMF) Special Drawing Rights | |
| XOF | Communauté Financière Africaine BCEAO, Francs | |
| XPD | Palladium Ounces | |
| XPF | Comptoirs Français du Pacifique Francs | |
| XPT | Platinum, Ounces | |
| YER | Yemen, Rials | |
| ZAR | South Africa, Rand | |
| ZMK | Zambia, Kwacha | |
| ZWD | Zimbabwe, Zimbabwe Dollars |
ServiceCode
| ERD | Road Express LHR | |
| U-SAVE | Air Express LHR | |
| USV | Air Express LHR | |
| DHLEI | DHL Air Express Imports | |
| DHLRI | DHL Road Express Imports | |
| UKIN | UK Integrator | |
| AIR | Express Overnight Parcels | |
| DHLUK | Express Overnight Parcels | |
| DOM | Express Overnight Parcels | |
| UKME | UK Mail Express | |
| UKPD | UK Mail Express | |
| UKLAB | Connect | |
| ASZ | Zero Cost | |
| FTG | Asendia Tracked Goods | |
| FTGP | Asendia Tracked Goods | |
| LAND | test Landmark | |
| DPP | Global Mail Priority | |
| DPPTES | Global Mail Priority | |
| DG | Dangerous Goods | |
| DGDI | DG Dry Ice | |
| DGR | Dangerous Goods Road | |
| COLD | UK Domestic Collection | |
| COLE | Express Collection | |
| 2CP | UK eCommerce Xpect 48 | |
| 2VP | UK eCommerce Xpect 48 | |
| 369 | eCommerce Packet LHR | |
| IEL | eCommerce Packet LHR | |
| 369 | eCommerce Packet LHR | |
| IEL | eCommerce Packet LHR | |
| 369 | eCommerce Packet LHR | |
| IEL | eCommerce Packet LHR | |
| 369 | eCommerce Packet LHR | |
| IEL | eCommerce Packet LHR | |
| 369 | eCommerce Packet LHR | |
| IEL | eCommerce Packet LHR | |
| 369 | eCommerce Packet LHR | |
| IEL | eCommerce Packet LHR | |
| 369 | eCommerce Parcel LHR | |
| IEH | eCommerce Parcel LHR | |
| 369 | eCommerce Parcel LHR | |
| IEH | eCommerce Parcel LHR | |
| IEH | eCommerce Parcel LHR | |
| IEH2 | eCommerce Parcel LHR | |
| 2CXN | Xpress 48 Small Parcel (2CXN) | |
| 1CP | Yodel Xpress 24 LHR | |
| 1VSP | Yodel Xpect 24 LHR | |
| 2CP | Yodel Xpress 48 LHR | |
| COLE | DHL Away Tariff Domestic | |
| 2VP | Yodel Xpect 48 (2VP) | |
| 2VLP | Yodel Xpect 48 XL (2VLP) | |
| PLT | UK Pallet | |
| COLS | ZZZZZz | |
| EUSA | USA Heavyweight | |
| CLHE | Away Tariff Air Express Dox | |
| COLE | Away Tariff Air Express Dox | |
| CLHR | Away Tariff Road Express | |
| COLR | Away Tariff Road Express | |
| GDP | Germany ecommerce | |
| PERF | Norsk Perfume | |
| USAP | eCommerce - USA Direct USPS | |
| DHLF | DG ID8000 | |
| 1VSN | Yodel Xpect 24 Leave LHR | |
| DGEQ | Dangerous Goods EQ | |
| ADAI | Australia eCommerce LHR | |
| HR24 | Evri Next Day | |
| HR48 | Evri 48 Hour | |
| USAF | eCommerce - USA Direct Fragrance USPS | |
| IEL | eCommerce Packet LHR | |
| IEH | eCommerce Parcel LHR | |
| DPDT | Rep of Ireland Two Day | |
| DGHD | DG Handling DDU | |
| PDAM | ZZZZZZZZZZ | |
| PDAM | UK Mail Express AM | |
| PDT9 | UK Mail Express 9AM | |
| PDTT | UK Mail Express 1030 AM | |
| IEHD | eCommerce Parcel DDP | |
| IELD | eCommerce Packet DDP | |
| PDSA | UK Mail Express Saturday | |
| DEDG | Germany Direct | |
| UFDA | eCommerce - USA Direct USPS FDA | |
| UPSE | UPS Air Express | |
| UPSE | UPS Air Express Dox | |
| UPSR | UPS Road Express | |
| UKRD | UK Mail Express RICO | |
| UKMD | UK Mail Express RICO MK | |
| 2CPBE | Collect Xpress 48 | |
| C48S | Collect Xpress 48 | |
| 2VLPBE | Collect Xpect 48 XL | |
| C48X | Collect Xpect 48 XL | |
| 2CPS | Collect Xpress 48 Hutch | |
| 2CPSH | Collect Xpress 48 Hutch | |
| AAAA | Collect Xpress 48 Hutch | |
| C101 | Collect Xpress 48 Hutch | |
| HPL | HPL | |
| 2CPOC | Collect Xpress 48 Ocean | |
| 2VLPOC | Collect Xpect 48 XL Ocean | |
| SLGM | SA & UAE eCommerce Direct | |
| TPNN | RM Large Letter 24 | |
| TRNN | RM Large Letter 24 | |
| TPSN | RM Large Letter 48 | |
| TRSN | RM Large Letter 48 | |
| TPNN | RM TRKD Parcel 24 | |
| TPSN | RM TRKD Parcel 48 | |
| TSS | RM Tracked Returns | |
| CRL1 | RM NTRKD Large Letter 24 | |
| CRL2 | RM NTRKD Large Letter 48 | |
| CRL1 | RM NTRKD Parcel 24 | |
| CRL2 | RM NTRKD Parcel 48 | |
| IOSSP | eCommerce Parcel IOSS | |
| 1VSPA | Yodel Xpect 24 AGE LHR | |
| 2VPA | Yodel Xpect 48 AGE | |
| 2VLPA | Yodel Xpect 48 XL AGE | |
| 2CXNA | Yodel Xpress 48 SP AGE | |
| 2CXNNB | Yodel Xpress 48 SP NB | |
| 1CPNB | Yodel Xpress 24 NB | |
| 1VSPNB | Yodel Xpect 24 NB | |
| 2CPNB | Yodel Xpress 48 NB | |
| 2VPNB | Yodel Xpect 48 NB | |
| 2VLPNB | Yodel Xpect 48 XL NB | |
| 1CPA | Yodel Xpress 24 AGE | |
| 2CPA | Yodel Xpress 48 AGE | |
| BF1 | RM BFPO | |
| USV | Air Express Non Dox | |
| DHLEI | Air Express Imports NDox | |
| UPSDS | UPS UK Parcel | |
| UPSDM | UPS UK Parcel Multi | |
| UPSDS | UPS UK Express | |
| UPSDM | UPS UK Express Multi | |
| TEST | TEST UPS AMS | |
| COLE | Away Tariff Air Express Non Dox | |
| UKBD | UK Mail Express BRID | |
| IOSSP | eCommerce Parcel (IOSS) | |
| TEST | TEST UPS AIR NL | |
| UPSENL | TEST UPS AIR NL | |
| TEST | TEST UPS RD NL | |
| UPSRNL | TEST UPS RD NL | |
| UKWL | UK Mail Express WEST | |
| USVEX | Air Express NDox | |
| IED48 | eCommerce IE Direct 48Hrs | |
| 2CPWD | Collect Xpress 48 WW Dist | |
| 2CMNWD | Col Xpress 48 MINI WWD | |
| 1CPAJA | Yodel Xpress 24 AGE (James and James) | |
| 2CPAJA | Yodel Xpress 48 AGE (James and James) | |
| 2CPAJJ | Yodel Xpress 48 AGE (James and James) | |
| 1VSPAJ | Yodel Xpect 24 AGE (James and James) | |
| 2VPAJA | Yodel Xpect 48 AGE (James and James) | |
| UPSEC | UPS Air Express Collect | |
| DPDPC | DPD Pre-Clear Classic | |
| DPDEP | DPD Pre-Clear Express Pak | |
| DPDPC | DPD Pre-Clear Express Pak | |
| DPDPCE | DPD Pre-Clear Express Pak | |
| UPSRP | UPS Road Express PADI | |
| UPSDSP | UPS UK Parcel PADI | |
| UPSDMP | UPS UK Parcel Multi Piece PADI | |
| UPSDSP | UPS UK Express PADI | |
| UPSDMP | UPS UK Express Multi Piece PADI | |
| USAPS | eCommerce - USA Direct USPS Sig Req | |
| UPSER | UPS Air Express Non Dox Rapha | |
| UPIER | UPS Imp Air Express Rapha | |
| UKAP | UK Mail Express APEX | |
| UPSEC | UPS Air Express Dox Collect | |
| UKLE | UK Mail Express RICO LE | |
| UPSRC | UPS Road Express Collect | |
| TPSS | RM TRKD Parcel 48 Signature | |
| TPNS | RM TRKD Parcel 24 Signature | |
| UPSESG | UPS Air Express Sig Req | |
| UPSESG | UPS Air Express Dox Sig Req | |
| UPSRSG | UPS Road Express Sig Req | |
| UPSDSC | UPS UK Parcel Collect | |
| UPSDSC | UPS UK Express Collect | |
| 2VPR | Yodel Xpect 48 RICO LP | |
| 2CPR | Yodel Xpress 48 RICO LP | |
| PDAMLE | UK Mail Express Pre 12 RICO LE | |
| PDT9LE | UK Mail Express 9AM RICO LE | |
| PDTTLE | UK Mail Express 1030 AM RICO LE | |
| UPSTD | UPS UK Pre 12 | |
| UPSTD | UPS UK Pre 1030 | |
| UPSTT | UPS UK Pre 1030 | |
| UPSETD | UPS Air Express Timed | |
| UPSETD | UPS Air Express Dox Timed | |
| UPSDSS | UPS UK Parcel Sig | |
| UPSDSS | UPS UK Express Sig | |
| UPSX | UPS Expedited | |
| UPSRM | UPS Road Express Multi | |
| UPSTDM | UPS UK Pre 1030 Multi | |
| UPSTTM | UPS UK Pre 1030 Multi | |
| UPSDCM | UPS UK Parcel Collect Multi | |
| UPSDCM | UPS UK Express Collect Multi | |
| UPSRMC | UPS Road Express Multi Collect | |
| UPSTD | UPS UK Pre 12 Multi | |
| UPSTDM | UPS UK Pre 12 Multi | |
| NZDAI | New Zealand eCommerce LHR | |
| HR24S | Evri Next Day Sig | |
| HR24HS | Evri ND House Sig | |
| UPSDE | UPS UK Express NI | |
| 2CPH20 | Collect Xpress 48 Giraffe | |
| EPKT | eCommerce Packet NL | |
| UPSEAS | UPS Adult Sig required | |
| UPSEAS | UPS Adult Sig req Dox | |
| UPSRAS | UPS RD Adult Sig required | |
| FDXD | eCommerce - USA Direct FedEx - FD | |
| FDXV | eCommerce - USA Direct FedEx - F | |
| UPSTTC | UPS UK Pre 1030 Collect | |
| UPSTTC | UPS UK Pre 1030 Multi Collect | |
| UPSTDC | UPS UK Pre 12 Collect | |
| UPSTDC | UPS UK Pre 12 Multi Collect | |
| UPSDSA | UPS UK Parcel Adult Sig | |
| UPSDSA | UPS UK Express Adult Sig | |
| EPRSL | eCommerce Tracked Parcel NL | |
| UPSDEC | UPS UK Express NI Collect | |
| UPSDEM | UPS UK Express NI Multi | |
| UPSDEC | UPS UK Express NI Collect Multi | |
| UPSDSA | UPS UK Parcel Adult Sig Multi | |
| UPSDSA | UPS UK Express Adult Sig Multi | |
| SKYE | Air Express Skynet | |
| DPDPCI | DPD Classic IOSS | |
| DPDPEI | DPD Express Pak IOSS | |
| DGEQUK | DG EQ UK Express | |
| 2CXNSC | Yodel Xpress 48 Small Parcel SVC | |
| 1CPSC | Yodel Xpress 24 SVC | |
| 2CPSC | Yodel Xpress 48 SVC | |
| 1VSPSC | Yodel Xpect 24 SVC | |
| 2VPSC | Yodel Xpect 48 SVC | |
| 2VLPSC | Yodel Xpect 48 XL SVC | |
| DPDGC | DPD Groupage | |
| IEH | eCommerce Parcel LHR | |
| UPSESV | UPS Air Express Split VAT | |
| UPSRSV | UPS Road Express Split VAT |
Response
ShipmentBookingResponse
Fields
| Name | Type | Documentation |
|---|---|---|
| Barcode | string | the barcode shown on the shipment label. |
| Label | Byte[] | Consolidated multi page pdf of the label and archive documents. Base64 encoded copy of the default shipment labels in 6x4 in PDF format |
| NorskBarcode | string | Barcode/identifier allocated for the shipment by Norsk for tracking of the shipment. May not be displayed on the label. |
| Items | array of ShipmentBookingItem | A collection containing details for each shipment item |
| ArchiveDocuments | array of ShipmentArchiveDocument | A collection of any non label documents to go with the shipment. |
| CollectionReferenceNumber | string | Supplier collection reference number for shipment with collection. Will be null for non collection shipment |
| CollectionDateTime | DateTime | Supplier collection date with time number for shipment with collection. Will be null for non collection shipment |
Byte[]
Fields
| Name | Type | Documentation |
|---|---|---|
| Length | integer | |
| LongLength | integer | |
| Rank | integer | |
| SyncRoot | Object | |
| IsReadOnly | boolean | |
| IsFixedSize | boolean | |
| IsSynchronized | boolean |
Object
Fields
| Name | Type | Documentation |
|---|
ShipmentBookingItem
Fields
| Name | Type | Documentation |
|---|---|---|
| NorskBarcode | string | Barcode/identifier allocated for the shipment item by Norsk may not be displayed on the label. |
| Barcode | string | The barcode shown on the label for the shipment item. |
| Label | Byte[] | Separate label for the shipment item. Base64 encoded in pdf format. |
| ScanBarcode | string | Barcode that is used when scanning an item. May be different from numeric barcode displayed on the label. |
| Weight | decimal number | Weight for the item specified by the booking May be different from specified depending on dimensions |
ShipmentArchiveDocument
Fields
| Name | Type | Documentation |
|---|---|---|
| Contents | Byte[] | Base64 encoded copy of the document in PDF format |