Action Documentation
POST - api/quote
Get information about possible services that can be booked using the provided information. Returned Quotes will be applicable to the data provided.
Body Models
QuoteRequestModel
Represents a model for a quote request in the shipment process. This model includes detailed information about the shipping date, destination, collection source, value of the shipment, its pieces, and any applicable extra charges.
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| ShippingDate | date | The expected shipping date. More accurate prices are provided if the date is closer to the actual shipping date. |
must not be empty. must be greater than or equal to . must be less than . |
| Zipcode | string | The ZIP code of the destination, if applicable. | |
| Town | string | The town of the destination. |
must not be empty. must not be empty. |
| CountryCode | string | The country code of the destination. |
must not be empty. must be 2 characters in length. Country Code must be a valid two letter ISO code |
| Collection | From | An object describing where the shipment will be collected from. If the shipper country differs from the collection country, import quotes will be offered. | |
| Dutiable | Dutiable | An object that indicates the value and currency of the shipment, where applicable. | |
| AdditionalServiceOptions | ServiceOptions | An object that allows additional charges to be calculated where applicable | |
| Pieces | array of QuoteRequestPiece | A list describing all the pieces in the shipment. |
must not be empty. The specified condition was not met for . |
| Specials | string of "Pallet, Ddp, NonStackablePallet" | A list of additional charges to apply to the quote, e.g., for Delivery Duty Paid (DDP). |
From
Represents the collection location for a shipment. This class is used to denote the precise place from where a shipment will be picked up, providing crucial details such as ZIP code, town, and country.
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Zipcode | string | The ZIP code of the collection location. | |
| Town | string | The town of the collection location. | |
| CountryCode | string | The country code of the collection location. |
Dutiable
Represents a dutiable shipment item. This class details the indicated value and the currency of the dutiable shipment.
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Value | decimal number | The indicated value of the dutiable shipment. | |
| Currency | string | The currency of the dutiable shipment's value. |
ServiceOptions
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Insurance | Money | ||
| AdultSignature | Boolean |
Money
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Value | decimal number | ||
| Currency | string |
QuoteRequestPiece
Represents a piece in the shipment. This class provides specific details about a piece's dimensions (length, width, height), weight, and the quantity of such pieces in a shipment.
Fields
| Name | Type | Documentation | Validation |
|---|---|---|---|
| Length | decimal number | The length dimension of the shipment piece. |
must not be empty. must be greater than 0. |
| Width | decimal number | The width dimension of the shipment piece. |
must not be empty. must be greater than 0. |
| Height | decimal number | The height dimension of the shipment piece. |
must not be empty. must be greater than 0. |
| Weight | decimal number | The weight of the shipment piece. |
must not be empty. must be greater than 0. |
| NumberOfPieces | integer | The quantity of pieces. |
must not be empty. must be greater than 0. |
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 |
Response
QuoteResponseModel
Fields
| Name | Type | Documentation |
|---|---|---|
| QuotesValidFrom | date | |
| TotalQuotes | integer | |
| Currency | string | |
| Quotes | array of IQuote |
IQuote
Fields
| Name | Type | Documentation |
|---|---|---|
| DepatureDate | date | |
| ServiceName | string | |
| ServiceCode | string | |
| TransitTime | string | |
| PrettyTransitTime | string | |
| ChargeableWeight | decimal number | |
| BaseCost | decimal number | |
| FuelCost | decimal number | |
| TotalCost | decimal number | |
| Costs | array of IQuoteCost |
IQuoteCost
Fields
| Name | Type | Documentation |
|---|---|---|
| Reference | string | |
| BaseCost | decimal number | |
| FuelCost | Decimal | |
| TotalCost | decimal number |