DHL eCommerce UK API Virtual Sandbox
Manage UK domestic and international shipments, tracking, and logistics data.
The DHL eCommerce UK API provides endpoints for shipping label generation, shipment tracking, service point location, customs documentation, and driver pickup scheduling. It supports comprehensive logistics workflows including product capability lookups, shipment amendments, and label reprints for UK-based operations.
Use this hosted sandbox to simulate DHL eCommerce UK API APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready.
This keeps your integration code consistent across local development, QA, demos, and production.
Use cases:
Use this sandbox to validate shipment creation workflows, test label generation payloads, verify tracking status responses, simulate service point lookups, and handle customs document retrieval before integrating with DHL production logistics systems.
Access Token
POST
{
"client_id": "HtLvLw2Vm4ZtPIZrQvPsHez8",
"client_secret": "EWohrOtcZYH7q4HFjdJS5qmy6BLvIag1"
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Product capabilities API V1
GET
| Query Parameter Name | Example |
|---|---|
originCountryCode* | veniam consectetur |
originPostalCode* | ut tempor amet sit minim |
destinationCountryCode* | sit pariatur voluptate enim |
destinationPostalCode* | officia sunt mollit veniam |
destinationRecipientType* | residential |
destinationAddressType | servicePoint |
parcels* | 80165185.68355727 |
weight* | -2.7250957565479534e+38 |
length | -8.129127954170793e+37 |
width | 3.056462211980023e+38 |
height | 1.6158429324522589e+38 |
diameter | -2.9860459053908715e+38 |
internationalProductFilter | full |
accountTypes | ["internationalAir","internationalRoad","internationalRoad","internationalRoad"] |
doorstepDeliveryTypes | ["secureLocationDelivery","doorstepOnly"] |
currency | proident |
totalValue | -3.359648519257955e+38 |
pickupAccount | laborum Excepteur quis in elit |
exchangeOnDelivery | false |
{
"products": [
{
"productName": "DHL Parcel Connect",
"productNameForUI": "DHL Parcel Connect",
"productCode": "206",
"pickupCapabilities": {
"doorstepPickup": true,
"secureLocationPickup": false,
"servicePointDropOff": true,
"dropOffLabel": false
},
"deliveryCapabilities": {
"transitTimeDescription": "3-5 days",
"minTransitTime": 3,
"maxTransitTime": 5,
"servicePoint": true,
"servicePointLocationTypes": [
"servicepoint",
"locker"
],
"customsDeclaration": "full",
"inBoxReturn": true,
"bulky": false,
"accountType": "internationalRoad",
"neighbourDelivery": false,
"secureLocationDelivery": false,
"services": [
{
"name": "DHL Parcel Connect",
"serviceLevel": "international",
"orderedProduct": 206,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "18:00",
"servicePoint": true
}
],
"iossApplies": true,
"nonIossAllowed": false,
"iossDutiesPaid": "DDP",
"pallets": false,
"exchangeOnDelivery": false
},
"sortOrder": 0,
"dutiesPaidList": [
"DDP",
"DAP"
],
"reasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
}
]
},
{
"productName": "Parcel Neighbour",
"productNameForUI": "Parcel",
"productCode": "1",
"pickupCapabilities": {
"doorstepPickup": true,
"secureLocationPickup": true,
"servicePointDropOff": true,
"dropOffLabel": true
},
"deliveryCapabilities": {
"transitTimeDescription": "1 day",
"minTransitTime": 1,
"maxTransitTime": 1,
"servicePoint": true,
"servicePointLocationTypes": [
"servicepoint"
],
"customsDeclaration": "basic",
"inBoxReturn": true,
"bulky": false,
"accountType": "ukDomestic",
"neighbourDelivery": true,
"secureLocationDelivery": false,
"services": [
{
"name": "Next day",
"serviceLevel": "nextday",
"orderedProduct": 1,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "18:00",
"servicePoint": true
},
{
"name": "10:30",
"serviceLevel": "tenThirtyAm",
"orderedProduct": 9,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "10:30",
"servicePoint": false
},
{
"name": "12:00",
"serviceLevel": "am",
"orderedProduct": 2,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "12:00",
"servicePoint": false
},
{
"name": "Saturday",
"serviceLevel": "saturday",
"orderedProduct": 4,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "18:00",
"servicePoint": true
},
{
"name": "Saturday 10:30",
"serviceLevel": "saturday1030am",
"orderedProduct": 7,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "10:30",
"servicePoint": false
}
],
"iossApplies": false,
"nonIossAllowed": false,
"pallets": false,
"exchangeOnDelivery": false
},
"sortOrder": 1
},
{
"productName": "Bagit Large",
"productNameForUI": "Bagit Large",
"productCode": "260",
"pickupCapabilities": {
"doorstepPickup": true,
"secureLocationPickup": true,
"servicePointDropOff": true,
"dropOffLabel": true
},
"deliveryCapabilities": {
"transitTimeDescription": "1 day",
"minTransitTime": 1,
"maxTransitTime": 1,
"servicePoint": true,
"servicePointLocationTypes": [
"servicepoint"
],
"customsDeclaration": "none",
"inBoxReturn": true,
"bulky": false,
"accountType": "ukDomestic",
"neighbourDelivery": false,
"secureLocationDelivery": false,
"services": [
{
"name": "Next day",
"serviceLevel": "nextday",
"orderedProduct": 260,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "18:00",
"servicePoint": true
},
{
"name": "10:30",
"serviceLevel": "tenThirtyAm",
"orderedProduct": 262,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "10:30",
"servicePoint": false
},
{
"name": "12:00",
"serviceLevel": "am",
"orderedProduct": 261,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "12:00",
"servicePoint": false
},
{
"name": "Saturday",
"serviceLevel": "saturday",
"orderedProduct": 265,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "18:00",
"servicePoint": true
},
{
"name": "Saturday 10:30",
"serviceLevel": "saturday1030am",
"orderedProduct": 266,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "10:30",
"servicePoint": false
}
],
"iossApplies": false,
"nonIossAllowed": false,
"pallets": false,
"exchangeOnDelivery": true
},
"sortOrder": 2
}
],
"dutiesPaidAllProducts": [
"DDP",
"DAP"
],
"reasonForExportAllProducts": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
}
],
"iossDutiesPaidAllProducts": [
"DAP"
]
}[
{
"detail": "cillum nulla nisi",
"instance": "ex",
"status": 91885756.97889915,
"title": "nulla commodo laboris deserunt qui",
"type": "ut commodo minim qui"
},
{
"detail": "do aute mollit ut",
"instance": "dolor magna",
"status": 39332422.69648716,
"title": "deserunt",
"type": "do dolor ullamco dolore"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.ServicePoints(3 operations)
GET
| Query Parameter Name | Example |
|---|---|
country* | aI |
postalCode | minim |
address1 | dolore |
city | occaecat te |
locationTypes | ["ParcelShop","ParcelShop","ParcelShop","ParcelShop"] |
serviceType | parcel:drop-off-unregistered |
radius | -63441265.29363809 |
limit | -61281049.538495794 |
[
{
"id": "8003-4103535",
"servicePointId": "4103535",
"title": "Postfiliale 443",
"address": {
"locationType": "ParcelShop",
"companyName": "B+B Tabakwaren",
"address1": "Mönckebergstr. 7",
"address2": null,
"address3": null,
"city": "Hamburg",
"state": null,
"postalCode": 20095,
"country": "DE"
},
"latitude": "53.5512589",
"longitude": "10.0023976",
"distance": 16,
"parking": true,
"disabledAccess": true,
"openingHours": [
{
"dayDescription": "Monday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Tuesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Wednesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Thursday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Friday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Saturday",
"timeDescription": "09:00 - 18:00"
}
],
"closurePeriods": [
{
"reason": "holiday",
"dayDescription": "25/12/2021"
}
],
"serviceTypes": [
"parcel:pick-up",
"parcel:drop-off"
]
},
{
"id": "8003-4103537",
"servicePointId": "4103537",
"title": "Postfiliale 444",
"address": {
"locationType": "ParcelShop",
"companyName": "B+B Tabakwaren",
"address1": "Mönckebergstr. 11",
"address2": null,
"address3": null,
"city": "Hamburg",
"state": null,
"postalCode": 20096,
"country": "DE"
},
"latitude": "53.6512589",
"longitude": "10.0023976",
"distance": 16,
"parking": true,
"disabledAccess": true,
"openingHours": [
{
"dayDescription": "Monday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Tuesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Wednesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Thursday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Friday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Saturday",
"timeDescription": "09:00 - 18:00"
}
],
"closurePeriods": [
{
"reason": "holiday",
"dayDescription": "25/12/2021"
}
],
"serviceTypes": [
"parcel:pick-up",
"parcel:drop-off"
]
}
][
{
"detail": "aute est Ut sit",
"instance": "fugiat officia ut irure adipisicing",
"status": 83240841.36632112,
"title": "dolore",
"type": "ea"
},
{
"detail": "esse occaecat veniam exercitation",
"instance": "pariatur ipsum occaecat sed",
"status": -31784635.576861843,
"title": "consectetur fugiat et Duis",
"type": "dolore eu laborum dolor cillum"
},
{
"detail": "Excepteur quis culpa",
"instance": "officia qui quis exercitation laboris",
"status": 32070999.8632216,
"title": "ea fugiat dolor",
"type": "Ut ut adipisicing"
},
{
"detail": "nisi et ea est commodo",
"instance": "qui in laborum cillum",
"status": 9282210.824031398,
"title": "sunt enim ipsum pariatur",
"type": "in voluptate ex nostrud do"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
latitude* | -25.1481574540327 |
longitude* | 137.07315754456977 |
locationTypes | ["ParcelShop"] |
serviceType | parcel:pick-up |
radius | -52836193.88241513 |
limit | -15793941.22127159 |
[
{
"id": "8003-4103535",
"servicePointId": "4103535",
"title": "Postfiliale 443",
"address": {
"locationType": "ParcelShop",
"companyName": "B+B Tabakwaren",
"address1": "Mönckebergstr. 7",
"address2": null,
"address3": null,
"city": "Hamburg",
"state": null,
"postalCode": 20095,
"country": "DE"
},
"latitude": "53.5512589",
"longitude": "10.0023976",
"distance": 16,
"parking": true,
"disabledAccess": true,
"openingHours": [
{
"dayDescription": "Monday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Tuesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Wednesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Thursday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Friday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Saturday",
"timeDescription": "09:00 - 18:00"
}
],
"closurePeriods": [
{
"reason": "holiday",
"dayDescription": "25/12/2021"
}
],
"serviceTypes": [
"parcel:pick-up",
"parcel:drop-off"
]
},
{
"id": "8003-4103537",
"servicePointId": "4103537",
"title": "Postfiliale 444",
"address": {
"locationType": "ParcelShop",
"companyName": "B+B Tabakwaren",
"address1": "Mönckebergstr. 11",
"address2": null,
"address3": null,
"city": "Hamburg",
"state": null,
"postalCode": 20096,
"country": "DE"
},
"latitude": "53.6512589",
"longitude": "10.0023976",
"distance": 16,
"parking": true,
"disabledAccess": true,
"openingHours": [
{
"dayDescription": "Monday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Tuesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Wednesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Thursday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Friday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Saturday",
"timeDescription": "09:00 - 18:00"
}
],
"closurePeriods": [
{
"reason": "holiday",
"dayDescription": "25/12/2021"
}
],
"serviceTypes": [
"parcel:pick-up",
"parcel:drop-off"
]
}
][
{
"detail": "velit aliqua",
"instance": "sit",
"status": -1732131.9408350736,
"title": "ullamco sint exercitation ut",
"type": "ut reprehenderit et laboris pariatur"
},
{
"detail": "Ut",
"instance": "exercitation elit",
"status": -16598534.365749493,
"title": "sint",
"type": "culpa voluptate Lorem enim"
},
{
"detail": "labore dolore",
"instance": "incididunt sed nisi anim",
"status": 76074567.44740179,
"title": "magna proident Excepteur sint exercitation",
"type": "enim eu"
},
{
"detail": "enim ea laboris",
"instance": "eiusmod",
"status": -72813212.80838342,
"title": "laborum ad",
"type": "ut"
},
{
"detail": "sit occaecat",
"instance": "fugiat reprehenderit Excepteur",
"status": -85611971.09641019,
"title": "id Excepteur",
"type": "laboris sit nulla"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
{
"id": "8003-4103535",
"servicePointId": "4103535",
"title": "Postfiliale 443",
"address": {
"locationType": "ParcelShop",
"companyName": "B+B Tabakwaren",
"address1": "Mönckebergstr. 7",
"address2": null,
"address3": null,
"city": "Hamburg",
"state": null,
"postalCode": 20095,
"country": "DE"
},
"latitude": "53.5512589",
"longitude": "10.0023976",
"distance": 16,
"parking": true,
"disabledAccess": true,
"openingHours": [
{
"dayDescription": "Monday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Tuesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Wednesday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Thursday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Friday",
"timeDescription": "09:00 - 19:00"
},
{
"dayDescription": "Saturday",
"timeDescription": "09:00 - 18:00"
}
],
"closurePeriods": [
{
"reason": "holiday",
"dayDescription": "25/12/2021"
}
],
"serviceTypes": [
"parcel:pick-up",
"parcel:drop-off"
]
}[
{
"detail": "deserunt sit ipsum",
"instance": "in exercitation",
"status": -79511858.6568127,
"title": "do adipisicing",
"type": "cupidatat do amet"
},
{
"detail": "aliqua consequat anim nulla",
"instance": "et reprehenderit in cupidatat",
"status": 15873187.06256476,
"title": "qui",
"type": "officia Ut est"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Shipping Label API V1(3 operations)
POST
| Query Parameter Name | Example |
|---|---|
includeLabel | DROPOFF |
format | ZPL |
pageSize | A4 |
labelOrientation | portrait |
labelDPI | 203 |
includePickListLabel | false |
{
"pickupAccount": "F020579",
"dropoffType": "PICKUP",
"pickup": {
"date": "2022-12-10",
"accountAddress": true
},
"senderAddress": {
"companyName": "A Business",
"address1": "Unit A1",
"address2": "A Trading Estate",
"address3": "Binley",
"city": "Coventry",
"state": null,
"postalCode": "CV1 1AA",
"country": "GB",
"name": "A Despatch Manager",
"phone": "01215756756",
"email": "ADespatchManager@ABusiness.com"
},
"shipments": [
{
"consigneeAddress": {
"recipientType": "residential",
"addressType": "doorstep",
"companyName": null,
"address1": "Dun Roamin Cottage",
"address2": "12 Long Lane",
"address3": null,
"city": "Chipping Campden",
"state": "Gloucestershire",
"postalCode": "CV31 3PA",
"country": "GB",
"name": "A Recipient",
"phone": "099865556101",
"email": "A.Recipient@example.com"
},
"shipmentDetails": {
"customerRef1": "Order 1234",
"orderedProduct": "220",
"totalWeight": 20,
"totalPieces": 1,
"inBoxReturn": true,
"secureLocation": "Leave in green house at side of house"
},
"return": {
"customerRef1": "RMA 1234",
"returnAccount": "F020181"
},
"pieces": [
{
"declaredValue": 200.66,
"length": 20,
"width": 30,
"height": 28,
"weight": 20
}
]
}
]
}{
"shipments": {
"shipmentId": "JJD49055313895700000010",
"labels": [
"<Base64encoded Label Data 1>",
"<Base64encoded Label Data 2>"
]
}
}[
{
"detail": "qui",
"instance": "dolore nisi anim dolore",
"status": -34728257.49561137,
"title": "nulla elit reprehenderit laboris",
"type": "deserunt reprehenderit ipsum cillum consectetur"
},
{
"detail": "elit consectetur dolor",
"instance": "cillum dolore",
"status": 94474802.23845196,
"title": "in amet Excepteur anim ut",
"type": "velit ullamco exercitation nisi adipisicing"
},
{
"detail": "Ut consequat ipsum amet",
"instance": "tempor",
"status": -22590331.533764914,
"title": "sed esse proident",
"type": "occaecat ipsum ut fugiat eu"
},
{
"detail": "ipsum dolore",
"instance": "irure",
"status": -496520.7544263005,
"title": "mollit ad cillum sunt id",
"type": "enim nulla"
}
][
{
"detail": "quis",
"instance": "ea deserunt laboris",
"status": 4765464.573998421,
"title": "dolore",
"type": "eiusmod"
},
{
"detail": "Excepteur eu quis eiusmod deserunt",
"instance": "quis",
"status": 38012387.93882701,
"title": "qui in dolor",
"type": "commodo deserunt"
},
{
"detail": "deserunt consectetur",
"instance": "sint consectetur Duis",
"status": -53218629.363188885,
"title": "sint",
"type": "culpa proident qui ut"
}
][
{
"detail": "dolor labore",
"instance": "nulla ex",
"status": 77923500.44478762,
"title": "nostrud dolor occaecat elit",
"type": "incididunt Lorem aliquip ipsum"
},
{
"detail": "magna proident ea",
"instance": "velit laboris eu pariatur",
"status": -35663467.685145766,
"title": "pariatur tempor amet quis",
"type": "officia"
},
{
"detail": "culpa magna quis",
"instance": "esse deserunt et anim",
"status": 44112841.20755097,
"title": "deserunt",
"type": "labore sit minim in cillum"
}
][
{
"detail": "dolore minim Ut commodo cupidatat",
"instance": "enim ad aliqua",
"status": 52283062.75837186,
"title": "ut in dolore",
"type": "nulla aute ut est ipsum"
},
{
"detail": "occaecat exercitation labore",
"instance": "pariatur elit officia",
"status": 12067551.330923185,
"title": "dolor",
"type": "elit quis ut"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.POST
[
{
"shipmentId": "JJD49055313895700000010",
"pickupAccount": "F820579",
"postalCode": "SL1 4PL",
"requestingUser": {
"id": "test@test.com",
"name": "tester"
}
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "voluptate",
"instance": "sit ipsum commodo proident velit",
"status": -82165821.55271412,
"title": "ex consectetur minim eu Duis",
"type": "veniam occaecat Duis ut"
},
{
"detail": "qui in sunt anim veniam",
"instance": "sint reprehenderit",
"status": 72396657.07436433,
"title": "commodo reprehenderit nulla cupidatat",
"type": "Excepteur"
},
{
"detail": "do elit",
"instance": "eu",
"status": -30522889.342685074,
"title": "laborum culpa dolore proident Excepteur",
"type": "nostrud officia dolor ut mollit"
},
{
"detail": "in sint",
"instance": "culpa aute nulla elit",
"status": -22673971.45014751,
"title": "ut nostrud",
"type": "enim dolor aute in aliquip"
},
{
"detail": "incididunt nisi",
"instance": "dolore sed pariatur est dolor",
"status": 51147339.214912385,
"title": "velit est",
"type": "dolor et"
}
][
{
"detail": "velit aliqua nulla elit",
"instance": "in culpa officia ipsum",
"status": -70477906.67383832,
"title": "sunt reprehenderit",
"type": "consequat sunt pariatur"
},
{
"detail": "Ut labore",
"instance": "laborum dolor Excepteur do labore",
"status": 85012294.60282063,
"title": "proident in veniam elit dolore",
"type": "eiusmod sint"
},
{
"detail": "non eiusmod nisi",
"instance": "in voluptate minim",
"status": 21871290.682747796,
"title": "exercitation Lorem deserunt aliquip",
"type": "sed"
},
{
"detail": "cupidatat eiusmod adipisicing elit laboris",
"instance": "minim in deserunt ex",
"status": -18822711.172221407,
"title": "velit dolor",
"type": "deserunt culpa"
},
{
"detail": "reprehenderit enim dolor",
"instance": "veniam dolore",
"status": 35401649.56315118,
"title": "sint",
"type": "et ex"
}
][
{
"detail": "ad",
"instance": "ut tempor ullamco",
"status": 61167409.771799654,
"title": "enim aute mollit ex commodo",
"type": "minim commodo sit velit aliquip"
}
][
{
"detail": "sed elit nulla aliqua",
"instance": "nisi occaecat do",
"status": 6841272.064660147,
"title": "proident dolore dolor Excepteur",
"type": "reprehenderit irure do in"
},
{
"detail": "quis",
"instance": "deserunt enim voluptate pariatur culpa",
"status": -79513194.66383456,
"title": "reprehenderit",
"type": "fugiat reprehenderit nulla officia ad"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.POST
| Query Parameter Name | Example |
|---|---|
shipmentId* | veniam |
includeLabel | true |
format | JPG_RAW |
pageSize | label6x4 |
labelOrientation | landscape |
labelDPI | 300 |
{
"recipient": {
"name": "Amended Contact Name",
"phone": "01213356799",
"email": "test@email.com"
},
"shipmentDetails": {
"customerRef1": "Amended Order 12344",
"customerRef2": "Amend PO 56757",
"orderedProduct": 210,
"totalpieces": 3,
"totalWeight": 6,
"deliveryInstructions": "House at end of Lane"
},
"extendedLiability": {
"extendedLiabilityUnits": 2
}
}{
"shipments": {
"shipmentId": "JJD49055313895700000010",
"labels": [
"<Base64encoded Label Data 1>",
"<Base64encoded Label Data 2>"
]
}
}[
{
"detail": "id in ea veniam et",
"instance": "do",
"status": 42079062.09719661,
"title": "in id sint aute laboris",
"type": "aliqua elit proident fugiat"
},
{
"detail": "deserunt",
"instance": "fugiat",
"status": 61675197.747888654,
"title": "consectetur tempor voluptate adipisicing",
"type": "velit et"
},
{
"detail": "eu in do",
"instance": "amet reprehenderit officia consequat",
"status": 15745304.040326327,
"title": "pariatur dolor",
"type": "irure dolor elit"
},
{
"detail": "nisi eu cillum ut ad",
"instance": "irure eu in",
"status": 82041296.55008462,
"title": "quis Lorem et laboris enim",
"type": "ullamco Excepteur commodo ut"
}
][
{
"detail": "ex veniam dolor non nisi",
"instance": "esse adipisicing sint elit Excepteur",
"status": -7236941.968960717,
"title": "incididunt dolore ipsum",
"type": "labore velit quis non do"
},
{
"detail": "eiusmod aliquip in Lorem qui",
"instance": "nisi consequat ea esse",
"status": 20025992.21706754,
"title": "non Excepteur commodo aliquip velit",
"type": "et"
},
{
"detail": "ipsum",
"instance": "reprehenderit nisi tempor veniam",
"status": 21998088.80610457,
"title": "pariatur tempor esse do",
"type": "sit"
},
{
"detail": "adipisicing",
"instance": "pariatur ad veniam sit elit",
"status": -71408096.58560485,
"title": "sed eu adipisicing dolore",
"type": "non in veniam"
},
{
"detail": "ut commodo adipisicing cupidatat dolore",
"instance": "deserunt incididunt pariatur velit",
"status": -65629032.84217421,
"title": "reprehenderit do amet",
"type": "consequat sunt laborum in"
}
][
{
"detail": "id magna",
"instance": "in ea anim elit velit",
"status": 13633559.912186846,
"title": "qui",
"type": "Duis ipsum labore consectetur officia"
},
{
"detail": "in minim enim",
"instance": "in",
"status": -42356249.80477182,
"title": "Duis sint aute dolore",
"type": "sunt Lorem ad irure pariatur"
},
{
"detail": "consectetur exercitation est",
"instance": "aliquip",
"status": 2561827.08717753,
"title": "Excepteur irure sunt labore adipisicing",
"type": "cupidatat elit"
},
{
"detail": "in mollit consequat",
"instance": "reprehenderit sint ad",
"status": 93594256.41952631,
"title": "quis eu Excepteur",
"type": "Excepteur"
},
{
"detail": "dolore amet nostrud",
"instance": "aliqua",
"status": 2972944.8950538635,
"title": "exercitation Lorem",
"type": "laboris"
}
][
{
"detail": "qui",
"instance": "non ad irure sit",
"status": 57426631.36083883,
"title": "sunt pariatur enim et esse",
"type": "et"
},
{
"detail": "sit",
"instance": "cillum incididunt reprehenderit Ut",
"status": 33502205.6163937,
"title": "adipisicing",
"type": "nisi consequat sunt"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Customs Declaration API V1
GET
| Query Parameter Name | Example |
|---|---|
shipmentId* | in |
ignoreInvoice | true |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "est minim cillum pariatur Ut",
"instance": "deserunt nisi elit ea commodo",
"status": -22697977.155982673,
"title": "pariatur tempor",
"type": "anim Lorem eiusmod est proident"
},
{
"detail": "aliqua amet eiusmod cillum",
"instance": "ullamco tempor",
"status": -75274034.9000253,
"title": "sit fugiat tempor",
"type": "nisi mollit ea nulla"
},
{
"detail": "adipisicing ut consequat occaecat Duis",
"instance": "irure nisi aliqua",
"status": 92932193.55743876,
"title": "nisi veniam",
"type": "eu"
},
{
"detail": "dolore cillum",
"instance": "magna",
"status": 12452738.644123465,
"title": "laborum commodo",
"type": "cillum ut incididunt qui"
}
][
{
"detail": "commodo",
"instance": "Ut consequat dolore dolor",
"status": -36499714.806199804,
"title": "officia ex exercitation",
"type": "do proident magna aliquip id"
},
{
"detail": "Excepteur",
"instance": "mollit nostrud",
"status": 69840507.3302406,
"title": "consequat nulla",
"type": "do elit culpa sed veniam"
},
{
"detail": "deserunt in est non sunt",
"instance": "fugiat ut",
"status": -82228993.45379573,
"title": "Excepteur nulla minim pariatur enim",
"type": "nostrud ad sed id"
},
{
"detail": "ut irure",
"instance": "laboris Lorem et",
"status": -87607316.34826952,
"title": "enim dolore anim voluptate incididunt",
"type": "nostrud amet"
}
][
{
"detail": "aliqua",
"instance": "cupidatat amet",
"status": -82263850.69611974,
"title": "do dolore commodo adipisicing Ut",
"type": "ad et"
},
{
"detail": "adipisicing",
"instance": "ut consectetur commodo nisi",
"status": 8806510.764107496,
"title": "culpa commodo non",
"type": "in pariatur"
},
{
"detail": "ipsum quis",
"instance": "tempor ad",
"status": -20813292.224533603,
"title": "id in",
"type": "laborum aliquip qui do dolore"
},
{
"detail": "non culpa",
"instance": "elit dolore dolore proident",
"status": -38368239.47897101,
"title": "Excepteur dolor dolore",
"type": "id cillum"
}
]Labels API V1(2 operations)
GET
| Query Parameter Name | Example |
|---|---|
shipmentId* | ad Excepteur |
format* | pdf |
pageSize | label6x4 |
labelOrientation | landscape |
labelDPI | 300 |
includePickListLabel | true |
{
"labels": [
{
"label": "Base64EncodedLabel1"
},
{
"label": "Base64EncodedLabel1"
},
{
"label": "Base64EncodedLabel1"
},
{
"label": "Base64EncodedLabel1"
},
{
"label": "Base64EncodedLabel1"
}
],
"shipmentId": "JJD149050550006001054190"
}[
{
"detail": "ullamco consequat ea Excepteur",
"instance": "veniam",
"status": 24952696.30926864,
"title": "mollit est et dolor",
"type": "magna aute adipisicing officia aliquip"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
shipmentId* | anim eu dolore commodo |
format* | zpl |
labelOrientation | landscape |
labelDPI | 300 |
{
"labels": [
{
"label": "Base64EncodedLabel1"
},
{
"label": "Base64EncodedLabel1"
},
{
"label": "Base64EncodedLabel1"
},
{
"label": "Base64EncodedLabel1"
}
],
"shipmentId": "JJD149050550006001054190"
}[
{
"detail": "exercitation Excepteur",
"instance": "irure deserunt",
"status": -72386446.94393894,
"title": "ut nulla tempor enim laborum",
"type": "labore Lorem consequat minim"
},
{
"detail": "sed laborum",
"instance": "mollit in laboris ullamco",
"status": 39125543.983756244,
"title": "nulla amet culpa id",
"type": "amet mollit magna"
},
{
"detail": "aute fugiat",
"instance": "Ut id adipisicing tempor",
"status": -22031820.19212666,
"title": "aute incididunt",
"type": "sit culpa sunt"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Customer API V1
GET
| Query Parameter Name | Example |
|---|---|
customerAccountNumber* | CUS-049204 |
accountId | F020579 |
tradingLocationId | mollit labore est quis consequat |
{
"customerAccountNumber": "CUS-049906",
"tradingLocations": [
{
"tradingLocationId": "L4562-G56SG-H678FD",
"status": "active",
"companyName": "Testco London",
"address1": "Unit 1",
"address2": "A Trading Estate",
"address3": "Hackney",
"city": "London",
"state": null,
"postalCode": "E1 1AA",
"accounts": [
{
"accountId": "A123456"
},
{
"accountId": "A523456"
},
{
"accountId": "A823456"
}
]
},
{
"tradingLocationId": "B4562-G56SG-H678FD",
"status": "onStop",
"companyName": "Testco Birmingham",
"address1": "Unit 2",
"address2": "A Trading Estate",
"address3": "Saltley",
"city": "Birmingham",
"state": null,
"postalCode": "B8 2AA",
"accounts": [
{
"accountId": "F123456"
},
{
"accountId": "F523456"
},
{
"accountId": "F823456"
}
]
},
{
"tradingLocationId": "M4562-G56SG-H678FD",
"status": "closed",
"companyName": "Testco Manchester",
"address1": "Unit 3",
"address2": "A Trading Estate",
"address3": "Salford",
"city": "Manchester",
"state": null,
"postalCode": "M1 4AA",
"accounts": [
{
"accountId": "M123456"
},
{
"accountId": "M523456"
},
{
"accountId": "M823456"
}
]
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "ut Duis sit exercitation",
"instance": "nostrud esse commodo non fugiat",
"status": -77963202.99847785,
"title": "proident velit mollit cupidatat in",
"type": "adipisicing"
},
{
"detail": "sunt occaecat dolor",
"instance": "qui",
"status": 32494961.575397775,
"title": "enim sed sit aliqua nisi",
"type": "irure dolore laborum dolor nisi"
}
][
{
"detail": "deserunt occaecat culpa amet sunt",
"instance": "dolore in consectetur ut irure",
"status": 16936925.53974974,
"title": "aliquip id irure",
"type": "laborum"
},
{
"detail": "pariatur in",
"instance": "Excepteur",
"status": 82735855.87972191,
"title": "tempor ea",
"type": "Excepteur est"
},
{
"detail": "ea sed consectetur labore proident",
"instance": "reprehenderit proident id",
"status": 96572691.72392553,
"title": "veniam",
"type": "Duis minim"
},
{
"detail": "est fugiat",
"instance": "exercitation in dolor voluptate dolor",
"status": 82069336.34541702,
"title": "magna esse consequat dolore",
"type": "consequat voluptate"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Pickup API V1(3 operations)
POST
{
"customerAccountNumber": "CUS-049204",
"tradingLocationId": "B0V4K000002JMSDUA2",
"pickupDate": "2022-03-03",
"timeReady": "15:00",
"latestTime": "17:00",
"instructions": "Please pickup from door 12 at back of warehouse."
}{
"pickupIdentifier": "A123456789"
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "consectetur dolore",
"instance": "magna ullamco",
"status": -13766752.151963726,
"title": "sit ipsum",
"type": "aliqua ullamco labore"
},
{
"detail": "nostrud laborum eiusmod Duis Ut",
"instance": "sed ut proident adipisicing minim",
"status": 94845996.82940829,
"title": "commodo tempor do sint aliqua",
"type": "laboris"
},
{
"detail": "do ea nulla",
"instance": "ex proident eu amet",
"status": -26406313.200332582,
"title": "pariatur Duis dolor sunt dolore",
"type": "pariatur dolor"
}
][
{
"detail": "in culpa magna id",
"instance": "aute reprehenderit qui",
"status": 40088943.48134336,
"title": "occaecat adipisicing et Lorem officia",
"type": "laborum quis commodo laboris"
},
{
"detail": "aute",
"instance": "dolor",
"status": 98281691.9770782,
"title": "veniam ipsum eiusmod incididunt ea",
"type": "sed dolor pariatur"
},
{
"detail": "est ut",
"instance": "sit aliqua dolor id",
"status": -70783611.21680033,
"title": "ea",
"type": "anim esse occaecat"
},
{
"detail": "anim dolor",
"instance": "mollit aliquip culpa",
"status": -70584554.08557843,
"title": "minim in eu ullamco amet",
"type": "sint tempor deserunt non est"
},
{
"detail": "qui laborum",
"instance": "nostrud dolor adipisicing ullamco voluptate",
"status": 9072900.155033857,
"title": "ea sed Lorem exercitation proident",
"type": "nulla elit anim adipisicing"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
pickupIdentifier | esse commodo id dolor ea |
{
"pickupIdentifier": "A123456789",
"pickupType": "adhoc",
"status": "requested",
"customerAccountNumber": "CUS-049906",
"requestedPickupDate": "2022-01-04",
"timeReady": "15:00",
"latestTime": "17:30",
"instructions": "Please pickup from door 12 at back of warehouse."
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "aliquip sit sed",
"instance": "sint adipisicing Excepteur",
"status": 41509700.5161297,
"title": "id",
"type": "aliquip"
},
{
"detail": "sint cupidatat laboris id deserunt",
"instance": "ea",
"status": 36148884.30405444,
"title": "ex dolor sit",
"type": "dolor quis nulla magna Excepteur"
},
{
"detail": "ut",
"instance": "minim ullamco fugiat",
"status": -60953665.27729192,
"title": "exercitation in ea nisi laboris",
"type": "consectetur laborum anim amet"
},
{
"detail": "Excepteur",
"instance": "esse",
"status": -39672396.275717504,
"title": "Duis cupidatat incididunt laborum",
"type": "officia sunt commodo et"
}
][
{
"detail": "enim Lorem",
"instance": "ad",
"status": 17211032.73581916,
"title": "pariatur aliquip ullamco",
"type": "dolor Ut in ex occaecat"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
customerAccountNumber* | CUS-049204 |
tradingLocationId* | B0V4K000002JMSDUA2 |
startDate* | 2022-03-01 |
endDate* | 2023-03-06 |
[
{
"pickupIdentifier": "A123456790",
"pickupType": "adhoc",
"status": "requested",
"customerAccountNumber": "CUS-049906",
"tradingLocationId": "L4562-G56SG-H678FD",
"requestedPickupDate": "2022-01-05",
"timeReady": "14:30",
"latestTime": "17:30",
"instructions": "Please pickup from door 11."
},
{
"pickupIdentifier": "A123456789",
"pickupType": "adhoc",
"status": "booked",
"customerAccountNumber": "CUS-049906",
"tradingLocationId": "L4562-G56SG-H678FD",
"requestedPickupDate": "2022-01-04",
"timeReady": "15:00",
"latestTime": "17:30",
"instructions": "Please pickup from door 12 at back of warehouse.",
"collectionJobNumber": "CJ123456789",
"plannedPickupDate": "2022-01-04"
},
{
"pickupIdentifier": "A123456334",
"pickupType": "adhoc",
"status": "allocated",
"customerAccountNumber": "CUS-049906",
"tradingLocationId": "L4562-G56SG-H678FD",
"requestedPickupDate": "2022-01-03",
"timeReady": "15:00",
"latestTime": "17:30",
"instructions": "Please pickup from door 3 at back of warehouse.",
"collectionJobNumber": "CJ123456788",
"plannedPickupDate": "2022-01-04",
"driverId": "DV1234567"
},
{
"pickupIdentifier": "A123456331",
"pickupType": "adhoc",
"status": "completed",
"customerAccountNumber": "CUS-049906",
"tradingLocationId": "L4562-G56SG-H678FD",
"requestedPickupDate": "2022-01-03",
"timeReady": "15:00",
"latestTime": "17:30",
"instructions": "Please pickup from door 3 at back of warehouse.",
"collectionJobNumber": "CJ123456788",
"plannedPickupDate": "2022-01-03",
"driverId": "DV1234567",
"lastAttemptDateTime": "2022-01-03T15:44:32Z",
"success": true,
"qtyParcels": 319
},
{
"pickupIdentifier": "A123456330",
"pickupType": "adhoc",
"status": "completed",
"customerAccountNumber": "CUS-049906",
"tradingLocationId": "L4562-G56SG-H678FD",
"requestedPickupDate": "2022-01-02",
"timeReady": "15:00",
"latestTime": "17:30",
"instructions": "Please pickup from door 3 at back of warehouse.",
"collectionJobNumber": "CJ123456788",
"plannedPickupDate": "2022-01-02",
"driverId": "DV1234567",
"lastAttemptDateTime": "2022-01-02T15:31:12Z",
"success": false,
"qtyParcels": 0,
"failureReasonCode": "PF1234",
"failureReasonDescription": "Nothing to collect"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "do dolore fugiat enim deserunt",
"instance": "Lorem eiusmod veniam deserunt",
"status": -56399036.97446149,
"title": "sed enim pariatur cillum dolore",
"type": "dolore mollit ut"
},
{
"detail": "anim",
"instance": "ullamco laborum ex ea Lorem",
"status": -23098431.91078666,
"title": "Lorem ad minim",
"type": "nostrud ad id sit"
},
{
"detail": "aliquip eu ea",
"instance": "cillum commodo cupidatat dolor Duis",
"status": 78744951.24616757,
"title": "sunt dolore ullamco",
"type": "in non et ullamco"
},
{
"detail": "Duis aliqua",
"instance": "sint culpa ea nostrud est",
"status": -35522364.326375075,
"title": "quis",
"type": "ex non"
}
][
{
"detail": "irure est",
"instance": "ipsum deserunt officia",
"status": -84981446.19696131,
"title": "laboris adipisicing ad",
"type": "est id laboris"
},
{
"detail": "cillum eu deserunt dolore anim",
"instance": "reprehenderit cillum exercitation dolor mollit",
"status": -79437568.92517473,
"title": "minim dolor ad est velit",
"type": "Lorem esse id mollit tempor"
},
{
"detail": "deserunt laborum reprehenderit",
"instance": "deserunt sed anim esse",
"status": 56488360.09020245,
"title": "cillum aliqua",
"type": "anim ullamco eu est minim"
},
{
"detail": "fugiat est aliquip do",
"instance": "et aliqua commodo ut",
"status": -3729341.0780496746,
"title": "ipsum ullamco est",
"type": "anim"
},
{
"detail": "dolor aute consectetur incididunt",
"instance": "id fugiat deserunt",
"status": -43923944.87396403,
"title": "quis fugiat magna",
"type": "do laborum sunt enim"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Tracking API V1(3 operations)
GET
| Query Parameter Name | Example |
|---|---|
trackingNumber* | enim ad quis qui elit |
service | parcelUk |
requesterCountryCode | ea quis et ut sed |
originCountryCode | do et proident dolor |
recipientPostalCode | cillum ipsum |
language | est ea Duis |
offset | -44682009.003527455 |
limit | 40586157.076705575 |
{
"shipments": [
{
"id": "40120210280347",
"service": "DHL eCommerce UK",
"origin": {
"address": {
"countryCode": "GB",
"postalCode": "DL14 6XW",
"streetAddress": "Dovecot Hill"
}
},
"destination": {
"address": {
"countryCode": "GB",
"postalCode": "BS13 8LX",
"streetAddress": "4 King Georges Road"
}
},
"status": {
"timestamp": "2025-08-06T08:45:55+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "delivered",
"status": "Successful delivery",
"description": "The shipment has been successfully delivered"
},
"estimatedTimeOfDelivery": "2025-08-06",
"estimatedDeliveryTimeFrame": {
"estimatedFrom": "09:28:00",
"estimatedThrough": "10:28:00"
},
"details": {
"product": {
"productCode": "220",
"productName": "Parcel"
},
"receiver": {
"givenName": "Receiver given name",
"name": "Receiver name"
},
"sender": {
"name": "Sender name"
},
"proofOfDelivery": {
"timestamp": "2025-08-06T08:45:55+00:00",
"documentUrl": "photo__jobAttempt_yc168e5f-b843-4409-a835-b9fc848f2e56_1.jpeg",
"signed": {
"name": "Receiver name "
}
},
"totalNumberOfPieces": 1,
"pieceStatus": [
{
"pieceId": "ABS13840120210280347001",
"timestamp": "2025-08-06T08:45:54+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "delivered",
"status": "Delivered",
"description": "Parcel delivered scan event",
"weight": {
"value": 4.5,
"unitText": "kg"
},
"loadingMeters": 0,
"dimensions": {
"width": {
"value": 36,
"unitText": "cm"
},
"height": {
"value": 15,
"unitText": "cm"
},
"length": {
"value": 57,
"unitText": "cm"
}
}
}
]
},
"events": [
{
"timestamp": "2025-08-06T08:45:55+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "delivered",
"status": "Successful delivery",
"description": "The shipment has been successfully delivered"
},
{
"timestamp": "2025-08-06T07:34:23+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "transit",
"status": "Notification for recipient",
"description": "The notification for delivery has been sent to the recipient"
},
{
"timestamp": "2025-08-06T07:34:23+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "transit",
"status": "Notification for recipient",
"description": "The notification for delivery has been sent to the recipient"
},
{
"timestamp": "2025-08-06T06:43:57+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "transit",
"status": "Van is loaded",
"description": "The shipment has been loaded to the van"
},
{
"timestamp": "2025-08-06T06:14:21+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "transit",
"status": "Arrival at Delivery Depot",
"description": "The shipment has arrived at depot "
},
{
"timestamp": "2025-08-06T01:00:19+00:00",
"location": {
"address": {
"addressLocality": "Coventry Hub"
}
},
"statusCode": "transit",
"status": "Collection event",
"description": "The shipment has been collected"
},
{
"timestamp": "2025-08-06T01:00:17+00:00",
"location": {
"address": {
"addressLocality": "Coventry Hub"
}
},
"statusCode": "transit",
"status": "Collection event",
"description": "The shipment has been collected"
},
{
"timestamp": "2025-08-05T13:30:58+00:00",
"location": {
"address": {
"addressLocality": "Teesside"
}
},
"statusCode": "transit",
"status": "Pick-up event ",
"description": "The shipment has been picked up at sender"
}
]
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
trackingNumber* | laboris |
pieceNumber* | dolore anim deserunt |
service | parcelUk |
requesterCountryCode | commodo exercitation |
originCountryCode | Duis |
recipientPostalCode | do |
language | quis magna |
{
"pieceId": "ABS13840120210280347001",
"parcelNumber": "001",
"pieceEvents": [
{
"timestamp": "2025-08-06T08:45:54+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "delivered",
"status": "Delivered",
"description": "Parcel delivered scan event"
},
{
"timestamp": "2025-08-06T06:14:21+00:00",
"location": {
"address": {
"addressLocality": "Bristol"
}
},
"statusCode": "transit",
"status": "Arrival at Delivery Depot",
"description": "The shipment has arrived at depot "
},
{
"timestamp": "2025-08-05T14:09:42+00:00",
"location": {
"address": {
"addressLocality": "Teesside"
}
},
"statusCode": "transit",
"status": "Network Scan",
"description": "The parcel is in transit"
},
{
"timestamp": "2025-08-05T13:30:58+00:00",
"location": {
"address": {
"addressLocality": "Teesside"
}
},
"statusCode": "transit",
"status": "Pick-up event ",
"description": "The shipment has been picked up at sender"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
Binary Content
(image/jpeg)
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.ReferenceData API V1(12 operations)
GET
| Query Parameter Name | Example |
|---|---|
code | qui |
name | cillum ut voluptate in |
shipmentType | international |
{
"productCode": "206",
"productName": "Parcel Connect",
"shipmentType": "international",
"sortOrder": 1,
"dimensionsMandatory": true,
"accountType": "internationalRoad",
"shipmentIdentifierType": "mh10",
"labelType": "parcel-connect-uk",
"labelProductName": "Parcel Connect",
"labelSortationName": "97",
"barcodeProductCode": "70",
"servicePointCollection": false,
"doorstepPickup": false,
"secureLocationPickup": false,
"neighbourDelivery": false,
"secureLocationDelivery": false
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "deserunt in",
"instance": "eu sit culpa",
"status": 42188439.95501372,
"title": "anim consequat eiusmod",
"type": "sint enim dolore"
},
{
"detail": "do incididunt",
"instance": "ipsum quis laboris ut Excepteur",
"status": 81779396.00216913,
"title": "labore",
"type": "voluptate officia aute in labore"
},
{
"detail": "ut magna aliquip",
"instance": "veniam",
"status": 74591836.9261879,
"title": "exercitation",
"type": "dolor"
},
{
"detail": "voluptate nulla",
"instance": "Lorem",
"status": -78089631.88722849,
"title": "nostrud nisi culpa proident",
"type": "cillum eiusmod fugiat exercitation"
},
{
"detail": "dolor",
"instance": "laborum fugiat",
"status": -64441177.54994822,
"title": "proident",
"type": "incididunt aute"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
code | id Ut voluptate |
productCode | aliqua incididunt anim in nulla |
{
"code": 11,
"productCode": 10,
"description": "12:00",
"longdescription": "Bagit XL Neighbour 12:00",
"labelDescription": "12:00",
"serviceLevel": "am",
"bulkyAllowed": false,
"deliveryWindowStart": "08:00",
"deliveryWindowEnd": "12:00",
"servicePoint": false
}[
{
"detail": "magna aliqua eu mollit dolor",
"instance": "eu Excepteur consequat",
"status": 65471944.25068873,
"title": "tempor",
"type": "reprehenderit non magna sunt"
},
{
"detail": "culpa qui",
"instance": "proident",
"status": 13764294.411677018,
"title": "enim in quis",
"type": "Ut"
},
{
"detail": "aliquip esse eu",
"instance": "adipisicing deserunt consectetur voluptate ea",
"status": -97584182.80075549,
"title": "dolore mollit occaecat",
"type": "ullamco dolor qui eu proident"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"detail": "reprehenderit ullamco ipsum veniam",
"instance": "elit dolore ea Excepteur",
"status": -84977027.34108806,
"title": "cillum labore pariatur magna",
"type": "dolore"
},
{
"detail": "ullamco nisi nulla",
"instance": "ex labore veniam elit",
"status": -45302832.51638969,
"title": "est pariatur cillum laborum magna",
"type": "cillum ut cupidatat et culpa"
},
{
"detail": "mollit consectetur ipsum dolor reprehenderit",
"instance": "fugiat aliquip",
"status": 16538794.2897048,
"title": "laboris est",
"type": "cupidatat"
},
{
"detail": "irure Duis dolor incididunt eu",
"instance": "in non aute commodo aliquip",
"status": 33054244.86856419,
"title": "dolor minim proident quis ut",
"type": "est culpa aliquip dolor"
},
{
"detail": "et esse ex",
"instance": "Duis aute et commodo",
"status": 38404934.32115361,
"title": "aliqua sunt dolore esse",
"type": "eiusmod exercitation aliquip laboris ut"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
countryCode | aliquip reprehenderit ipsum |
productCode | veniam Lorem |
recipientType | business |
addressType | servicePoint |
locationType | ParcelShop |
[
{
"productCode": 206,
"countryCode": "DE",
"effectiveFrom": "2021-01-07T00:00:00.000Z",
"effectiveTo": "2099-01-01T00:00:00.000Z",
"recipientType": "residential",
"addressType": "doorstep",
"locationType": "Doorstep",
"transitTimeDescription": "2-4 days",
"minTransitTime": 2,
"maxTransitTime": 4,
"customsLevel": "full",
"standardParcels": true,
"bulkyParcels": true,
"dropOffAtDepotAllowed": true,
"standardDims": true,
"maximumParcels": 1,
"maximumLength": 200,
"maximumWidth": 120,
"maximumHeight": 80,
"maximumGirth": 360,
"maximumWeight": 31.5,
"maximumDiameter": 60,
"maximumLengthGirth": null,
"minimumLength": 15,
"minimumWidth": 11,
"minimumHeight": 1,
"minimumWeight": 0.1,
"bulkyLength": 120,
"bulkyWidth": 60,
"bulkyHeight": 60,
"bulkyGirth": 360,
"bulkyWeight": 31.5,
"bulkyDiameter": 60,
"postnummerRequired": false,
"labelPersonalData": true,
"returns": true,
"dutiesPaid": "DDP",
"dutiesPaidList": [
"DDP"
],
"exportExcludePostcodesBeginWith": [],
"importExcludePostcodesBeginWith": [],
"deliveryGateway": [
"COLOGNE",
"ZALTBOMMEL"
],
"serviceProviderProductCode": "70",
"transitGateways": [
"TG002",
"TG006"
],
"serviceProviderCodes": [
"SP012"
],
"barcodeRoutingDateCode": "00",
"customsOverride": true,
"originNoCustomsByPostcode": null,
"originBasicCustomsByPostcode": "BT*",
"originFullCustomsByPostcode": null,
"destinationNoCustomsByPostcode": null,
"destinationBasicCustomsByPostcode": null,
"destinationFullCustomsByPostcode": null,
"iossApplies": true,
"iossValueLimits": [
{
"currency": "GBP",
"maxTotalValue": 126.13
},
{
"currency": "EUR",
"maxTotalValue": 150
}
],
"productAllowedIfIossLimitExceeded": false,
"iossDutiesPaid": "DDP",
"nonIossAllowed": false,
"maximumWeightPerParcel": 31.5,
"maximumPallets": 0,
"limitedReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
}
],
"fullReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
},
{
"type": "personalBelongings",
"description": "Personal Belongings"
}
]
},
{
"productCode": 204,
"countryCode": "DE",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2099-01-01T00:00:00.000Z",
"recipientType": "business",
"addressType": "doorstep",
"locationType": "Doorstep",
"transitTimeDescription": "3 days",
"minTransitTime": 3,
"maxTransitTime": null,
"customsLevel": "full",
"standardParcels": true,
"bulkyParcels": false,
"dropOffAtDepotAllowed": true,
"standardDims": true,
"maximumParcels": 200,
"maximumLength": 200,
"maximumWidth": 120,
"maximumHeight": 80,
"maximumGirth": null,
"maximumWeight": 70,
"maximumDiameter": null,
"maximumLengthGirth": null,
"minimumLength": 15,
"minimumWidth": 11,
"minimumHeight": 1,
"minimumWeight": 0.1,
"bulkyLength": null,
"bulkyWidth": null,
"bulkyHeight": null,
"bulkyGirth": null,
"bulkyWeight": null,
"bulkyDiameter": null,
"postnummerRequired": false,
"labelPersonalData": true,
"returns": false,
"dutiesPaid": "DAP",
"dutiesPaidList": [
"DAP",
"DDP"
],
"exportExcludePostcodesBeginWith": [],
"importExcludePostcodesBeginWith": [],
"deliveryGateway": [
"NORSK"
],
"serviceProviderProductCode": "57",
"transitGateways": [
"TG005"
],
"serviceProviderCodes": [
"SP007"
],
"barcodeRoutingDateCode": "00",
"customsOverride": false,
"originNoCustomsByPostcode": null,
"originBasicCustomsByPostcode": null,
"originFullCustomsByPostcode": null,
"destinationNoCustomsByPostcode": null,
"destinationBasicCustomsByPostcode": null,
"destinationFullCustomsByPostcode": null,
"iossApplies": false,
"iossValueLimits": [],
"productAllowedIfIossLimitExceeded": false,
"iossDutiesPaid": null,
"nonIossAllowed": false,
"maximumWeightPerParcel": 70,
"maximumPallets": 0,
"limitedReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
}
],
"fullReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
},
{
"type": "personalBelongings",
"description": "Personal Belongings"
}
]
},
{
"productCode": 204,
"countryCode": "DE",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2099-01-01T00:00:00.000Z",
"recipientType": "residential",
"addressType": "doorstep",
"locationType": "Doorstep",
"transitTimeDescription": "3 days",
"minTransitTime": 3,
"maxTransitTime": null,
"customsLevel": "full",
"standardParcels": true,
"bulkyParcels": false,
"dropOffAtDepotAllowed": true,
"standardDims": true,
"maximumParcels": 200,
"maximumLength": 200,
"maximumWidth": 120,
"maximumHeight": 80,
"maximumGirth": null,
"maximumWeight": 70,
"maximumDiameter": null,
"maximumLengthGirth": null,
"minimumLength": 15,
"minimumWidth": 11,
"minimumHeight": 1,
"minimumWeight": 0.1,
"bulkyLength": null,
"bulkyWidth": null,
"bulkyHeight": null,
"bulkyGirth": null,
"bulkyWeight": null,
"bulkyDiameter": null,
"postnummerRequired": false,
"labelPersonalData": true,
"returns": false,
"dutiesPaid": "DAP",
"dutiesPaidList": [
"DAP",
"DDP"
],
"exportExcludePostcodesBeginWith": [],
"importExcludePostcodesBeginWith": [],
"deliveryGateway": [
"NORSK"
],
"serviceProviderProductCode": "57",
"transitGateways": [
"TG005"
],
"serviceProviderCodes": [
"SP007"
],
"barcodeRoutingDateCode": "00",
"customsOverride": false,
"originNoCustomsByPostcode": null,
"originBasicCustomsByPostcode": null,
"originFullCustomsByPostcode": null,
"destinationNoCustomsByPostcode": null,
"destinationBasicCustomsByPostcode": null,
"destinationFullCustomsByPostcode": null,
"iossApplies": true,
"iossValueLimits": [
{
"currency": "GBP",
"maxTotalValue": 126.13
},
{
"currency": "EUR",
"maxTotalValue": 150
}
],
"productAllowedIfIossLimitExceeded": true,
"iossDutiesPaid": "DAP",
"nonIossAllowed": true,
"maximumWeightPerParcel": 70,
"maximumPallets": 0,
"limitedReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
}
],
"fullReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
},
{
"type": "personalBelongings",
"description": "Personal Belongings"
}
]
},
{
"productCode": 101,
"countryCode": "DE",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2099-01-01T00:00:00.000Z",
"recipientType": "business",
"addressType": "doorstep",
"locationType": "Doorstep",
"transitTimeDescription": "2 days",
"minTransitTime": 2,
"maxTransitTime": null,
"customsLevel": "full",
"standardParcels": true,
"bulkyParcels": false,
"dropOffAtDepotAllowed": true,
"standardDims": true,
"maximumParcels": 200,
"maximumLength": 200,
"maximumWidth": 120,
"maximumHeight": 120,
"maximumGirth": null,
"maximumWeight": 40,
"maximumDiameter": null,
"maximumLengthGirth": null,
"minimumLength": 15,
"minimumWidth": 11,
"minimumHeight": 1,
"minimumWeight": 0.1,
"bulkyLength": null,
"bulkyWidth": null,
"bulkyHeight": null,
"bulkyGirth": null,
"bulkyWeight": null,
"bulkyDiameter": null,
"postnummerRequired": false,
"labelPersonalData": true,
"returns": false,
"dutiesPaid": "DAP",
"dutiesPaidList": [
"DAP",
"DDP"
],
"exportExcludePostcodesBeginWith": [],
"importExcludePostcodesBeginWith": [],
"deliveryGateway": [
"NORSK"
],
"serviceProviderProductCode": "48",
"transitGateways": [
"TG005"
],
"serviceProviderCodes": [
"SP007"
],
"barcodeRoutingDateCode": "00",
"customsOverride": false,
"originNoCustomsByPostcode": null,
"originBasicCustomsByPostcode": null,
"originFullCustomsByPostcode": null,
"destinationNoCustomsByPostcode": null,
"destinationBasicCustomsByPostcode": null,
"destinationFullCustomsByPostcode": null,
"iossApplies": false,
"iossValueLimits": [],
"productAllowedIfIossLimitExceeded": false,
"iossDutiesPaid": null,
"nonIossAllowed": false,
"maximumWeightPerParcel": 40,
"maximumPallets": 0,
"limitedReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
}
],
"fullReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
},
{
"type": "personalBelongings",
"description": "Personal Belongings"
}
]
},
{
"productCode": 101,
"countryCode": "DE",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2099-01-01T00:00:00.000Z",
"recipientType": "residential",
"addressType": "doorstep",
"locationType": "Doorstep",
"transitTimeDescription": "2 days",
"minTransitTime": 2,
"maxTransitTime": null,
"customsLevel": "full",
"standardParcels": true,
"bulkyParcels": false,
"dropOffAtDepotAllowed": true,
"standardDims": true,
"maximumParcels": 200,
"maximumLength": 200,
"maximumWidth": 120,
"maximumHeight": 120,
"maximumGirth": null,
"maximumWeight": 40,
"maximumDiameter": null,
"maximumLengthGirth": null,
"minimumLength": 15,
"minimumWidth": 11,
"minimumHeight": 1,
"minimumWeight": 0.1,
"bulkyLength": null,
"bulkyWidth": null,
"bulkyHeight": null,
"bulkyGirth": null,
"bulkyWeight": null,
"bulkyDiameter": null,
"postnummerRequired": false,
"labelPersonalData": true,
"returns": false,
"dutiesPaid": "DAP",
"dutiesPaidList": [
"DAP",
"DDP"
],
"exportExcludePostcodesBeginWith": [],
"importExcludePostcodesBeginWith": [],
"deliveryGateway": [
"NORSK"
],
"serviceProviderProductCode": "48",
"transitGateways": [
"TG005"
],
"serviceProviderCodes": [
"SP007"
],
"barcodeRoutingDateCode": "00",
"customsOverride": false,
"originNoCustomsByPostcode": null,
"originBasicCustomsByPostcode": null,
"originFullCustomsByPostcode": null,
"destinationNoCustomsByPostcode": null,
"destinationBasicCustomsByPostcode": null,
"destinationFullCustomsByPostcode": null,
"iossApplies": true,
"iossValueLimits": [
{
"currency": "GBP",
"maxTotalValue": 126.13
},
{
"currency": "EUR",
"maxTotalValue": 150
}
],
"productAllowedIfIossLimitExceeded": true,
"iossDutiesPaid": "DAP",
"nonIossAllowed": true,
"maximumWeightPerParcel": 40,
"maximumPallets": 0,
"limitedReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
}
],
"fullReasonForExportList": [
{
"type": "commercialSale",
"description": "Commercial Sale"
},
{
"type": "gift",
"description": "Gift"
},
{
"type": "commercialSample",
"description": "Commercial Sample"
},
{
"type": "personalBelongings",
"description": "Personal Belongings"
}
]
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
code | reprehenderit amet |
name | et culpa nostrud ullamco |
{
"usStateCode": "NY",
"usStateName": "New York"
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
{
"countries": [
{
"code": "DEU",
"code2Digit": "DE",
"name": "Germany",
"postcodeMask": "NNNNN",
"postcodeRegex": "^\\d{5}$",
"isEU": true,
"iossApplies": true
},
{
"code": "FRA",
"code2Digit": "FR",
"name": "France",
"postcodeMask": "NNNNN",
"postcodeRegex": "^\\d{5}$",
"isEU": true,
"iossApplies": true
}
]
}[
{
"detail": "anim dolor",
"instance": "pariatur laborum minim Duis ea",
"status": 63402354.63408762,
"title": "ea nulla minim Excepteur",
"type": "sit eiusmod"
},
{
"detail": "cillum consequat laboris anim minim",
"instance": "ipsum non in officia deserunt",
"status": 37960900.91052854,
"title": "consectetur aliqua qui sit",
"type": "Lorem occaecat amet"
},
{
"detail": "quis tempor et",
"instance": "eu in nisi pariatur laboris",
"status": -3630039.648739338,
"title": "quis pariatur minim",
"type": "et"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
code | sed in veniam nostrud Excepteur |
name | magna aliquip exercitation |
{
"code": "DEU",
"code2Digit": "DE",
"name": "Germany",
"postcodeMask": "NNNNN",
"postcodeRegex": "^\\d{5}$",
"iossApplies": true,
"isEU": true,
"postcodeOptional": false
}[
{
"detail": "qui proident",
"instance": "magna ipsum ea ad officia",
"status": 92424075.36098897,
"title": "exercitation elit officia velit incididunt",
"type": "esse"
},
{
"detail": "cillum Lorem ut",
"instance": "in",
"status": -11807867.389988452,
"title": "mollit",
"type": "nisi sint"
},
{
"detail": "proident",
"instance": "proident eu cillum culpa",
"status": -59762025.71726992,
"title": "occaecat sunt ex commodo nisi",
"type": "Duis fugiat veniam est adipisicing"
},
{
"detail": "Excepteur pariatur ut",
"instance": "irure dolor minim enim",
"status": -44865767.7009618,
"title": "ipsum nisi in in reprehenderit",
"type": "pariatur dolor labore eu dolore"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
{
"currencies": [
{
"code": "EUR",
"name": "EURO",
"symbol": ""
},
{
"code": "USD",
"name": "US DOLLARS",
"symbol": "$"
}
]
}[
{
"detail": "sunt",
"instance": "in officia proident dolore",
"status": 18769563.309309676,
"title": "ullamco magna pariatur",
"type": "aliqua eiusmod id consectetur"
},
{
"detail": "Lorem et ipsum dolore",
"instance": "elit",
"status": 42399102.36084315,
"title": "culpa",
"type": "ut amet voluptate quis ad"
},
{
"detail": "incididunt ut",
"instance": "irure proident",
"status": 17582121.689371184,
"title": "sed ut dolore in non",
"type": "dolore consectetur est commodo"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
code | minim enim anim |
name | in dolor aliqua ut et |
{
"code": "USD",
"name": "US Dollars",
"symbol": "$"
}[
{
"detail": "ipsum est laboris nulla",
"instance": "amet occaecat aute ut",
"status": 82010584.40666959,
"title": "sit esse",
"type": "labore"
},
{
"detail": "nulla eu",
"instance": "aute sed fugiat velit",
"status": 3611602.3008712977,
"title": "culpa sed voluptate",
"type": "sunt"
},
{
"detail": "commodo ullamco",
"instance": "aliquip elit",
"status": -90862211.85997924,
"title": "dolor non qui",
"type": "aliqua dolore Lorem"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
[
{
"statusCode": "transit",
"status": "Pick-up event ",
"description": "The shipment has been picked up at sender"
},
{
"statusCode": "transit",
"status": "Delivery attempted.",
"description": "The driver called today at {{event_date_time}} but the PIN code was not available."
},
{
"statusCode": "delivered",
"status": "Successful delivery",
"description": "The shipment has been successfully delivered"
},
{
"statusCode": "delivered",
"status": "Handover to parcelshop",
"description": "The shipment has been handed over to the parcelshop"
},
{
"statusCode": "delivered",
"status": "Successful delivery",
"description": "The shipment has been collected from the depot"
}
][
{
"detail": "laboris commodo do amet Lorem",
"instance": "nostrud",
"status": 16002462.54936026,
"title": "pariatur nostrud",
"type": "sunt"
},
{
"detail": "Ut exercitation labore",
"instance": "nulla amet dolore",
"status": -3587448.3777115494,
"title": "velit quis laboris voluptate in",
"type": "dolore et anim ut"
},
{
"detail": "dolor adipisicing",
"instance": "ea",
"status": 97054949.12288058,
"title": "officia pariatur",
"type": "adipisicing aliqua deserunt sit"
},
{
"detail": "cillum est",
"instance": "nostrud anim ad",
"status": 4092065.802074656,
"title": "exercitation pariatur ex eu enim",
"type": "sed fugiat laboris Lorem qui"
}
][
{
"detail": "est",
"instance": "sunt Duis do voluptate",
"status": -31918782.572798103,
"title": "incididunt cupidatat",
"type": "culpa eiusmod sunt pariatur do"
},
{
"detail": "aliqua anim adipisicing nisi cupidatat",
"instance": "Duis amet irure nostrud proident",
"status": 28334210.772767946,
"title": "aliquip",
"type": "reprehenderit"
},
{
"detail": "irure Lorem",
"instance": "et ex laboris Ut",
"status": 22366835.232479066,
"title": "in ex",
"type": "ut"
},
{
"detail": "sunt id Lorem et amet",
"instance": "ut",
"status": 93876913.25061578,
"title": "Duis",
"type": "ipsum"
},
{
"detail": "ullamco in occaecat",
"instance": "eiusmod",
"status": -92173747.45419882,
"title": "sunt ea officia",
"type": "est in consectetur enim"
}
][
{
"detail": "Lorem",
"instance": "Lorem veniam ullamco",
"status": 74193518.90002,
"title": "consequat nulla",
"type": "officia ad consectetur exercitation"
},
{
"detail": "mollit",
"instance": "non ea Duis",
"status": -56556991.7950266,
"title": "Excepteur aute laborum id enim",
"type": "Duis pariatur Ut non"
},
{
"detail": "deserunt quis",
"instance": "do labore ex veniam reprehenderit",
"status": 23967899.58933367,
"title": "incididunt qui eiusmod",
"type": "ex sit sunt esse sed"
},
{
"detail": "nostrud non exercitation dolor occaecat",
"instance": "nulla dolore aute",
"status": 28059386.20569454,
"title": "anim",
"type": "cupidatat"
},
{
"detail": "proident sed reprehenderit commodo do",
"instance": "cupidatat mollit id in",
"status": -81532439.55064951,
"title": "exercitation quis",
"type": "Lorem id nulla commodo laboris"
}
][
{
"detail": "nostrud consequat non",
"instance": "sit",
"status": 94363226.37481508,
"title": "nulla",
"type": "ea eiusmod deserunt"
},
{
"detail": "aliqua Ut cillum",
"instance": "sint aute consectetur",
"status": -11156571.441252574,
"title": "consequat tempor",
"type": "consequat aliquip"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
countryCode | minim dolor dolore et |
date | mollit pariatur amet nulla et |
region | cupidatat quis |
{
"publicHolidays": [
{
"countryCode": "GB",
"date": "2020-12-25T00:00:00.0000000+00:00",
"title": "Christmas Day",
"region": "england-and-wales"
},
{
"countryCode": "GB",
"date": "2021-01-02T00:00:00.0000000+00:00",
"title": "2nd January",
"region": "scotland"
}
]
}[
{
"detail": "culpa",
"instance": "amet dolore enim ut ut",
"status": 58750992.382555276,
"title": "occaecat sint proident",
"type": "mollit sunt aute"
},
{
"detail": "mollit aliqua dolor dolore",
"instance": "ut do",
"status": 72512931.44327065,
"title": "dolor cupidatat culpa",
"type": "Duis ex officia do elit"
},
{
"detail": "laborum sed ea non ipsum",
"instance": "sunt officia laborum",
"status": 86353679.93172917,
"title": "ipsum sed dolor reprehenderit",
"type": "cillum"
},
{
"detail": "non veniam deserunt",
"instance": "enim commodo",
"status": -33097314.726095207,
"title": "Lorem et",
"type": "labore reprehenderit"
},
{
"detail": "est",
"instance": "non irure Duis laboris nostrud",
"status": 1466717.1516942233,
"title": "mollit",
"type": "Ut ipsum exercitation ullamco"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
{
"ukPostcodeDistricts": [
{
"postcodeDistrict": "CV8 3",
"district": "BAGINTON",
"town": "COVENTRY",
"county": "WEST MIDLANDS",
"sortationCode": "51",
"latestNotification": "870",
"latestCollection": "1020",
"nineAm": true,
"tenThirtyAm": true,
"am": true,
"nextday": true,
"fortyEightHr": true,
"saturday": true,
"saturday9am": true,
"saturday1030am": true,
"thirdPartyCollection": true,
"returns": true,
"customslevel": "none",
"ukHolidayRegion": "england-and-wales",
"secondarySort": "RYTON"
},
{
"postcodeDistrict": "CV8 4",
"district": "BAGINTON",
"town": "COVENTRY",
"county": "WEST MIDLANDS",
"sortationCode": "51",
"latestNotification": "870",
"latestCollection": "1020",
"nineAm": true,
"tenThirtyAm": true,
"am": true,
"nextday": true,
"fortyEightHr": true,
"saturday": true,
"saturday9am": true,
"saturday1030am": true,
"thirdPartyCollection": true,
"returns": true,
"customslevel": "none",
"ukHolidayRegion": "england-and-wales",
"secondarySort": "RYTON"
}
]
}[
{
"detail": "occaecat",
"instance": "culpa",
"status": 30015480.8685634,
"title": "Duis occaecat Lorem tempor",
"type": "aliqua incididunt"
},
{
"detail": "eu",
"instance": "dolor consectetur ut et fugiat",
"status": -49077355.31574051,
"title": "mollit labore ad sed",
"type": "ut Duis nostrud eu"
},
{
"detail": "commodo in in aliqua",
"instance": "dolore aute fugiat Lorem",
"status": 7921392.517715558,
"title": "est aliquip",
"type": "Duis magna non Lorem"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
postcode | pariatur dolor |
{
"postcodeDistrict": "CV8 3",
"district": "BAGINTON",
"town": "COVENTRY",
"county": "WEST MIDLANDS",
"sortationCode": "51",
"latestNotification": "870",
"latestCollection": "1020",
"nineAm": true,
"tenThirtyAm": true,
"am": true,
"nextday": true,
"fortyEightHr": true,
"saturday": true,
"saturday9am": true,
"saturday1030am": true,
"thirdPartyCollection": true,
"returns": true,
"customslevel": "none",
"ukHolidayRegion": "england-and-wales",
"secondarySort": "RYTON"
}[
{
"detail": "dolor pariatur in fugiat veniam",
"instance": "sed",
"status": -91037431.56778869,
"title": "ad",
"type": "Duis sed"
}
]Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Service Homepage: developer.dhl.com/api-reference/ecommerce-uk#reference-docs-section
dhllogisticsshippingecommercetrackingrest