API Reference

Provide tracking updates

Fulfil will request the track endpoint for tracking updates for shipments. The frequency of requests vary. For example, when the status is out for delivery, the frequency of tracking updates will be every 15 minutes.

Example request

GET /track?tracking_numbers=A12345,A1212,B14545

A GET request is sent with the tracking numbers that are comma separated.

Expected Response

[
  {
    "tracking_number": "A12345",
    "status": "waiting"
  },
  {
    "tracking_number": "B14545",
    "status": "in_transit",
    "estimated_delivery_date": "2022-01-01"
  }
]

Supported tracking status values

Please see the list below for supported tracking status values supported by Fulfil.

Tracking status valueDescription
waitingThis status is usually sent when a label has been generated but not yet entered the mail stream.
in_transitThe shipment is currently in transit to the destination.
exceptionShipment is not in transit due to an exception such as invalid address.
deliveredShipment has been delivered successfully.
out_for_deliverySend this status if your system supports last mile delivery updates.
available_for_pickupIf a customer can pick-up the shipment at a drop-off location, this status can be sent.
cancelledThe shipment has been voided.
untrackableThe shipment is no longer trackable.
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!