Skip to main content

List all package trackers

GET 
/v1/trackers

Retrieve all shipment trackers.

Request​

Query Parameters

    carrier_name string

    The unique carrier slug.
    Values: allied_express, allied_express_local, amazon_shipping, aramex, asendia_us, australiapost, boxknight, bpost, canadapost, canpar, chronopost, colissimo, dhl_express, dhl_parcel_de, dhl_poland, dhl_universal, dicom, dpd, dpdhl, easypost, eshipper, fedex, fedex_ws, freightcom, generic, geodis, hay_post, laposte, locate2u, nationex, purolator, roadie, royalmail, sapient, seko, sendle, tge, tnt, ups, usps, usps_international, usps_wt, usps_wt_international, zoom2u

    created_after date-time
    created_before date-time
    status string

    Valid tracker status.
    Values: pending, unknown, on_hold, delivered, in_transit, delivery_delayed, out_for_delivery, ready_for_pickup, delivery_failed

    tracking_number string

Responses​

Schema

    count integernullable
    next urinullable
    previous urinullable

    results

    object[]

    required

  • Array [

    • id string

    A unique identifier

    carrier_name stringrequired

    The tracking carrier

    carrier_id stringrequired

    The tracking carrier configured identifier

    tracking_number stringrequired

    The shipment tracking number

    info

    object

    nullable

    carrier_tracking_link stringnullable

    The carrier tracking link

    customer_name stringnullable

    The customer name

    expected_delivery stringnullable

    The expected delivery date

    note stringnullable

    A tracking note

    order_date stringnullable

    The package order date

    order_id stringnullable

    The package order id or number

    package_weight stringnullable

    The package weight

    package_weight_unit stringnullable

    The package weight unit

    shipment_package_count stringnullable

    The package count

    shipment_pickup_date stringnullable

    The shipment pickup date

    shipment_delivery_date stringnullable

    The shipment delivery date

    shipment_service stringnullable

    The shipment service

    shipment_origin_country stringnullable

    The shipment origin country

    shipment_origin_postal_code stringnullable

    The shipment origin postal code

    shipment_destination_country stringnullable

    The shipment destination country

    shipment_destination_postal_code stringnullable

    The shipment destination postal code

    shipping_date stringnullable

    The shipping date

    signed_by stringnullable

    The person who signed for the package

    source stringnullable

    The tracker source

    events

    object[]

    nullable

    The tracking details events

  • Array [

    • date string

    The tracking event's date. Format: YYYY-MM-DD

    description string

    The tracking event's description

    location string

    The tracking event's location

    code stringnullable

    The tracking event's code

    time stringnullable

    The tracking event's time. Format: HH:MM AM/PM

    latitude doublenullable

    The tracking event's latitude.

    longitude doublenullable

    The tracking event's longitude.

  • ]

    • delivered boolean

    Specified whether the related shipment was delivered

    test_mode booleanrequired

    Specified whether the object was created with a carrier in test mode

    status string

    Possible values: [pending, unknown, on_hold, delivered, in_transit, delivery_delayed, out_for_delivery, ready_for_pickup, delivery_failed]

    Default value: pending

    The current tracking status

    estimated_delivery string

    The delivery estimated date

    meta

    object

    nullable

    provider specific metadata

    property name* anynullable

    provider specific metadata

    object_type string

    Default value: tracker

    Specifies the object type

    metadata

    object

    User metadata for the tracker

    property name* any

    Default value: [object Object]

    User metadata for the tracker

    messages

    object[]

    The list of note or warning messages

  • Array [

    • message string

    The error or warning message

    code string

    The message code

    details

    object

    any additional details

    property name* any

    any additional details

    carrier_name string

    The targeted carrier

    carrier_id string

    The targeted carrier name (unique identifier)

  • ]

    • delivery_image_url urinullable

    The shipment invoice URL

    signature_image_url urinullable

    The shipment invoice URL

  • ]

Loading...