Skip to content
Products
/Better Tracking/
/Customization

Real Time Tracking API (2.0.0)

Real Time Tracking API - Managed by Tracking Team

Download OpenAPI description
btt.json
btt.yaml
Overview
URL

https://bettermile.com

E-mail

tracking@bettermile.com

License

Proprietary

Languages
Servers
PROD

https://tracking.bettermile.com/

Parcel

Endpoints related to parcel information and tracking

Operations

Availability

Endpoints related to parcel availability

Operations

Customization

Endpoints related to parcel customizations

Operations

Customization

Request

Add customized delivery (neighbor delivery, deposit permission, consignee note etc.) for parcel by tenant id and parcel identifier

Security
bearerToken
Path
parcelIdentifierstringrequired

Parcel number or tracking id

Example: 10362781851
Bodyapplication/jsonrequired

Actual customized delivery for parcel

typestringrequired
Value"DEPOSIT_PERMISSION"
Discriminator
createdAtstring(date-time)required
Example: "2022-01-15T14:33:25Z"
descriptionstringrequired
Example: "Hinter der Tonne"
locationstringrequired
Example: "Carport"
curl -i -X PUT \
  https://tracking.bettermile.com/api/v2/external/parcel/10362781851/customization \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "DepositPermission",
    "createdAt": "2022-01-15T14:33:25Z",
    "location": "Carport",
    "description": "Hinter der Tonne"
  }'

Responses

Parcel response

Bodyapplication/json
parcelNumberstringrequired
Example: "10362781851"
trackingIdstringrequired
Example: "YUTKBBTN"
statusobject(ParcelStatus)required
One of:
status.​typestringrequired
Value"DELIVERED"
status.​detailstring(ParcelStatusDetailTypeDelivered)required
Enum"NORMAL""NEIGHBOR""PARCEL_SHOP""DEPOSIT""OTHER"
status.​deliveredAtstring(date-time)
Example: "2022-01-15T14:33:25Z"
status.​addressobject(Address)
status.​nameany(string)

Neighbour name, present only for detail = 'TO_NEIGHBOR'

jobTypestring(JobType)required
Enum"DELIVERY""PICKUP""COLLECTION""UNKNOWN"
supportedCustomizedDeliveryTypesArray of strings(CustomizedDeliveryType)required
Items Enum"DEPOSIT_PERMISSION""DELIVER_TO_NEIGHBOR""DELIVER_TO_PARCELSHOP""HINT"
shipperIdstring(ShipperId)
customizedDeliveryobject(CustomizedDelivery)
One of:
fromAddressobject(AddressName)
toAddressobject(Address)
Response
application/json
{
  "trackingId": "YUTKBBTN",
  "parcelNumber": "10362781851",
  "status": {
    "type": "DELIVERED",
    "detail": "NORMAL",
    "deliveredAt": "2022-01-15T14:33:25Z",
    "address": { … },
    "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": { … }
  }
}