PowerBuilder / DHL Express APIs (MyDHL API) / Retrieve Rates for a one piece Shipment
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "<Basic Auth Username>"
loo_Http.Password = "<Basic Auth Password>"
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("accountNumber","Ut aliqua")
loo_QueryParams.UpdateString("originCountryCode","CZ")
loo_QueryParams.UpdateInt("originPostalCode",14800)
loo_QueryParams.UpdateString("originCityName","Prague")
loo_QueryParams.UpdateString("destinationCountryCode","CZ")
loo_QueryParams.UpdateInt("destinationPostalCode",14800)
loo_QueryParams.UpdateString("destinationCityName","Prague")
loo_QueryParams.UpdateString("weight","502356858543.692")
loo_QueryParams.UpdateString("length","1581008670.588")
loo_QueryParams.UpdateString("width","335941494.827")
loo_QueryParams.UpdateString("height","1808157249.254")
loo_QueryParams.UpdateString("plannedShippingDate","2020-02-26")
loo_QueryParams.UpdateString("isCustomsDeclarable","false")
loo_QueryParams.UpdateString("unitOfMeasurement","metric")
loo_QueryParams.UpdateString("nextBusinessDay","false")
loo_QueryParams.UpdateString("strictValidation","false")
loo_QueryParams.UpdateString("getAllValueAddedServices","false")
loo_QueryParams.UpdateString("requestEstimatedDeliveryDate","true")
loo_QueryParams.UpdateString("estimatedDeliveryDateType","QDDF")
loo_Http.SetRequestHeader("Webstore-Platform-Name","")
loo_Http.SetRequestHeader("Shipping-System-Platform-Name","")
loo_Http.SetRequestHeader("Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13")
loo_Http.SetRequestHeader("Plugin-Version","")
loo_Http.SetRequestHeader("Plugin-Name","")
loo_Http.SetRequestHeader("Shipping-System-Platform-Version","")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Http.SetRequestHeader("Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT")
loo_Http.SetRequestHeader("Webstore-Platform-Version","")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api-mock.dhl.com/mydhlapi/rates",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "accountNumber=Ut%20aliqua"
-d "originCountryCode=CZ"
-d "originPostalCode=14800"
-d "originCityName=Prague"
-d "destinationCountryCode=CZ"
-d "destinationPostalCode=14800"
-d "destinationCityName=Prague"
-d "weight=502356858543.692"
-d "length=1581008670.588"
-d "width=335941494.827"
-d "height=1808157249.254"
-d "plannedShippingDate=2020-02-26"
-d "isCustomsDeclarable=false"
-d "unitOfMeasurement=metric"
-d "nextBusinessDay=false"
-d "strictValidation=false"
-d "getAllValueAddedServices=false"
-d "requestEstimatedDeliveryDate=true"
-d "estimatedDeliveryDateType=QDDF"
-u '<Basic Auth Username>:<Basic Auth Password>'
-H "Message-Reference: d0e7832e-5c98-11ea-bc55-0242ac13"
-H "Message-Reference-Date: Wed, 21 Oct 2015 07:28:00 GMT"
-H "Plugin-Name: "
-H "Plugin-Version: "
-H "Shipping-System-Platform-Name: "
-H "Shipping-System-Platform-Version: "
-H "Webstore-Platform-Name: "
-H "Webstore-Platform-Version: "
-H "Accept: application/json"
https://api-mock.dhl.com/mydhlapi/rates
Postman Collection Item JSON
{
"name": "Retrieve Rates for a one piece Shipment",
"request": {
"method": "GET",
"header": [
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/rates?accountNumber=Ut aliqua&originCountryCode=CZ&originPostalCode=14800&originCityName=Prague&destinationCountryCode=CZ&destinationPostalCode=14800&destinationCityName=Prague&weight=502356858543.692&length=1581008670.588&width=335941494.827&height=1808157249.254&plannedShippingDate=2020-02-26&isCustomsDeclarable=false&unitOfMeasurement=metric&nextBusinessDay=false&strictValidation=false&getAllValueAddedServices=false&requestEstimatedDeliveryDate=true&estimatedDeliveryDateType=QDDF",
"host": [
"{{baseUrl}}"
],
"path": [
"rates"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua",
"description": "(Required) DHL Express customer account number"
},
{
"key": "originCountryCode",
"value": "CZ",
"description": "(Required) A short text string code (see values defined in ISO 3166) specifying the shipment origin country. https://gs1.org/voc/Country, Alpha-2 Code"
},
{
"key": "originPostalCode",
"value": "14800",
"description": "Text specifying the postal code for an address. https://gs1.org/voc/postalCode"
},
{
"key": "originCityName",
"value": "Prague",
"description": "(Required) Text specifying the city name"
},
{
"key": "destinationCountryCode",
"value": "CZ",
"description": "(Required) A short text string code (see values defined in ISO 3166) specifying the shipment destination country. https://gs1.org/voc/Country, Alpha-2 Code"
},
{
"key": "destinationPostalCode",
"value": "14800",
"description": "Text specifying the postal code for an address. https://gs1.org/voc/postalCode"
},
{
"key": "destinationCityName",
"value": "Prague",
"description": "(Required) Text specifying the city name"
},
{
"key": "weight",
"value": "502356858543.692",
"description": "(Required) Gross weight of the shipment including packaging."
},
{
"key": "length",
"value": "1581008670.588",
"description": "(Required) Total length of the shipment including packaging."
},
{
"key": "width",
"value": "335941494.827",
"description": "(Required) Total width of the shipment including packaging."
},
{
"key": "height",
"value": "1808157249.254",
"description": "(Required) Total height of the shipment including packaging."
},
{
"key": "plannedShippingDate",
"value": "2020-02-26",
"description": "(Required) Timestamp represents the date you plan to ship your prospected shipment\n"
},
{
"key": "isCustomsDeclarable",
"value": "false",
"description": "(Required) "
},
{
"key": "unitOfMeasurement",
"value": "metric",
"description": "(Required) The UnitOfMeasurement node conveys the unit of measurements used in the operation. This single value corresponds to the units of weight and measurement which are used throughout the message processing.\n"
},
{
"key": "nextBusinessDay",
"value": "false",
"description": "When set to true and there are no products available for given plannedShippingDate then products available for the next possible pickup date are returned\n"
},
{
"key": "strictValidation",
"value": "false",
"description": "If set to true, indicate strict DCT validation of address details, and validation of product and service(s) combination provided in request."
},
{
"key": "getAllValueAddedServices",
"value": "false",
"description": "Option to return list of all value added services and its rule groups if applicable"
},
{
"key": "requestEstimatedDeliveryDate",
"value": "true",
"description": "Option to return Estimated Delivery Date in response"
},
{
"key": "estimatedDeliveryDateType",
"value": "QDDF",
"description": "Estimated Delivery Date Type. QDDF: is the fastest 'docs' transit time as quoted to the customer at booking or shipment creation. No custom clearance is considered. QDDC: constitutes DHL's service commitment as quoted at booking or shipment creation. QDDc builds in clearance time, and potentially other special perational non-transport component(s), when relevant. "
}
]
},
"description": "The Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)\n"
},
"response": [
{
"name": "Rates found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"url": {
"raw": "{{baseUrl}}/rates?accountNumber=Ut aliqua&originCountryCode=CZ&originPostalCode=14800&originCityName=Prague&destinationCountryCode=CZ&destinationPostalCode=14800&destinationCityName=Prague&weight=502356858543.692&length=1581008670.588&width=335941494.827&height=1808157249.254&plannedShippingDate=2020-02-26&isCustomsDeclarable=false&unitOfMeasurement=metric&nextBusinessDay=false&strictValidation=false&getAllValueAddedServices=false&requestEstimatedDeliveryDate=true&estimatedDeliveryDateType=QDDF",
"host": [
"{{baseUrl}}"
],
"path": [
"rates"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua"
},
{
"key": "originCountryCode",
"value": "CZ"
},
{
"key": "originPostalCode",
"value": "14800"
},
{
"key": "originCityName",
"value": "Prague"
},
{
"key": "destinationCountryCode",
"value": "CZ"
},
{
"key": "destinationPostalCode",
"value": "14800"
},
{
"key": "destinationCityName",
"value": "Prague"
},
{
"key": "weight",
"value": "502356858543.692"
},
{
"key": "length",
"value": "1581008670.588"
},
{
"key": "width",
"value": "335941494.827"
},
{
"key": "height",
"value": "1808157249.254"
},
{
"key": "plannedShippingDate",
"value": "2020-02-26"
},
{
"key": "isCustomsDeclarable",
"value": "false"
},
{
"key": "unitOfMeasurement",
"value": "metric"
},
{
"key": "nextBusinessDay",
"value": "false"
},
{
"key": "strictValidation",
"value": "false"
},
{
"key": "getAllValueAddedServices",
"value": "false"
},
{
"key": "requestEstimatedDeliveryDate",
"value": "true"
},
{
"key": "estimatedDeliveryDateType",
"value": "QDDF"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"products\": [\n {\n \"weight\": {\n \"volumetric\": 0,\n \"provided\": 1.5,\n \"unitOfMeasurement\": \"metric\"\n },\n \"totalPrice\": [\n {\n \"price\": 141.51,\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\"\n },\n {\n \"price\": 141.51,\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\"\n }\n ],\n \"productName\": \"EXPRESS DOMESTIC\",\n \"productCode\": \"N\",\n \"localProductCode\": \"N\",\n \"localProductCountryCode\": \"CZ\",\n \"networkTypeCode\": \"TD\",\n \"isCustomerAgreement\": false,\n \"totalPriceBreakdown\": [\n {\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\",\n \"priceBreakdown\": [\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n },\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n }\n ]\n },\n {\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\",\n \"priceBreakdown\": [\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n },\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n }\n ]\n }\n ],\n \"detailedPriceBreakdown\": [\n {\n \"priceCurrency\": \"GBP\",\n \"currencyType\": \"BILLC\",\n \"breakdown\": [\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"esse sed exercitation commodo\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n },\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"adi\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n }\n ]\n },\n {\n \"priceCurrency\": \"GBP\",\n \"currencyType\": \"BILLC\",\n \"breakdown\": [\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"ut adipisicing\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n },\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"in incididunt\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n }\n ]\n }\n ],\n \"serviceCodeMutuallyExclusiveGroups\": [\n {\n \"serviceCodeRuleName\": \"Exclusive Billing Services\",\n \"description\": \"Mutually exclusive Billing Services - shipment can contain just one of following\",\n \"serviceCodes\": [\n {\n \"serviceCode\": \"PZ\"\n },\n {\n \"serviceCode\": \"PZ\"\n }\n ]\n },\n {\n \"serviceCodeRuleName\": \"Exclusive Billing Services\",\n \"description\": \"Mutually exclusive Billing Services - shipment can contain just one of following\",\n \"serviceCodes\": [\n {\n \"serviceCode\": \"PZ\"\n },\n {\n \"serviceCode\": \"PZ\"\n }\n ]\n }\n ],\n \"serviceCodeDependencyRuleGroups\": [\n {\n \"dependentServiceCode\": \"PZ\",\n \"dependencyRuleGroup\": [\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n },\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ]\n },\n {\n \"dependentServiceCode\": \"PZ\",\n \"dependencyRuleGroup\": [\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n },\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ]\n }\n ],\n \"pickupCapabilities\": {\n \"nextBusinessDay\": false,\n \"localCutoffDateAndTime\": \"2019-09-18T15:00:00\",\n \"GMTCutoffTime\": \"16:00:00\",\n \"pickupEarliest\": \"09:30:00\",\n \"pickupLatest\": \"16:00:00\",\n \"originServiceAreaCode\": \"ELA\",\n \"originFacilityAreaCode\": \"HHR\",\n \"pickupAdditionalDays\": 0,\n \"pickupDayOfWeek\": 3\n },\n \"deliveryCapabilities\": {\n \"deliveryTypeCode\": \"QDDC\",\n \"estimatedDeliveryDateAndTime\": \"2019-09-20T12:00:00\",\n \"destinationServiceAreaCode\": \"PRG\",\n \"destinationFacilityAreaCode\": \"PR3\",\n \"deliveryAdditionalDays\": 0,\n \"deliveryDayOfWeek\": 5,\n \"totalTransitDays\": 2\n },\n \"items\": {},\n \"pricingDate\": \"2020-02-25\"\n },\n {\n \"weight\": {\n \"volumetric\": 0,\n \"provided\": 1.5,\n \"unitOfMeasurement\": \"metric\"\n },\n \"totalPrice\": [\n {\n \"price\": 141.51,\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\"\n },\n {\n \"price\": 141.51,\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\"\n }\n ],\n \"productName\": \"EXPRESS DOMESTIC\",\n \"productCode\": \"N\",\n \"localProductCode\": \"N\",\n \"localProductCountryCode\": \"CZ\",\n \"networkTypeCode\": \"TD\",\n \"isCustomerAgreement\": false,\n \"totalPriceBreakdown\": [\n {\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\",\n \"priceBreakdown\": [\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n },\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n }\n ]\n },\n {\n \"currencyType\": \"BILLC\",\n \"priceCurrency\": \"GBP\",\n \"priceBreakdown\": [\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n },\n {\n \"typeCode\": \"SPRQT\",\n \"price\": 114.92\n }\n ]\n }\n ],\n \"detailedPriceBreakdown\": [\n {\n \"priceCurrency\": \"GBP\",\n \"currencyType\": \"BILLC\",\n \"breakdown\": [\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"culpa dolor adipisicing dolore\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n },\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"in sit commodo anim\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n }\n ]\n },\n {\n \"priceCurrency\": \"GBP\",\n \"currencyType\": \"BILLC\",\n \"breakdown\": [\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"irure et\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n },\n {\n \"name\": \"12:00 PREMIUM\",\n \"serviceCode\": \"YK\",\n \"localServiceCode\": \"YK\",\n \"typeCode\": \"sit tempor mollit dolor\",\n \"serviceTypeCode\": \"SCH\",\n \"price\": 5,\n \"priceCurrency\": \"GBP\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false,\n \"priceBreakdown\": [\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"priceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"price\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"rate\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"basePrice\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"tariffRateFormula\": \"((0.3464 % COST) MAX (528.33))\"\n }\n ]\n }\n ],\n \"serviceCodeMutuallyExclusiveGroups\": [\n {\n \"serviceCodeRuleName\": \"Exclusive Billing Services\",\n \"description\": \"Mutually exclusive Billing Services - shipment can contain just one of following\",\n \"serviceCodes\": [\n {\n \"serviceCode\": \"PZ\"\n },\n {\n \"serviceCode\": \"PZ\"\n }\n ]\n },\n {\n \"serviceCodeRuleName\": \"Exclusive Billing Services\",\n \"description\": \"Mutually exclusive Billing Services - shipment can contain just one of following\",\n \"serviceCodes\": [\n {\n \"serviceCode\": \"PZ\"\n },\n {\n \"serviceCode\": \"PZ\"\n }\n ]\n }\n ],\n \"serviceCodeDependencyRuleGroups\": [\n {\n \"dependentServiceCode\": \"PZ\",\n \"dependencyRuleGroup\": [\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n },\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ]\n },\n {\n \"dependentServiceCode\": \"PZ\",\n \"dependencyRuleGroup\": [\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n },\n {\n \"dependencyRuleName\": \"Labelfree and PLT rule\",\n \"dependencyDescription\": \"Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly\",\n \"dependencyCondition\": \"Must provide the requiredServiceCode if it is allowed for the productCode\",\n \"requiredServiceCodes\": [\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"serviceCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ]\n }\n ],\n \"pickupCapabilities\": {\n \"nextBusinessDay\": false,\n \"localCutoffDateAndTime\": \"2019-09-18T15:00:00\",\n \"GMTCutoffTime\": \"16:00:00\",\n \"pickupEarliest\": \"09:30:00\",\n \"pickupLatest\": \"16:00:00\",\n \"originServiceAreaCode\": \"ELA\",\n \"originFacilityAreaCode\": \"HHR\",\n \"pickupAdditionalDays\": 0,\n \"pickupDayOfWeek\": 3\n },\n \"deliveryCapabilities\": {\n \"deliveryTypeCode\": \"QDDC\",\n \"estimatedDeliveryDateAndTime\": \"2019-09-20T12:00:00\",\n \"destinationServiceAreaCode\": \"PRG\",\n \"destinationFacilityAreaCode\": \"PR3\",\n \"deliveryAdditionalDays\": 0,\n \"deliveryDayOfWeek\": 5,\n \"totalTransitDays\": 2\n },\n \"items\": {},\n \"pricingDate\": \"2020-02-25\"\n }\n ],\n \"exchangeRates\": [\n {\n \"currentExchangeRate\": 1.188411,\n \"currency\": \"GBP\",\n \"baseCurrency\": \"EUR\"\n },\n {\n \"currentExchangeRate\": 1.188411,\n \"currency\": \"GBP\",\n \"baseCurrency\": \"EUR\"\n }\n ],\n \"warnings\": [\n \"Price can't be calculated\",\n \"Price can't be calculated\"\n ]\n}"
},
{
"name": "Wrong input parameters",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"url": {
"raw": "{{baseUrl}}/rates?accountNumber=Ut aliqua&originCountryCode=CZ&originPostalCode=14800&originCityName=Prague&destinationCountryCode=CZ&destinationPostalCode=14800&destinationCityName=Prague&weight=502356858543.692&length=1581008670.588&width=335941494.827&height=1808157249.254&plannedShippingDate=2020-02-26&isCustomsDeclarable=false&unitOfMeasurement=metric&nextBusinessDay=false&strictValidation=false&getAllValueAddedServices=false&requestEstimatedDeliveryDate=true&estimatedDeliveryDateType=QDDF",
"host": [
"{{baseUrl}}"
],
"path": [
"rates"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua"
},
{
"key": "originCountryCode",
"value": "CZ"
},
{
"key": "originPostalCode",
"value": "14800"
},
{
"key": "originCityName",
"value": "Prague"
},
{
"key": "destinationCountryCode",
"value": "CZ"
},
{
"key": "destinationPostalCode",
"value": "14800"
},
{
"key": "destinationCityName",
"value": "Prague"
},
{
"key": "weight",
"value": "502356858543.692"
},
{
"key": "length",
"value": "1581008670.588"
},
{
"key": "width",
"value": "335941494.827"
},
{
"key": "height",
"value": "1808157249.254"
},
{
"key": "plannedShippingDate",
"value": "2020-02-26"
},
{
"key": "isCustomsDeclarable",
"value": "false"
},
{
"key": "unitOfMeasurement",
"value": "metric"
},
{
"key": "nextBusinessDay",
"value": "false"
},
{
"key": "strictValidation",
"value": "false"
},
{
"key": "getAllValueAddedServices",
"value": "false"
},
{
"key": "requestEstimatedDeliveryDate",
"value": "true"
},
{
"key": "estimatedDeliveryDateType",
"value": "QDDF"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/rates\",\n \"detail\": \"The account number is not found or invalid. Please check the account number and retry.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
},
{
"name": "Process errors",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"url": {
"raw": "{{baseUrl}}/rates?accountNumber=Ut aliqua&originCountryCode=CZ&originPostalCode=14800&originCityName=Prague&destinationCountryCode=CZ&destinationPostalCode=14800&destinationCityName=Prague&weight=502356858543.692&length=1581008670.588&width=335941494.827&height=1808157249.254&plannedShippingDate=2020-02-26&isCustomsDeclarable=false&unitOfMeasurement=metric&nextBusinessDay=false&strictValidation=false&getAllValueAddedServices=false&requestEstimatedDeliveryDate=true&estimatedDeliveryDateType=QDDF",
"host": [
"{{baseUrl}}"
],
"path": [
"rates"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua"
},
{
"key": "originCountryCode",
"value": "CZ"
},
{
"key": "originPostalCode",
"value": "14800"
},
{
"key": "originCityName",
"value": "Prague"
},
{
"key": "destinationCountryCode",
"value": "CZ"
},
{
"key": "destinationPostalCode",
"value": "14800"
},
{
"key": "destinationCityName",
"value": "Prague"
},
{
"key": "weight",
"value": "502356858543.692"
},
{
"key": "length",
"value": "1581008670.588"
},
{
"key": "width",
"value": "335941494.827"
},
{
"key": "height",
"value": "1808157249.254"
},
{
"key": "plannedShippingDate",
"value": "2020-02-26"
},
{
"key": "isCustomsDeclarable",
"value": "false"
},
{
"key": "unitOfMeasurement",
"value": "metric"
},
{
"key": "nextBusinessDay",
"value": "false"
},
{
"key": "strictValidation",
"value": "false"
},
{
"key": "getAllValueAddedServices",
"value": "false"
},
{
"key": "requestEstimatedDeliveryDate",
"value": "true"
},
{
"key": "estimatedDeliveryDateType",
"value": "QDDF"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/rates\",\n \"detail\": \"999: Process failure occurred. Process ID associated for that transaction (1234567890)\",\n \"title\": \"Internal Server Error\",\n \"message\": \"Internal Server Error\",\n \"code\": \"500\"\n}"
}
]
}
