The GetQuoteMinimal method returns the user a list of services that can be used to place an order for a given request. The response includes a quote id that can optionally be used to place an order and a list of service results. Each service result contains identifying information, including the service id that is used when placing an order, as well as a price break down and additional information that may be useful to the client which will be described below.
This method differs from the GetQuote method in that les consignment information is required in order to get the quote. It requires the item type, dimensions and the country, city and postcode for collection/delivery, no commodity details, consignment values or additional address information is required to retrieve a quote.
The below requests are based on shipments from UK to the United States (so as to include the commodity information).
{
"Credentials": {
"APIKey": "[API KEY]",
"Password": "[API PASSWORD]"
},
"Shipment": {
"Consignment": {
"ItemType": "Parcel",
"Packages": [
{
"Weight": 5.0,
"Length": 30.0,
"Width": 20.0,
"Height": 10.0
},
{
"Weight": 3.5,
"Length": 47.98,
"Width": 45.62,
"Height": 12.5
}
]
},
"CollectionAddress": {
"City": "Bromborough",
"Postcode": "CH62 3NX",
"Country": {
"CountryID": 231,
"CountryCode": "GB"
}
},
"DeliveryAddress": {
"City": "New York",
"Postcode": "10005",
"Country": {
"CountryID": 232,
"CountryCode": "US"
}
}
}
}
<GetQuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.transglobalexpress.co.uk/API/V2">
<Credentials>
<APIKey>uKd34Kf9Lf</APIKey>
<Password>8n0WU?Oojy</Password>
</Credentials>
<Shipment>
<Consignment>
<ItemType>Parcel</ItemType>
<Packages>
<Package>
<Weight>5</Weight>
<Length>30</Length>
<Width>20</Width>
<Height>10</Height>
</Package>
<Package>
<Weight>3.5</Weight>
<Length>47.98</Length>
<Width>45.62</Width>
<Height>12.5</Height>
</Package>
</Packages>
</Consignment>
<CollectionAddress>
<City>Bromborough</City>
<Postcode>CH62 3NX</Postcode>
<Country>
<CountryID>231</CountryID>
<CountryCode>GB</CountryCode>
</Country>
</CollectionAddress>
<DeliveryAddress>
<City>New York</City>
<Postcode>10005</Postcode>
<Country>
<CountryID>232</CountryID>
<CountryCode>US</CountryCode>
</Country>
</DeliveryAddress>
</Shipment>
</GetQuoteRequest>
| Property Name | Data Type | Parent | M | Comment | Example |
|---|---|---|---|---|---|
| GetQuoteRequest | Container | M | The root container for the request. | ||
| Credentials | |||||
| Credentials | Container | GetQuoteRequest | M | The api credentials container. | |
| APIKey | string | Credentials | M | The api key. | Th6fLmTxBv |
| Password | string | Credentials | M |
The api password. Please note this is NOT the password used to log into the website. |
rGf3!lmT4dA |
| Shipment | |||||
| Shipment | Container | GetQuoteRequest | M | The shipment container. | |
| Consignment | |||||
| Consignment | Container | Shipment | M | The consignment container. | |
| ItemType | string | Consignment | M |
The item type. Valid values are: Parcel, Document, Pallet, Suitcase |
Parcel |
| Packages | |||||
| Packages | Container | Consignment | M | The container for consignment items. | |
| Package | Container | Packages | M |
The container for a consignment item. Note: The element container is used in XML format requests, if using JSON format it is not explicitly named, the "Packages" element (see above) is an array of Package objects. This is demonstrated in the provided JSON example above this table. |
|
| Weight | decimal | Package | M | The item weight in Kg. | 3.5 |
| Length | decimal | Package | M | The item length in Cm. | 47.98 |
| Width | decimal | Package | M | The item width in Cm. | 45.62 |
| Height | decimal | Package | M | The item height in Cm. | 12.5 |
| CollectionAddress | |||||
| CollectionAddress | Container | Shipment | M | The collection address container. | |
| City | string | CollectionAddress | M | The city. | Bromborough |
| Postcode | string | CollectionAddress | C |
The postcode. This is mandatory for all countries that have a postal or zip code. It is marked as conditional here because some countries such as Ireland (at the time of writing this documentation) do not use postcodes and as such no postcode would be required for an address in that country. |
CH62 3NX |
| Country | Container | CollectionAddress | M |
The postcode. The container for defining the address country. Note this is the same container format when specifying a country anywhere in this request. |
|
| CountryID | integer | Country | C |
The country id as defined within the Transglobal Express system. Note: This value can be omitted if providing a value for CountryCode. If both CountryID and CountryCode are provided, the CountryCode value will be ignored and the country will be selected based on the CountryID value. Country id values can be discovered via the countries section of the Transglobal Express API (/Country/V2/GetCountries). |
231 |
| CountryCode | string | Country | C |
The ISO code for the country. Note: This value can be omitted if providing a value for CountryID. If both CountryID and CountryCode are provided, the CountryCode value will be ignored and the country will be selected based on the CountryID value. Country code values can be discovered via the countries section of the Transglobal Express API (/Country/V2/GetCountries). |
GB |
| DeliveryAddress | |||||
| DeliveryAddress | Container | Shipment | M | The collection address container. | |
| City | string | DeliveryAddress | M | The city. | Bromborough |
| Postcode | string | DeliveryAddress | C |
The postcode. This is mandatory for all countries that have a postal or zip code. It is marked as conditional here because some countries such as Ireland (at the time of writing this documentation) do not use postcodes and as such no postcode would be required for an address in that country. |
CH62 3NX |
| Country | Container | DeliveryAddress | M |
The postcode. The container for defining the address country. Note this is the same container format when specifying a country anywhere in this request. |
|
| CountryID | integer | Country | C |
The country id as defined within the Transglobal Express system. Note: This value can be omitted if providing a value for CountryCode. If both CountryID and CountryCode are provided, the CountryCode value will be ignored and the country will be selected based on the CountryID value. Country id values can be discovered via the countries section of the Transglobal Express API (/Country/V2/GetCountries). |
232 |
| CountryCode | string | Country | C |
The ISO code for the country. Note: This value can be omitted if providing a value for CountryID. If both CountryID and CountryCode are provided, the CountryCode value will be ignored and the country will be selected based on the CountryID value. Country code values can be discovered via the countries section of the Transglobal Express API (/Country/V2/GetCountries). |
US |
The responses below are based on a quote from The UK to Germany (so as to show the net and gross price differences).
{
"Status": "SUCCESS",
"Notifications": [],
"QuoteID": 1145,
"ServiceResults": [
{
"ServiceID": 87,
"ServiceName": "TG Euro Parcel",
"CarrierName": "DPD",
"ChargeableWeight": 10,
"TransitTimeEstimate": "2+",
"IsWarehouseService": true,
"TotalCost": {
"TotalCostNetWithCollection": 17.38,
"TotalCostNetWithoutCollection": 10.43,
"TotalCostGrossWithCollection": 20.86,
"TotalCostGrossWithoutCollection": 12.52
},
"ServicePriceBreakdown": [
{
"Code": "FRT",
"Description": "Freight Charge",
"Cost": 10.43
},
{
"Code": "COL",
"Description": "Collection",
"Cost": 6.95
}
],
"OptionalExtras": [
{
"Code": "INS",
"Description": "Transit Insurance",
"Cost": 5
}
],
"SignatureRequiredAvailable": false,
"ExpectedLabels": [
{
"LabelRole": "Primary",
"LabelFormat": "PDF",
"LabelGenerateStatus": "Conditional",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
},
{
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "Conditional",
"AvailableSizes": []
}
],
"CollectionOptions": [
{
"CollectionOptionID": 4,
"CollectionOptionTitle": "DPDCollection",
"CollectionCharge": 6.95,
"SameDayCollectionCutOffTime": "14:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
},
{
"CollectionOptionID": 1,
"CollectionOptionTitle": "TNTCollection",
"CollectionCharge": 14.57,
"SameDayCollectionCutOffTime": "15:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
},
{
"CollectionOptionID": 5,
"CollectionOptionTitle": "UPSCollection",
"CollectionCharge": 9.48,
"SameDayCollectionCutOffTime": "12:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
}
],
"ServiceType": "AirAndRoad"
},
{
"ServiceID": 63,
"ServiceName": "DPD Classic",
"CarrierName": "DPD",
"ChargeableWeight": 10,
"TransitTimeEstimate": "2+",
"SameDayCollectionCutOffTime": "14:00",
"IsWarehouseService": false,
"TotalCost": {
"TotalCostNetWithCollection": 15.17,
"TotalCostNetWithoutCollection": 15.17,
"TotalCostGrossWithCollection": 18.2,
"TotalCostGrossWithoutCollection": 18.2
},
"ServicePriceBreakdown": [
{
"Code": "FRT",
"Description": "Freight Charge",
"Cost": 15.17
}
],
"OptionalExtras": [
{
"Code": "INS",
"Description": "Transit Insurance",
"Cost": 5
}
],
"SignatureRequiredAvailable": false,
"ExpectedLabels": [
{
"LabelRole": "Primary",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
]
},
{
"ServiceID": 53,
"ServiceName": "TG Express Worldwide",
"CarrierName": "DHL",
"ChargeableWeight": 10,
"TransitTimeEstimate": "1+",
"IsWarehouseService": true,
"TotalCost": {
"TotalCostNetWithCollection": 45.83,
"TotalCostNetWithoutCollection": 38.88,
"TotalCostGrossWithCollection": 55,
"TotalCostGrossWithoutCollection": 46.66
},
"ServicePriceBreakdown": [
{
"Code": "FRT",
"Description": "Freight Charge",
"Cost": 38.88
},
{
"Code": "COL",
"Description": "Collection",
"Cost": 6.95
}
],
"OptionalExtras": [
{
"Code": "INS",
"Description": "Transit Insurance",
"Cost": 5
}
],
"SignatureRequiredAvailable": false,
"ExpectedLabels": [
{
"LabelRole": "Primary",
"LabelFormat": "PDF",
"LabelGenerateStatus": "Conditional",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
},
{
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "Conditional",
"AvailableSizes": []
}
],
"CollectionOptions": [
{
"CollectionOptionID": 4,
"CollectionOptionTitle": "DPDCollection",
"CollectionCharge": 6.95,
"SameDayCollectionCutOffTime": "14:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
},
{
"CollectionOptionID": 1,
"CollectionOptionTitle": "TNTCollection",
"CollectionCharge": 14.57,
"SameDayCollectionCutOffTime": "15:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
},
{
"CollectionOptionID": 5,
"CollectionOptionTitle": "UPSCollection",
"CollectionCharge": 9.48,
"SameDayCollectionCutOffTime": "12:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
}
],
"ServiceType": "Air"
},
{
"ServiceID": 23,
"ServiceName": "UPS Express Saver®",
"CarrierName": "UPS",
"ChargeableWeight": 10,
"TransitTimeEstimate": "1+",
"SameDayCollectionCutOffTime": "16:00",
"IsWarehouseService": false,
"TotalCost": {
"TotalCostNetWithCollection": 49.91,
"TotalCostNetWithoutCollection": 49.91,
"TotalCostGrossWithCollection": 59.89,
"TotalCostGrossWithoutCollection": 59.89
},
"ServicePriceBreakdown": [
{
"Code": "FRT",
"Description": "Freight Charge",
"Cost": 47.71
},
{
"Code": "RES",
"Description": "Residential Surcharge",
"Cost": 2.2
}
],
"OptionalExtras": [
{
"Code": "INS",
"Description": "Transit Insurance",
"Cost": 5
}
],
"SignatureRequiredAvailable": false,
"ExpectedLabels": [
{
"LabelRole": "Primary",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
],
"ServiceType": "Air"
},
{
"ServiceID": 35,
"ServiceName": "DHL Express Worldwide",
"CarrierName": "DHL",
"ChargeableWeight": 10,
"TransitTimeEstimate": "1+",
"SameDayCollectionCutOffTime": "15:30",
"IsWarehouseService": false,
"TotalCost": {
"TotalCostNetWithCollection": 73,
"TotalCostNetWithoutCollection": 73,
"TotalCostGrossWithCollection": 87.6,
"TotalCostGrossWithoutCollection": 87.6
},
"ServicePriceBreakdown": [
{
"Code": "FRT",
"Description": "Freight Charge",
"Cost": 73
}
],
"OptionalExtras": [
{
"Code": "INS",
"Description": "Transit Insurance",
"Cost": 5
}
],
"SignatureRequiredAvailable": false,
"ExpectedLabels": [
{
"LabelRole": "Primary",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
],
"ServiceType": "Air"
},
{
"ServiceID": 18,
"ServiceName": "TNT Economy Express",
"CarrierName": "TNT",
"ChargeableWeight": 10,
"TransitTimeEstimate": "2+",
"SameDayCollectionCutOffTime": "15:00",
"IsWarehouseService": false,
"TotalCost": {
"TotalCostNetWithCollection": 98.38,
"TotalCostNetWithoutCollection": 98.38,
"TotalCostGrossWithCollection": 118.06,
"TotalCostGrossWithoutCollection": 118.06
},
"ServicePriceBreakdown": [
{
"Code": "FRT",
"Description": "Freight Charge",
"Cost": 27.18
},
{
"Code": "STK",
"Description": "Non Stackable Surcharge",
"Cost": 71.2
}
],
"OptionalExtras": [
{
"Code": "INS",
"Description": "Transit Insurance",
"Cost": 5
}
],
"SignatureRequiredAvailable": false,
"ExpectedLabels": [
{
"LabelRole": "Primary",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
],
"ServiceType": "AirAndRoad"
},
{
"ServiceID": 44,
"ServiceName": "TG International Economy",
"CarrierName": "TG",
"ChargeableWeight": 10,
"TransitTimeEstimate": "3+",
"IsWarehouseService": true,
"TotalCost": {
"TotalCostNetWithCollection": 148.85,
"TotalCostNetWithoutCollection": 141.9,
"TotalCostGrossWithCollection": 178.62,
"TotalCostGrossWithoutCollection": 170.28
},
"ServicePriceBreakdown": [
{
"Code": "FRT",
"Description": "Freight Charge",
"Cost": 27.9
},
{
"Code": "STK",
"Description": "Non Stackable Surcharge",
"Cost": 114
},
{
"Code": "COL",
"Description": "Collection",
"Cost": 6.95
}
],
"OptionalExtras": [
{
"Code": "INS",
"Description": "Transit Insurance",
"Cost": 5
}
],
"SignatureRequiredAvailable": false,
"ExpectedLabels": [
{
"LabelRole": "Primary",
"LabelFormat": "PDF",
"LabelGenerateStatus": "NoLabel",
"AvailableSizes": []
},
{
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "Conditional",
"AvailableSizes": []
}
],
"CollectionOptions": [
{
"CollectionOptionID": 4,
"CollectionOptionTitle": "DPDCollection",
"CollectionCharge": 6.95,
"SameDayCollectionCutOffTime": "14:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
},
{
"CollectionOptionID": 1,
"CollectionOptionTitle": "TNTCollection",
"CollectionCharge": 14.57,
"SameDayCollectionCutOffTime": "15:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
},
{
"CollectionOptionID": 5,
"CollectionOptionTitle": "UPSCollection",
"CollectionCharge": 9.48,
"SameDayCollectionCutOffTime": "12:00",
"ExpectedLabel": {
"LabelRole": "Collection",
"LabelFormat": "PDF",
"LabelGenerateStatus": "LabelGenerated",
"AvailableSizes": [
{
"Size": "A4"
},
{
"Size": "Thermal"
}
]
}
}
],
"ServiceType": "Air"
}
]
}
<GetQuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.transglobalexpress.co.uk/API/V2">
<Status>SUCCESS</Status>
<Notifications />
<QuoteID>1146</QuoteID>
<ServiceResults>
<ServiceQuoteResult>
<ServiceID>87</ServiceID>
<ServiceName>TG Euro Parcel</ServiceName>
<CarrierName>DPD</CarrierName>
<ChargeableWeight>10.00</ChargeableWeight>
<TransitTimeEstimate>2+</TransitTimeEstimate>
<IsWarehouseService>true</IsWarehouseService>
<TotalCost>
<TotalCostNetWithCollection>17.38</TotalCostNetWithCollection>
<TotalCostNetWithoutCollection>10.43</TotalCostNetWithoutCollection>
<TotalCostGrossWithCollection>20.86</TotalCostGrossWithCollection>
<TotalCostGrossWithoutCollection>12.52</TotalCostGrossWithoutCollection>
</TotalCost>
<ServicePriceBreakdown>
<PriceElement>
<Code>FRT</Code>
<Description>Freight Charge</Description>
<Cost>10.43</Cost>
</PriceElement>
<PriceElement>
<Code>COL</Code>
<Description>Collection</Description>
<Cost>6.95</Cost>
</PriceElement>
</ServicePriceBreakdown>
<OptionalExtras>
<PriceElement>
<Code>INS</Code>
<Description>Transit Insurance</Description>
<Cost>5</Cost>
</PriceElement>
</OptionalExtras>
<SignatureRequiredAvailable>false</SignatureRequiredAvailable>
<ExpectedLabels>
<ExpectedLabel>
<LabelRole>Primary</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>Conditional</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>Conditional</LabelGenerateStatus>
<AvailableSizes />
</ExpectedLabel>
</ExpectedLabels>
<CollectionOptions>
<ServiceResultCollectionOption>
<CollectionOptionID>4</CollectionOptionID>
<CollectionOptionTitle>DPDCollection</CollectionOptionTitle>
<CollectionCharge>6.95</CollectionCharge>
<SameDayCollectionCutOffTime>14:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
<ServiceResultCollectionOption>
<CollectionOptionID>1</CollectionOptionID>
<CollectionOptionTitle>TNTCollection</CollectionOptionTitle>
<CollectionCharge>14.57</CollectionCharge>
<SameDayCollectionCutOffTime>15:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
<ServiceResultCollectionOption>
<CollectionOptionID>5</CollectionOptionID>
<CollectionOptionTitle>UPSCollection</CollectionOptionTitle>
<CollectionCharge>9.48</CollectionCharge>
<SameDayCollectionCutOffTime>12:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
</CollectionOptions>
<ServiceType>AirAndRoad</ServiceType>
</ServiceQuoteResult>
<ServiceQuoteResult>
<ServiceID>63</ServiceID>
<ServiceName>DPD Classic</ServiceName>
<CarrierName>DPD</CarrierName>
<ChargeableWeight>10.00</ChargeableWeight>
<TransitTimeEstimate>2+</TransitTimeEstimate>
<SameDayCollectionCutOffTime>14:00</SameDayCollectionCutOffTime>
<IsWarehouseService>false</IsWarehouseService>
<TotalCost>
<TotalCostNetWithCollection>15.17</TotalCostNetWithCollection>
<TotalCostNetWithoutCollection>15.17</TotalCostNetWithoutCollection>
<TotalCostGrossWithCollection>18.20</TotalCostGrossWithCollection>
<TotalCostGrossWithoutCollection>18.20</TotalCostGrossWithoutCollection>
</TotalCost>
<ServicePriceBreakdown>
<PriceElement>
<Code>FRT</Code>
<Description>Freight Charge</Description>
<Cost>15.17</Cost>
</PriceElement>
</ServicePriceBreakdown>
<OptionalExtras>
<PriceElement>
<Code>INS</Code>
<Description>Transit Insurance</Description>
<Cost>5</Cost>
</PriceElement>
</OptionalExtras>
<SignatureRequiredAvailable>false</SignatureRequiredAvailable>
<ExpectedLabels>
<ExpectedLabel>
<LabelRole>Primary</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ExpectedLabels>
<ServiceType>AirAndRoad</ServiceType>
</ServiceQuoteResult>
<ServiceQuoteResult>
<ServiceID>53</ServiceID>
<ServiceName>TG Express Worldwide</ServiceName>
<CarrierName>DHL</CarrierName>
<ChargeableWeight>10.00</ChargeableWeight>
<TransitTimeEstimate>1+</TransitTimeEstimate>
<IsWarehouseService>true</IsWarehouseService>
<TotalCost>
<TotalCostNetWithCollection>45.83</TotalCostNetWithCollection>
<TotalCostNetWithoutCollection>38.88</TotalCostNetWithoutCollection>
<TotalCostGrossWithCollection>55.00</TotalCostGrossWithCollection>
<TotalCostGrossWithoutCollection>46.66</TotalCostGrossWithoutCollection>
</TotalCost>
<ServicePriceBreakdown>
<PriceElement>
<Code>FRT</Code>
<Description>Freight Charge</Description>
<Cost>38.88</Cost>
</PriceElement>
<PriceElement>
<Code>COL</Code>
<Description>Collection</Description>
<Cost>6.95</Cost>
</PriceElement>
</ServicePriceBreakdown>
<OptionalExtras>
<PriceElement>
<Code>INS</Code>
<Description>Transit Insurance</Description>
<Cost>5</Cost>
</PriceElement>
</OptionalExtras>
<SignatureRequiredAvailable>false</SignatureRequiredAvailable>
<ExpectedLabels>
<ExpectedLabel>
<LabelRole>Primary</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>Conditional</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>Conditional</LabelGenerateStatus>
<AvailableSizes />
</ExpectedLabel>
</ExpectedLabels>
<CollectionOptions>
<ServiceResultCollectionOption>
<CollectionOptionID>4</CollectionOptionID>
<CollectionOptionTitle>DPDCollection</CollectionOptionTitle>
<CollectionCharge>6.95</CollectionCharge>
<SameDayCollectionCutOffTime>14:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
<ServiceResultCollectionOption>
<CollectionOptionID>1</CollectionOptionID>
<CollectionOptionTitle>TNTCollection</CollectionOptionTitle>
<CollectionCharge>14.57</CollectionCharge>
<SameDayCollectionCutOffTime>15:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
<ServiceResultCollectionOption>
<CollectionOptionID>5</CollectionOptionID>
<CollectionOptionTitle>UPSCollection</CollectionOptionTitle>
<CollectionCharge>9.48</CollectionCharge>
<SameDayCollectionCutOffTime>12:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
</CollectionOptions>
<ServiceType>Air</ServiceType>
</ServiceQuoteResult>
<ServiceQuoteResult>
<ServiceID>23</ServiceID>
<ServiceName>UPS Express Saver®</ServiceName>
<CarrierName>UPS</CarrierName>
<ChargeableWeight>10.00</ChargeableWeight>
<TransitTimeEstimate>1+</TransitTimeEstimate>
<SameDayCollectionCutOffTime>16:00</SameDayCollectionCutOffTime>
<IsWarehouseService>false</IsWarehouseService>
<TotalCost>
<TotalCostNetWithCollection>49.91</TotalCostNetWithCollection>
<TotalCostNetWithoutCollection>49.91</TotalCostNetWithoutCollection>
<TotalCostGrossWithCollection>59.89</TotalCostGrossWithCollection>
<TotalCostGrossWithoutCollection>59.89</TotalCostGrossWithoutCollection>
</TotalCost>
<ServicePriceBreakdown>
<PriceElement>
<Code>FRT</Code>
<Description>Freight Charge</Description>
<Cost>47.71</Cost>
</PriceElement>
<PriceElement>
<Code>RES</Code>
<Description>Residential Surcharge</Description>
<Cost>2.20</Cost>
</PriceElement>
</ServicePriceBreakdown>
<OptionalExtras>
<PriceElement>
<Code>INS</Code>
<Description>Transit Insurance</Description>
<Cost>5</Cost>
</PriceElement>
</OptionalExtras>
<SignatureRequiredAvailable>false</SignatureRequiredAvailable>
<ExpectedLabels>
<ExpectedLabel>
<LabelRole>Primary</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ExpectedLabels>
<ServiceType>Air</ServiceType>
</ServiceQuoteResult>
<ServiceQuoteResult>
<ServiceID>35</ServiceID>
<ServiceName>DHL Express Worldwide</ServiceName>
<CarrierName>DHL</CarrierName>
<ChargeableWeight>10.00</ChargeableWeight>
<TransitTimeEstimate>1+</TransitTimeEstimate>
<SameDayCollectionCutOffTime>15:30</SameDayCollectionCutOffTime>
<IsWarehouseService>false</IsWarehouseService>
<TotalCost>
<TotalCostNetWithCollection>73.00</TotalCostNetWithCollection>
<TotalCostNetWithoutCollection>73.00</TotalCostNetWithoutCollection>
<TotalCostGrossWithCollection>87.60</TotalCostGrossWithCollection>
<TotalCostGrossWithoutCollection>87.60</TotalCostGrossWithoutCollection>
</TotalCost>
<ServicePriceBreakdown>
<PriceElement>
<Code>FRT</Code>
<Description>Freight Charge</Description>
<Cost>73.00</Cost>
</PriceElement>
</ServicePriceBreakdown>
<OptionalExtras>
<PriceElement>
<Code>INS</Code>
<Description>Transit Insurance</Description>
<Cost>5</Cost>
</PriceElement>
</OptionalExtras>
<SignatureRequiredAvailable>false</SignatureRequiredAvailable>
<ExpectedLabels>
<ExpectedLabel>
<LabelRole>Primary</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ExpectedLabels>
<ServiceType>Air</ServiceType>
</ServiceQuoteResult>
<ServiceQuoteResult>
<ServiceID>18</ServiceID>
<ServiceName>TNT Economy Express</ServiceName>
<CarrierName>TNT</CarrierName>
<ChargeableWeight>10.00</ChargeableWeight>
<TransitTimeEstimate>2+</TransitTimeEstimate>
<SameDayCollectionCutOffTime>15:00</SameDayCollectionCutOffTime>
<IsWarehouseService>false</IsWarehouseService>
<TotalCost>
<TotalCostNetWithCollection>98.38</TotalCostNetWithCollection>
<TotalCostNetWithoutCollection>98.38</TotalCostNetWithoutCollection>
<TotalCostGrossWithCollection>118.06</TotalCostGrossWithCollection>
<TotalCostGrossWithoutCollection>118.06</TotalCostGrossWithoutCollection>
</TotalCost>
<ServicePriceBreakdown>
<PriceElement>
<Code>FRT</Code>
<Description>Freight Charge</Description>
<Cost>27.18</Cost>
</PriceElement>
<PriceElement>
<Code>STK</Code>
<Description>Non Stackable Surcharge</Description>
<Cost>71.20</Cost>
</PriceElement>
</ServicePriceBreakdown>
<OptionalExtras>
<PriceElement>
<Code>INS</Code>
<Description>Transit Insurance</Description>
<Cost>5</Cost>
</PriceElement>
</OptionalExtras>
<SignatureRequiredAvailable>false</SignatureRequiredAvailable>
<ExpectedLabels>
<ExpectedLabel>
<LabelRole>Primary</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ExpectedLabels>
<ServiceType>AirAndRoad</ServiceType>
</ServiceQuoteResult>
<ServiceQuoteResult>
<ServiceID>44</ServiceID>
<ServiceName>TG International Economy</ServiceName>
<CarrierName>TG</CarrierName>
<ChargeableWeight>10.00</ChargeableWeight>
<TransitTimeEstimate>3+</TransitTimeEstimate>
<IsWarehouseService>true</IsWarehouseService>
<TotalCost>
<TotalCostNetWithCollection>148.85</TotalCostNetWithCollection>
<TotalCostNetWithoutCollection>141.90</TotalCostNetWithoutCollection>
<TotalCostGrossWithCollection>178.62</TotalCostGrossWithCollection>
<TotalCostGrossWithoutCollection>170.28</TotalCostGrossWithoutCollection>
</TotalCost>
<ServicePriceBreakdown>
<PriceElement>
<Code>FRT</Code>
<Description>Freight Charge</Description>
<Cost>27.90</Cost>
</PriceElement>
<PriceElement>
<Code>STK</Code>
<Description>Non Stackable Surcharge</Description>
<Cost>114.00</Cost>
</PriceElement>
<PriceElement>
<Code>COL</Code>
<Description>Collection</Description>
<Cost>6.95</Cost>
</PriceElement>
</ServicePriceBreakdown>
<OptionalExtras>
<PriceElement>
<Code>INS</Code>
<Description>Transit Insurance</Description>
<Cost>5</Cost>
</PriceElement>
</OptionalExtras>
<SignatureRequiredAvailable>false</SignatureRequiredAvailable>
<ExpectedLabels>
<ExpectedLabel>
<LabelRole>Primary</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>NoLabel</LabelGenerateStatus>
<AvailableSizes />
</ExpectedLabel>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>Conditional</LabelGenerateStatus>
<AvailableSizes />
</ExpectedLabel>
</ExpectedLabels>
<CollectionOptions>
<ServiceResultCollectionOption>
<CollectionOptionID>4</CollectionOptionID>
<CollectionOptionTitle>DPDCollection</CollectionOptionTitle>
<CollectionCharge>6.95</CollectionCharge>
<SameDayCollectionCutOffTime>14:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
<ServiceResultCollectionOption>
<CollectionOptionID>1</CollectionOptionID>
<CollectionOptionTitle>TNTCollection</CollectionOptionTitle>
<CollectionCharge>14.57</CollectionCharge>
<SameDayCollectionCutOffTime>15:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
<ServiceResultCollectionOption>
<CollectionOptionID>5</CollectionOptionID>
<CollectionOptionTitle>UPSCollection</CollectionOptionTitle>
<CollectionCharge>9.48</CollectionCharge>
<SameDayCollectionCutOffTime>12:00</SameDayCollectionCutOffTime>
<ExpectedLabel>
<LabelRole>Collection</LabelRole>
<LabelFormat>PDF</LabelFormat>
<LabelGenerateStatus>LabelGenerated</LabelGenerateStatus>
<AvailableSizes>
<LabelSize>
<Size>A4</Size>
</LabelSize>
<LabelSize>
<Size>Thermal</Size>
</LabelSize>
</AvailableSizes>
</ExpectedLabel>
</ServiceResultCollectionOption>
</CollectionOptions>
<ServiceType>Air</ServiceType>
</ServiceQuoteResult>
</ServiceResults>
</GetQuoteResponse>
{
"Status": "FAIL",
"Notifications": [
{
"Message": "ItemType is required",
"Severity": "ERROR"
},
{
"Message": "Package 1 Commodity 2: CommodityCode is required",
"Severity": "ERROR"
},
{
"Message": "Collection Address: AddressLineOne is required",
"Severity": "ERROR"
}
],
"QuoteID": 0,
"ServiceResults": []
}
<GetQuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.transglobalexpress.co.uk/API/V2">
<Status>FAIL</Status>
<Notifications>
<Notification>
<Message>ItemType is required</Message>
<Severity>ERROR</Severity>
</Notification>
<Notification>
<Message>Package 1 Commodity 2: CommodityCode is required</Message>
<Severity>ERROR</Severity>
</Notification>
<Notification>
<Message>Collection Address: AddressLineOne is required</Message>
<Severity>ERROR</Severity>
</Notification>
</Notifications>
<QuoteID>0</QuoteID>
<ServiceResults />
</GetQuoteResponse>
| Property Name | Data Type | Parent | M | Comment | Example |
|---|---|---|---|---|---|
| GetQuoteResponse | string | M |
The root element of the response. When returning JSON this is not explicitly named but is instead the object container of the response. |
SUCCESS | |
| Status | string | GetQuoteResponse | M |
The status indicating whe success of the request. Possible values are: SUCCESS, PARTIAL, FAIL, ERROR |
SUCCESS |
| Notifications | Container | GetQuoteResponse | M |
The container for list of notifications. Can be empty. |
|
| Notification | |||||
| Notification | Container | Notifications | M |
The container for notifications information. When using JSON this element is not explicitly named, instead the Notifications property is a list of anonymous objects containing the notification data. |
|
| Message | string | Notification | M | The notification message. | Authentication Failed |
| Severity | string | Notification | M | The notification severity level. | ERROR |
| QuoteID | integer | GetQuoteResponse | M |
The quote id that can be used to book a service contained in the
results via the book section of the API. If the quote request fails the quote id will be 0 and will not be usable. |
160 |
| ServiceResults | |||||
| ServiceResults | Container | GetQuoteResponse | M | The container for the list of service results. | |
| ServiceQuoteResult | Container | ServiceResults | M |
The container for the service result. When using JSON this element is not explicitly named, instead the ServiceResults property is a list of anonymous objects containing the service result data. |
|
| ServiceID | integer | ServiceQuoteResult | M | The service id. This value is used to identify the service to be booked when placing an order via the book section of the API. | 53 |
| ServiceName | string | ServiceQuoteResult | M | The service name. | TG Express Worldwide |
| CarrierName | string | ServiceQuoteResult | M | The carrier name. | DHL |
| ChargeableWeight | string | ServiceQuoteResult | M | The chargeable weight the freight pricing is based on. Each carrier has a formula for calculating the "volumetric" weight of a consignment. The chargeable is the greater of the stated and volumetric weights. | 18.58 |
| TransitTimeEstimate | string | ServiceQuoteResult | O | The transit time estimate. | 1-2 days |
| SameDayCollectionCutOffTime | string | ServiceResultCollectionOption | O |
The cut off time for placing a same day collection. This will only be returned if we have access to the information and the cut off time has not already passed at the time of getting the quote. |
14:30 |
| IsWarehouseService | boolean | ServiceQuoteResult | M |
Indicates whether or not the service is a "warehouse service". A warehouse service means the consignment will first have to come to our warehouse depot before being sent on to the final destination, either by collection if a collection is booked or by some other means if a collection is not booked. |
true |
| TotalCost | |||||
| TotalCost | Container | GetQuoteResponse | M | The container for the total cost summary. | |
| TotalCostNetWithCollection | decimal | TotalCost | M | The total cost net value when including collection cost. | 25.00 |
| TotalCostNetWithoutCollection | decimal | TotalCost | M | The total cost net value when excluding collection cost. | 20.00 |
| TotalCostGrossWithCollection | decimal | TotalCost | M | The total cost gross value when including collection cost. | 30.00 |
| TotalCostGrossWithoutCollection | decimal | TotalCost | M | The total cost gross value when excluding collection cost. | 24.00 |
| ServicePriceBreakdown | |||||
| ServicePriceBreakdown | Container | ServiceQuoteResult | M |
The container for the service price breakdown. Items within this container show a break down of how the values in TotalCost where calculated. |
|
| PriceElement | Container | ServicePriceBreakdown | M |
The container for price element data. When using JSON this element is not explicitly named, instead the ServicePriceBreakdown property is a list of anonymous objects containing the price element data. |
|
| Code | string | PriceElement | M | The code identifier for the price element. | FRT |
| Description | string | PriceElement | M | The price element description. | Freight Charge |
| Cost | string | PriceElement | M |
The price element cost. The cost is Net value. |
7.51 |
| OptionalExtras | |||||
| OptionalExtras | Container | ServiceQuoteResult | M |
The container for optional extras that can be booked. The elements within this container are not included as part of the TotalCost price figures, and the cost of any element selected at time of booking will be added onto the amount you are billed for the order. |
|
| PriceElement | Container | OptionalExtras | M |
The container for price element data. When using JSON this element is not explicitly named, instead the OptionalExtras property is a list of anonymous objects containing the price element data. |
|
| Code | string | PriceElement | M | The code identifier for the price element. | INS |
| Description | string | PriceElement | M | The price element description. | Transit Insurance |
| Cost | string | PriceElement | M |
The price element cost. The cost is Net value. |
5.00 |
| SignatureRequiredAvailable | boolean | ServiceQuoteResult | M | Indicates whether or not the signature required option is available. | true |
| ExpectedLabels | |||||
| ExpectedLabels | Container | ServiceQuoteResult | M |
Container for data pertaining what labels can be expected upon a successful booking. While in most cases when placing a successful order a label would be immediately available for you to download and print, this is not always the case. There are services that don't return a label (at time of writing instances of these would only ever be a "warehouse service"), and there are times when returning a label would be conditional. An example of this is when booking certain warehouses, a primary label will only be returned if a collection is not booked. If a collection is booked, the collection label is returned, and the primary label will be printed and attached by Transglobal Express once the consignmnt reaches our warehouse depot. To manage expectations of what you are expecting to see in a response, this section indicates what labels you should expect to receive upon a successful booking and the roles they play in the shipment. |
|
| ExpectedLabel | Container | ExpectedLabels | M |
The container for expected label data. When using JSON this element is not explicitly named, instead the ExpectedLabels property is a list of anonymous objects containing the expected label data. |
|
| LabelRole | string | ExpectedLabel | M |
The role the label plays within the shipment. The options are: Primary, Collection. |
Primary |
| LabelFormat | string | ExpectedLabel | M |
The format the label will be returned in. Currently labels are all returned in PDF format. |
|
| LabelGenerateStatus | string | ExpectedLabel | M |
The status indicating whether or not the label is expected in
the response. The options are: LabelGenerated - The label will be generated and returned in the response. Conditional - The label is not guaranteed to be returned in the response. NoLabel - The label will not be returned in the response. |
LabelGenerated |
| AvailableSizes | Container | ExpectedLabel | M | The container for the available sizes of the expected label. | |
| LabelSize | Container | AvailableSizes | M |
The container for label size data. When using JSON this element is not explicitly named, instead the AvailableSizes property is a list of anonymous objects containing the expected label data. If the LabelGenerateStatus is "Conditional" or "NoLabel" Then no items will be contained within this collection, as either no label will be generated (and as such sizes don't apply) or it is not known whether or not whether or not a label will be generated (likely to be the case when defining the expected collection label for a service with different collection options) |
|
| Size | Container | LabelSize | M | The label Size. Options are "A4" or "Thermal". | A4 |
| CollectionOptions | |||||
| CollectionOptions | Container | ServiceQuoteResult | O | The container for the service collection options. | |
| ServiceResultCollectionOption | Container | CollectionOptions | M |
The container for the service collection option data. When using JSON this element is not explicitly named, instead the CollectionOptions property is a list of anonymous objects containing the service collection option data. |
|
| CollectionOptionID | integer | ServiceResultCollectionOption | M |
The collection option id. This value is used to explicitly select the collection option when placing an order. |
1 |
| CollectionOptionTitle | string | ServiceResultCollectionOption | M | The collection option name. | TNTCollection |
| CollectionCharge | decimal | ServiceResultCollectionOption | M | The collection option cost (net). | 14.57 |
| SameDayCollectionCutOffTime | string | ServiceResultCollectionOption | O |
The cut off time for placing a same day collection. This will only be returned if we have access to the information and the cut off time has not already passed at the time of getting the quote. |
14:30 |
| ExpectedLabel | Container | ServiceResultCollectionOption | M | The container for expected label data. | |
| LabelRole | string | ExpectedLabel | M |
The role the label plays within the shipment. The options are: Primary, Collection. |
Primary |
| LabelFormat | string | ExpectedLabel | M |
The format the label will be returned in. Currently labels are all returned in PDF format. |
|
| LabelGenerateStatus | string | ExpectedLabel | M |
The status indicating whether or not the label is expected in
the response. The options are: LabelGenerated - The label will be generated and returned in the response. NoLabel - The label will not be returned in the response. |
LabelGenerated |
| ServiceType | string | ServiceQuoteResult | M |
The type of service The options are: Air - Air service. Road - Road service. AirAndRoad - Air and/or Road service. |
LabelGenerated |