Add a package tracker

POST 
/v1/trackers

This API creates or retrieves (if existent) a tracking status object containing the details and events of a shipping in progress.

Request

Query Parameters

hub string
pending_pickup boolean

Add this flag to add the tracker whether the tracking info exist or not.When the package is eventually picked up, the tracker with capture real time updates.

application/json

Body

required

tracking_number stringrequired

The package tracking number

carrier_name stringrequired

Possible 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, fedex, fedex_ws, generic, geodis, hay_post, laposte, locate2u, nationex, purolator, roadie, royalmail, seko, sendle, tge, tnt, ups, usps, usps_international, usps_wt, usps_wt_international, zoom2u]

The tracking carrier

account_number stringnullable

The shipper account number

reference stringnullable

The shipment reference

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

metadata

object

The carrier user metadata.

property name* any

Default value: [object Object]

The carrier user metadata.

Responses

200

application/json

Schema

Schema

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

Example (from schema)

{
  "id": "string",
  "carrier_name": "string",
  "carrier_id": "string",
  "tracking_number": "string",
  "info": {
    "carrier_tracking_link": "string",
    "customer_name": "string",
    "expected_delivery": "string",
    "note": "string",
    "order_date": "string",
    "order_id": "string",
    "package_weight": "string",
    "package_weight_unit": "string",
    "shipment_package_count": "string",
    "shipment_pickup_date": "string",
    "shipment_delivery_date": "string",
    "shipment_service": "string",
    "shipment_origin_country": "string",
    "shipment_origin_postal_code": "string",
    "shipment_destination_country": "string",
    "shipment_destination_postal_code": "string",
    "shipping_date": "string",
    "signed_by": "string",
    "source": "string"
  },
  "events": [
    {
      "date": "string",
      "description": "string",
      "location": "string",
      "code": "string",
      "time": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "delivered": true,
  "test_mode": true,
  "status": "pending",
  "estimated_delivery": "string",
  "meta": {},
  "object_type": "tracker",
  "metadata": {},
  "messages": [
    {
      "message": "string",
      "code": "string",
      "details": {},
      "carrier_name": "string",
      "carrier_id": "string"
    }
  ],
  "delivery_image_url": "string",
  "signature_image_url": "string"
}

400

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

424

application/json

Schema

Schema

messages

object[]

The list of error 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)

]

Example (from schema)

{
  "messages": [
    {
      "message": "string",
      "code": "string",
      "details": {},
      "carrier_name": "string",
      "carrier_id": "string"
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...