SQL Server / DHL Express APIs (MyDHL API) / Retrieve available DHL Express products for a one piece Shipment
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', '<Basic Auth Username>'
EXEC sp_OASetProperty @http, 'Password', '<Basic Auth Password>'
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'accountNumber', 'Ut aliqua'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'originCountryCode', 'CZ'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'originPostalCode', 14800
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'originCityName', 'Prague'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'destinationCountryCode', 'CZ'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'destinationPostalCode', 14800
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'destinationCityName', 'Prague'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'weight', '502356858543.692'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'length', '1581008670.588'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'width', '335941494.827'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'height', '1808157249.254'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'plannedShippingDate', '2020-02-26'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'isCustomsDeclarable', 'false'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'unitOfMeasurement', 'metric'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'nextBusinessDay', 'false'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'strictValidation', 'false'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'getAllValueAddedServices', 'false'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'requestEstimatedDeliveryDate', 'true'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'estimatedDeliveryDateType', 'QDDF'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Webstore-Platform-Name', ''
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Shipping-System-Platform-Name', ''
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Message-Reference', 'd0e7832e-5c98-11ea-bc55-0242ac13'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Plugin-Version', ''
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Plugin-Name', ''
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Shipping-System-Platform-Version', ''
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Message-Reference-Date', 'Wed, 21 Oct 2015 07:28:00 GMT'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Webstore-Platform-Version', ''
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api-mock.dhl.com/mydhlapi/products', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "products": [
-- {
-- "productName": "EXPRESS 12:00 DOC",
-- "productCode": "T",
-- "localProductCode": "T",
-- "localProductCountryCode": "US",
-- "networkTypeCode": "TD",
-- "isCustomerAgreement": false,
-- "weight": {
-- "volumetric": 100,
-- "provided": 50,
-- "unitOfMeasurement": "metric"
-- },
-- "breakdown": [
-- {
-- "name": "EXPRESS 12:00 DOC",
-- "serviceCode": "AB",
-- "localServiceCode": "AB",
-- "typeCode": "EXPRESS 12:00",
-- "serviceTypeCode": "XCH",
-- "isCustomerAgreement": false,
-- "isMarketedService": false,
-- "isBillingServiceIndicator": false
-- },
-- {
-- "name": "EXPRESS 12:00 DOC",
-- "serviceCode": "AB",
-- "localServiceCode": "AB",
-- "typeCode": "EXPRESS 12:00",
-- "serviceTypeCode": "XCH",
-- "isCustomerAgreement": false,
-- "isMarketedService": false,
-- "isBillingServiceIndicator": false
-- }
-- ],
-- "serviceCodeMutuallyExclusiveGroups": [
-- {
-- "serviceCodeRuleName": "Exclusive Billing Services",
-- "description": "Mutually exclusive Billing Services - shipment can contain just one of following",
-- "serviceCodes": [
-- {
-- "serviceCode": "PZ"
-- },
-- {
-- "serviceCode": "PZ"
-- }
-- ]
-- },
-- {
-- "serviceCodeRuleName": "Exclusive Billing Services",
-- "description": "Mutually exclusive Billing Services - shipment can contain just one of following",
-- "serviceCodes": [
-- {
-- "serviceCode": "PZ"
-- },
-- {
-- "serviceCode": "PZ"
-- }
-- ]
-- }
-- ],
-- "serviceCodeDependencyRuleGroups": [
-- {
-- "dependentServiceCode": "PZ",
-- "dependencyRuleGroup": [
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- },
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- }
-- ]
-- },
-- {
-- "dependentServiceCode": "PZ",
-- "dependencyRuleGroup": [
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- },
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- }
-- ]
-- }
-- ],
-- "pickupCapabilities": {
-- "nextBusinessDay": false,
-- "localCutoffDateAndTime": "2019-09-18T15:00:00",
-- "GMTCutoffTime": "16:00:00",
-- "pickupEarliest": "09:30:00",
-- "pickupLatest": "16:00:00",
-- "originServiceAreaCode": "ELA",
-- "originFacilityAreaCode": "ELA",
-- "pickupAdditionalDays": 0,
-- "pickupDayOfWeek": 3
-- },
-- "deliveryCapabilities": {
-- "deliveryTypeCode": "QDDC",
-- "estimatedDeliveryDateAndTime": "2019-09-20T12:00:00",
-- "destinationServiceAreaCode": "PRG",
-- "destinationFacilityAreaCode": "PR3",
-- "deliveryAdditionalDays": 0,
-- "deliveryDayOfWeek": 5,
-- "totalTransitDays": 2
-- }
-- },
-- {
-- "productName": "EXPRESS 12:00 DOC",
-- "productCode": "T",
-- "localProductCode": "T",
-- "localProductCountryCode": "US",
-- "networkTypeCode": "TD",
-- "isCustomerAgreement": false,
-- "weight": {
-- "volumetric": 100,
-- "provided": 50,
-- "unitOfMeasurement": "metric"
-- },
-- "breakdown": [
-- {
-- "name": "EXPRESS 12:00 DOC",
-- "serviceCode": "AB",
-- "localServiceCode": "AB",
-- "typeCode": "EXPRESS 12:00",
-- "serviceTypeCode": "XCH",
-- "isCustomerAgreement": false,
-- "isMarketedService": false,
-- "isBillingServiceIndicator": false
-- },
-- {
-- "name": "EXPRESS 12:00 DOC",
-- "serviceCode": "AB",
-- "localServiceCode": "AB",
-- "typeCode": "EXPRESS 12:00",
-- "serviceTypeCode": "XCH",
-- "isCustomerAgreement": false,
-- "isMarketedService": false,
-- "isBillingServiceIndicator": false
-- }
-- ],
-- "serviceCodeMutuallyExclusiveGroups": [
-- {
-- "serviceCodeRuleName": "Exclusive Billing Services",
-- "description": "Mutually exclusive Billing Services - shipment can contain just one of following",
-- "serviceCodes": [
-- {
-- "serviceCode": "PZ"
-- },
-- {
-- "serviceCode": "PZ"
-- }
-- ]
-- },
-- {
-- "serviceCodeRuleName": "Exclusive Billing Services",
-- "description": "Mutually exclusive Billing Services - shipment can contain just one of following",
-- "serviceCodes": [
-- {
-- "serviceCode": "PZ"
-- },
-- {
-- "serviceCode": "PZ"
-- }
-- ]
-- }
-- ],
-- "serviceCodeDependencyRuleGroups": [
-- {
-- "dependentServiceCode": "PZ",
-- "dependencyRuleGroup": [
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- },
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- }
-- ]
-- },
-- {
-- "dependentServiceCode": "PZ",
-- "dependencyRuleGroup": [
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- },
-- {
-- "dependencyRuleName": "Labelfree and PLT rule",
-- "dependencyDescription": "Labelfree requires Paperless Trade (PLT) only if PLT is allowed for product globaly",
-- "dependencyCondition": "Must provide the requiredServiceCode if it is allowed for the productCode",
-- "requiredServiceCodes": [
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "serviceCode": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ]
-- }
-- ]
-- }
-- ],
-- "pickupCapabilities": {
-- "nextBusinessDay": false,
-- "localCutoffDateAndTime": "2019-09-18T15:00:00",
-- "GMTCutoffTime": "16:00:00",
-- "pickupEarliest": "09:30:00",
-- "pickupLatest": "16:00:00",
-- "originServiceAreaCode": "ELA",
-- "originFacilityAreaCode": "ELA",
-- "pickupAdditionalDays": 0,
-- "pickupDayOfWeek": 3
-- },
-- "deliveryCapabilities": {
-- "deliveryTypeCode": "QDDC",
-- "estimatedDeliveryDateAndTime": "2019-09-20T12:00:00",
-- "destinationServiceAreaCode": "PRG",
-- "destinationFacilityAreaCode": "PR3",
-- "deliveryAdditionalDays": 0,
-- "deliveryDayOfWeek": 5,
-- "totalTransitDays": 2
-- }
-- }
-- ],
-- "warnings": [
-- "Limited products capabilities",
-- "Limited products capabilities"
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @productName nvarchar(4000)
DECLARE @productCode nvarchar(4000)
DECLARE @localProductCode nvarchar(4000)
DECLARE @localProductCountryCode nvarchar(4000)
DECLARE @networkTypeCode nvarchar(4000)
DECLARE @isCustomerAgreement int
DECLARE @Volumetric int
DECLARE @Provided int
DECLARE @UnitOfMeasurement nvarchar(4000)
DECLARE @NextBusinessDay int
DECLARE @LocalCutoffDateAndTime nvarchar(4000)
DECLARE @GMTCutoffTime nvarchar(4000)
DECLARE @PickupEarliest nvarchar(4000)
DECLARE @PickupLatest nvarchar(4000)
DECLARE @OriginServiceAreaCode nvarchar(4000)
DECLARE @OriginFacilityAreaCode nvarchar(4000)
DECLARE @PickupAdditionalDays int
DECLARE @PickupDayOfWeek int
DECLARE @DeliveryTypeCode nvarchar(4000)
DECLARE @EstimatedDeliveryDateAndTime nvarchar(4000)
DECLARE @DestinationServiceAreaCode nvarchar(4000)
DECLARE @DestinationFacilityAreaCode nvarchar(4000)
DECLARE @DeliveryAdditionalDays int
DECLARE @DeliveryDayOfWeek int
DECLARE @TotalTransitDays int
DECLARE @j int
DECLARE @count_j int
DECLARE @name nvarchar(4000)
DECLARE @serviceCode nvarchar(4000)
DECLARE @localServiceCode nvarchar(4000)
DECLARE @typeCode nvarchar(4000)
DECLARE @serviceTypeCode nvarchar(4000)
DECLARE @isMarketedService int
DECLARE @isBillingServiceIndicator int
DECLARE @serviceCodeRuleName nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @k int
DECLARE @count_k int
DECLARE @dependentServiceCode nvarchar(4000)
DECLARE @dependencyRuleName nvarchar(4000)
DECLARE @dependencyDescription nvarchar(4000)
DECLARE @dependencyCondition nvarchar(4000)
DECLARE @json1 int
DECLARE @i1 int
DECLARE @count_i1 int
DECLARE @Value nvarchar(4000)
DECLARE @strVal nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'products'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @productName OUT, 'products[i].productName'
EXEC sp_OAMethod @jResp, 'StringOf', @productCode OUT, 'products[i].productCode'
EXEC sp_OAMethod @jResp, 'StringOf', @localProductCode OUT, 'products[i].localProductCode'
EXEC sp_OAMethod @jResp, 'StringOf', @localProductCountryCode OUT, 'products[i].localProductCountryCode'
EXEC sp_OAMethod @jResp, 'StringOf', @networkTypeCode OUT, 'products[i].networkTypeCode'
EXEC sp_OAMethod @jResp, 'BoolOf', @isCustomerAgreement OUT, 'products[i].isCustomerAgreement'
EXEC sp_OAMethod @jResp, 'IntOf', @Volumetric OUT, 'products[i].weight.volumetric'
EXEC sp_OAMethod @jResp, 'IntOf', @Provided OUT, 'products[i].weight.provided'
EXEC sp_OAMethod @jResp, 'StringOf', @UnitOfMeasurement OUT, 'products[i].weight.unitOfMeasurement'
EXEC sp_OAMethod @jResp, 'BoolOf', @NextBusinessDay OUT, 'products[i].pickupCapabilities.nextBusinessDay'
EXEC sp_OAMethod @jResp, 'StringOf', @LocalCutoffDateAndTime OUT, 'products[i].pickupCapabilities.localCutoffDateAndTime'
EXEC sp_OAMethod @jResp, 'StringOf', @GMTCutoffTime OUT, 'products[i].pickupCapabilities.GMTCutoffTime'
EXEC sp_OAMethod @jResp, 'StringOf', @PickupEarliest OUT, 'products[i].pickupCapabilities.pickupEarliest'
EXEC sp_OAMethod @jResp, 'StringOf', @PickupLatest OUT, 'products[i].pickupCapabilities.pickupLatest'
EXEC sp_OAMethod @jResp, 'StringOf', @OriginServiceAreaCode OUT, 'products[i].pickupCapabilities.originServiceAreaCode'
EXEC sp_OAMethod @jResp, 'StringOf', @OriginFacilityAreaCode OUT, 'products[i].pickupCapabilities.originFacilityAreaCode'
EXEC sp_OAMethod @jResp, 'IntOf', @PickupAdditionalDays OUT, 'products[i].pickupCapabilities.pickupAdditionalDays'
EXEC sp_OAMethod @jResp, 'IntOf', @PickupDayOfWeek OUT, 'products[i].pickupCapabilities.pickupDayOfWeek'
EXEC sp_OAMethod @jResp, 'StringOf', @DeliveryTypeCode OUT, 'products[i].deliveryCapabilities.deliveryTypeCode'
EXEC sp_OAMethod @jResp, 'StringOf', @EstimatedDeliveryDateAndTime OUT, 'products[i].deliveryCapabilities.estimatedDeliveryDateAndTime'
EXEC sp_OAMethod @jResp, 'StringOf', @DestinationServiceAreaCode OUT, 'products[i].deliveryCapabilities.destinationServiceAreaCode'
EXEC sp_OAMethod @jResp, 'StringOf', @DestinationFacilityAreaCode OUT, 'products[i].deliveryCapabilities.destinationFacilityAreaCode'
EXEC sp_OAMethod @jResp, 'IntOf', @DeliveryAdditionalDays OUT, 'products[i].deliveryCapabilities.deliveryAdditionalDays'
EXEC sp_OAMethod @jResp, 'IntOf', @DeliveryDayOfWeek OUT, 'products[i].deliveryCapabilities.deliveryDayOfWeek'
EXEC sp_OAMethod @jResp, 'IntOf', @TotalTransitDays OUT, 'products[i].deliveryCapabilities.totalTransitDays'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'products[i].breakdown'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'products[i].breakdown[j].name'
EXEC sp_OAMethod @jResp, 'StringOf', @serviceCode OUT, 'products[i].breakdown[j].serviceCode'
EXEC sp_OAMethod @jResp, 'StringOf', @localServiceCode OUT, 'products[i].breakdown[j].localServiceCode'
EXEC sp_OAMethod @jResp, 'StringOf', @typeCode OUT, 'products[i].breakdown[j].typeCode'
EXEC sp_OAMethod @jResp, 'StringOf', @serviceTypeCode OUT, 'products[i].breakdown[j].serviceTypeCode'
EXEC sp_OAMethod @jResp, 'BoolOf', @isCustomerAgreement OUT, 'products[i].breakdown[j].isCustomerAgreement'
EXEC sp_OAMethod @jResp, 'BoolOf', @isMarketedService OUT, 'products[i].breakdown[j].isMarketedService'
EXEC sp_OAMethod @jResp, 'BoolOf', @isBillingServiceIndicator OUT, 'products[i].breakdown[j].isBillingServiceIndicator'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'products[i].serviceCodeMutuallyExclusiveGroups'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @serviceCodeRuleName OUT, 'products[i].serviceCodeMutuallyExclusiveGroups[j].serviceCodeRuleName'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'products[i].serviceCodeMutuallyExclusiveGroups[j].description'
SELECT @k = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_k OUT, 'products[i].serviceCodeMutuallyExclusiveGroups[j].serviceCodes'
WHILE @k < @count_k
BEGIN
EXEC sp_OASetProperty @jResp, 'K', @k
EXEC sp_OAMethod @jResp, 'StringOf', @serviceCode OUT, 'products[i].serviceCodeMutuallyExclusiveGroups[j].serviceCodes[k].serviceCode'
SELECT @k = @k + 1
END
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'products[i].serviceCodeDependencyRuleGroups'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @dependentServiceCode OUT, 'products[i].serviceCodeDependencyRuleGroups[j].dependentServiceCode'
SELECT @k = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_k OUT, 'products[i].serviceCodeDependencyRuleGroups[j].dependencyRuleGroup'
WHILE @k < @count_k
BEGIN
EXEC sp_OASetProperty @jResp, 'K', @k
EXEC sp_OAMethod @jResp, 'StringOf', @dependencyRuleName OUT, 'products[i].serviceCodeDependencyRuleGroups[j].dependencyRuleGroup[k].dependencyRuleName'
EXEC sp_OAMethod @jResp, 'StringOf', @dependencyDescription OUT, 'products[i].serviceCodeDependencyRuleGroups[j].dependencyRuleGroup[k].dependencyDescription'
EXEC sp_OAMethod @jResp, 'StringOf', @dependencyCondition OUT, 'products[i].serviceCodeDependencyRuleGroups[j].dependencyRuleGroup[k].dependencyCondition'
EXEC sp_OAMethod @jResp, 'ObjectOf', @json1 OUT, 'products[i].serviceCodeDependencyRuleGroups[j].dependencyRuleGroup[k]'
SELECT @i1 = 0
EXEC sp_OAMethod @json1, 'SizeOfArray', @count_i1 OUT, 'requiredServiceCodes'
WHILE @i1 < @count_i1
BEGIN
EXEC sp_OASetProperty @json1, 'I', @i1
EXEC sp_OAMethod @json1, 'StringOf', @Value OUT, 'requiredServiceCodes[i].serviceCode.value'
SELECT @i1 = @i1 + 1
END
EXEC @hr = sp_OADestroy @json1
SELECT @k = @k + 1
END
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'warnings'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'warnings[i]'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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/products
Postman Collection Item JSON
{
"name": "Retrieve available DHL Express products 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}}/products?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": [
"products"
],
"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 GET Products API will return DHL's product capabilities for a certain set of input data. \nUsing the shipper and receiver address as well as the dimension and weight of the piece belonging to a shipment, this operation returns the available products.\n"
},
"response": [
{
"name": "Products 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}}/products?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": [
"products"
],
"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 \"productName\": \"EXPRESS 12:00 DOC\",\n \"productCode\": \"T\",\n \"localProductCode\": \"T\",\n \"localProductCountryCode\": \"US\",\n \"networkTypeCode\": \"TD\",\n \"isCustomerAgreement\": false,\n \"weight\": {\n \"volumetric\": 100,\n \"provided\": 50,\n \"unitOfMeasurement\": \"metric\"\n },\n \"breakdown\": [\n {\n \"name\": \"EXPRESS 12:00 DOC\",\n \"serviceCode\": \"AB\",\n \"localServiceCode\": \"AB\",\n \"typeCode\": \"EXPRESS 12:00\",\n \"serviceTypeCode\": \"XCH\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false\n },\n {\n \"name\": \"EXPRESS 12:00 DOC\",\n \"serviceCode\": \"AB\",\n \"localServiceCode\": \"AB\",\n \"typeCode\": \"EXPRESS 12:00\",\n \"serviceTypeCode\": \"XCH\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false\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\": \"ELA\",\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 },\n {\n \"productName\": \"EXPRESS 12:00 DOC\",\n \"productCode\": \"T\",\n \"localProductCode\": \"T\",\n \"localProductCountryCode\": \"US\",\n \"networkTypeCode\": \"TD\",\n \"isCustomerAgreement\": false,\n \"weight\": {\n \"volumetric\": 100,\n \"provided\": 50,\n \"unitOfMeasurement\": \"metric\"\n },\n \"breakdown\": [\n {\n \"name\": \"EXPRESS 12:00 DOC\",\n \"serviceCode\": \"AB\",\n \"localServiceCode\": \"AB\",\n \"typeCode\": \"EXPRESS 12:00\",\n \"serviceTypeCode\": \"XCH\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false\n },\n {\n \"name\": \"EXPRESS 12:00 DOC\",\n \"serviceCode\": \"AB\",\n \"localServiceCode\": \"AB\",\n \"typeCode\": \"EXPRESS 12:00\",\n \"serviceTypeCode\": \"XCH\",\n \"isCustomerAgreement\": false,\n \"isMarketedService\": false,\n \"isBillingServiceIndicator\": false\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\": \"ELA\",\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 }\n ],\n \"warnings\": [\n \"Limited products capabilities\",\n \"Limited products capabilities\"\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}}/products?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": [
"products"
],
"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/products\",\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}}/products?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": [
"products"
],
"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/products\",\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}"
}
]
}
