The Better Tracking API is secured from unauthorised use by restricting requests using basic HTTP authentication.
The Authorization header should contain an API key, a unique alphanumeric string that associates your customer billing account with your requests.
To get an api key please contact the BetterTracking team at tracking@bettermile.com.
The Parcel endpoint returns information regarding a given parcel. This broadly includes shipper and consignee address, delivery information, ETA timestamps and much more.
Parcel response
Authorization information is missing or invalid
Rate limit exceeded
Error message
{- "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
}
}
}Checks if parcel is in delivery and real time tracking is available
Parcel is in delivery and available for real time tracking
Authorization information is missing or invalid
Parcel not found or not available for real time tracking
Rate limit exceeded
Error message
{- "timestamp": "2022-01-15T14:33:25Z",
- "path": "/v1/external/parcel",
- "status": 401,
- "error": "Unauthorized",
- "message": "Authorization required",
- "requestId": "331f2ea7-197"
}This endpoint allows you to subscribe to tracking updates for a specific parcel. It provides detailed information about the parcel’s status, ensuring that it can be tracked throughout its journey.
OK
Unauthorized
Parcel not found
Server error
{- "parcelNumber": "string",
- "tenantId": "string"
}{- "parcelNumber": "string",
- "tenantId": "string",
- "status": {
- "position": {
- "lat": 50.9098881,
- "lng": 9.5806327
}, - "etaTimestampMin": "2022-01-15T14:15:00Z",
- "etaTimestampMax": "2022-01-15T14:45:00Z",
- "remainingStops": 0,
- "type": "OUT_FOR_DELIVERY"
}
}