Parcel

Operations about parcels

Parcel

The Parcel endpoint returns information regarding a given parcel. This broadly includes shipper and consignee address, delivery information, ETA timestamps and much more.

SecuritybasicAuth

Request

path Parameters

parcelIdentifier

required

string

Parcel number or tracking id

Example: 10362781851

Responses

200

Parcel response

401

Authorization information is missing or invalid

429

Rate limit exceeded

default

Error message

get/external/parcel/{parcelIdentifier}

Request samples

curl
Java
Python
JavaScript

Response samples

200
401
429
default

application/json

{"trackingId": "YUTKBBTN",
"parcelNumber": "10362781851",
"status": {"type": "DELIVERED",
"detail": "NORMAL",
"deliveredAt": "2022-01-15T14:33:25Z",
"address": {"name": "Max Mustermann",
"street": "GLS Germany-Straße",
"number": "1-7",
"postcode": 36286,
"city": "Neuenstein",
"country": "DE",
"coordinates": {"lat": 50.9098881,
"lng": 9.5806327
}
},
"name": null
},
"shipperId": "bmw",
"jobType": "DELIVERY",
"supportedCustomizedDeliveryTypes": ["DEPOSIT_PERMISSION"
],
"customizedDelivery": {"type": "DEPOSIT_PERMISSION",
"createdAt": "2022-01-15T14:33:25Z",
"location": "Carport",
"description": "Hinter der Tonne"
},
"fromAddress": {"name": "Max Mustermann"
},
"toAddress": {"name": "Max Mustermann",
"street": "GLS Germany-Straße",
"number": "1-7",
"postcode": 36286,
"city": "Neuenstein",
"country": "DE",
"coordinates": {"lat": 50.9098881,
"lng": 9.5806327
}
}
}

Customization

The Customization endpoint allows to set a delivery customization for a given parcel. This includes setting a neighbor delivery or deposit permission.

SecuritybasicAuth

Request

path Parameters

parcelIdentifier

required

string

Parcel number or tracking id

Example: 10362781851

Request Body schema: application/json

Actual customized delivery for parcel

type required	string DepositPermission
createdAt required	string <date-time>
location required	string
description required	string

Responses

200

Parcel response

401

Authorization information is missing or invalid

429

Rate limit exceeded

default

Error message

put/external/parcel/{parcelIdentifier}/customization

Request samples

Payload
curl
Java
Python
JavaScript

application/json

{"type": "DepositPermission",
"createdAt": "2022-01-15T14:33:25Z",
"location": "Carport",
"description": "Hinter der Tonne"
}

Response samples

200
401
429
default

application/json

{"trackingId": "YUTKBBTN",
"parcelNumber": "10362781851",
"status": {"type": "DELIVERED",
"detail": "NORMAL",
"deliveredAt": "2022-01-15T14:33:25Z",
"address": {"name": "Max Mustermann",
"street": "GLS Germany-Straße",
"number": "1-7",
"postcode": 36286,
"city": "Neuenstein",
"country": "DE",
"coordinates": {"lat": 50.9098881,
"lng": 9.5806327
}
},
"name": null
},
"shipperId": "bmw",
"jobType": "DELIVERY",
"supportedCustomizedDeliveryTypes": ["DEPOSIT_PERMISSION"
],
"customizedDelivery": {"type": "DEPOSIT_PERMISSION",
"createdAt": "2022-01-15T14:33:25Z",
"location": "Carport",
"description": "Hinter der Tonne"
},
"fromAddress": {"name": "Max Mustermann"
},
"toAddress": {"name": "Max Mustermann",
"street": "GLS Germany-Straße",
"number": "1-7",
"postcode": 36286,
"city": "Neuenstein",
"country": "DE",
"coordinates": {"lat": 50.9098881,
"lng": 9.5806327
}
}
}

Tracking Availability

Checks if parcel is in delivery and real time tracking is available

SecuritybasicAuth

Request

path Parameters

parcelIdentifier

required

string

Parcel number or tracking id

Example: 10362781851

Responses

200

Parcel is in delivery and available for real time tracking

401

Authorization information is missing or invalid

404

Parcel not found or not available for real time tracking

429

Rate limit exceeded

default

Error message

get/external/parcel/{parcelIdentifier}/availability

Request samples

curl
Java
Python
JavaScript

Response samples

401
404
429
default

application/json

{"timestamp": "2022-01-15T14:33:25Z",
"path": "/v1/external/parcel",
"status": 401,
"error": "Unauthorized",
"message": "Authorization required",
"requestId": "331f2ea7-197"
}