Tracking

Get Tracking Info JSON

GET /trackinginfo/{retailer}/{carrier}

Get Item Tracking Info

GET /tracking/itemvisibility/v1/{retailer}/orders/{orderNumber}

GET /trackinginfo/{retailer}/{carrier}

Path variables

retailer

string required

retailer

Example:

peninsula

carrier

string required

carrier

Example:

narvar-speede

Request parameters

tracking_numbers

string optional

one or multiple tracking numbers separated by comma

Example:

123926129764172893974276

locale

string optional

Locale

Example:

en_US, de_DE

slug

string optional

slug associated with carrier

Example:

ups

order_date

string optional

The date order is placed, useful for estimated delivery date calculateion

Example:

2020-10-18T00:00:00Z

ship_date

string optional

Ship date of the items in the order

Example:

2020-10-18T00:00:00Z

ozip

string optional

Origin zipcode of the shipment

Example:

94105

dzip

string optional

Destination zipcode of the shipment

Example:

94105

origin_country

string optional

Origin Country

Example:

destination_country

string optional

Destination Country Code

Example:

type

string optional

Type of the shipment

Example:

ret, b, p

service

string optional

Carrier service code, useful for estimated delivery date calculation

Example:

GR, EX

promise_date

string optional

Promise date for delivery that retailer provides

Example:

2020-10-18T00:00:00Z

product_category

string optional

Product category for the items, used for retailer that has EDD rule configured based on category

Example:

women

dc_id

string optional

Retailer distribution center id, useful for estimated delivery date calculation

Example:

DC01

string optional

Token used by url obfuscation service, retailer can encrypt all the request params in token t and url obfuscation service will decrypt token and use the decrpted params to get tracking info

fname

string optional

used only by retailer Uniqlo for carrier Relais Colis integration

source

string optional

source of this track call

Example:

ShipConfEmail

Responses

200 200

Body

application/json

Object

trackingStatusCodes

boolean

Example:

true

resFromDelCr

boolean

pickedByCustomer

boolean

retailer_moniker

string

Example:

adidas

weight_uom

string

Example:

packageCount

integer

Example:

partner_carrier_tracking_number

string

weight

integer

Example:

source

string

Example:

WEB

locale

string

Locale

Example:

en_US

service_desc

string

Carrier service description

Example:

SMART_POST

status

string

Status of the shipment

Example:

On its way!

fb_uuid

string

Example:

932e7d58c10f45ebbab487ce93b49e3e::1603920001965

status_token

string

Example:

widgets_tracking_status_intransit_status

status_desc

string

Latest tracking status description

Example:

Arrived at FedEx location

tracking_number

string

Example:

9261297641728939742767

mask_tracking_number

string

guaranteed_delivery_date

string

Example:

2020-11-02 00:00:00

estimated_delivery_date_end

string

Example:

2020-11-02 00:00:00

estimated_delivery_date_begin

string

Example:

2020-11-02 00:00:00

edd_source

string

The source of Estimated Delivery Date

Example:

CARRIEREDD, NARVAR_EDD_COUNTRY_OC_DC

status_code

string

Latest tracking status code

Example:

order_number

string

class_of_mail_code

string

Example:

FXSP

pickup_start

string

pickup_end

string

ship_date

string

Example:

2020-10-27 00:00:00

no_eta_message

string

Message retailer wants to display when no estimated delivery date is available

Example:

Delivery date information will be available once details are provided by the carrier.

tracking_status_code

string

Narvar Tracking status code

Example:

INTR, DLVD

status_summary

string

Example:

Arrived at FedEx location

last_status_date

string

Example:

2020-10-27 18:58:00

TrackDetail

Array

Object

shipmentLocationType

string

Example:

FEDEX_FACILITY

error

string

error_code

string

event

string

Example:

Arrived at FedEx location

event_code

string

Example:

event_date

string

Example:

2020-10-27 18:58:00

event_city

string

Example:

HUTCHINS

event_state

string

Example:

event_country_code

string

Example:

event_date_offset

string

track_status_code_mapping

Object

track_status_code

string

Example:

300

track_status_code_desc

string

Example:

Picked-up by Carrier / In-Transit: General

track_status_display_token

string

Example:

tracking_status_intransit_pick_carrier

track_status_bucket

string

Example:

In Transit

track_status_bucket_code

string

Example:

INTR

track_status_bucket_display_token

string

Example:

widgets_tracking_status_intransit_status

track_status_code_raw

string

Example:

300

errors

Object

code

string

Example:

inv.request

message

string

Example:

Unknown Retailer Moniker in the URL

carrier_name

string

Example:

FedEx

carrier_url

string

Example:

http://www.fedex.com/us/office/customersupport/

carrier_id

string

Example:

fedex

partner_carrier_name

string

partner_carrier_url

string

partner_carrier_id

string

carrier_transfer

boolean

service_start_day

integer

service_end_day

integer

carrier_holidays

Array of string

tracking_url

string

Example:

https://www.fedex.com/fedextrack/?tracknumbers=9261297641728939742767&locale=en_US

narvar_status

string

Example:

INTRANSIT

undeliverable

boolean

Set to true when package is undeliverable

package_redirect

boolean

ship_by_date

string

pickup_date

string

is_label_cancelled

boolean

sms_signed_up

boolean

fb_messenger_signed_up

boolean

generic_tracking

boolean

promise_date_begin

string

promise_date_end

string

track_Url_Tracking_Id

string

Example:

9261297641728939742767

redirect_to_hold

Object

eligible

boolean

redirect_request_number

string

package_identifier

string

Example:

20201027163200~61297641728939742767~FXSP

has_nearby_locations

boolean

Example:

true

scheduled

boolean

confirmation_number

string

store_details

Object

is_tracking_status_codes

boolean

Example:

true

schedulable

Object

is_schedulable

boolean

reason

string

is_reschedulable

boolean

is_scheduled

boolean

is_schedulable_later

boolean

is_schedulable_api

boolean

eligibility_status

string

eligibility_message

string

redirect_address

Object

slug

string

Example:

fedex

broadcast_messages

Array

Universal Message displayed on track page for retailer

Object

status

string

Example:

Active

title

string

Example:

FedEx Planned Service Maintenance

content

string

Example:

FedEx has planned service maintenance from 9pm CDT on July 13 until 12am CDT of July 14. During this time, you may not see the latest tracking updates. Please check back after regular service has resumed for the most up to date tracking information.

carrier

string

date_modified

string

sub_messages

string

start_date

string

Example:

2018-07-13 07:00:00.000

end_date

string

Example:

2018-07-13 07:00:00.000

signature

boolean

is_picked_by_customer

boolean

is_internal_carrier

boolean

pickup_by_date

string

delivery_instructions

Object

polling

boolean

stops

Object

delivery_management_link

string

Example:

https://www.fedex.com/apps/fedextrack/index.html?tracknumbers=9261297641728939742767

line_package_subscription_text

string

Example:

c072017d693dc9582c651bc225dc2e01a729173dcd56eb4e95e60765599290c17f04a0dfa08c4a8e9327c4b801dd54864c95ae079528efca53cac48dd4abb0b56548baecfa8279181c89212dc5ffe1a6dfec68dc6ad2aeba4d0609ffa495db238ef4e61d423c1167d01d045aee69eb114bcd21c1a0525f675a6321e6f2f3e38580e35c8ae22f3fba37f0038d2ac1b2f22c8904bd3b1e3496f0bd776fa38e0751227b5c25cd2fdf37131a0e1

401 401

Unauthorized

403 403

Forbidden

404 404

Not Found

500 500

Internal Server Error

GET /tracking/itemvisibility/v1/{retailer}/orders/{orderNumber}

Path variables

retailer

string required

retailer

Example:

peninsula

orderNumber

string required

order number

Example:

34272349

Request parameters

tracking_numbers

string optional

one or multiple tracking number separated by comma

Example:

123926129764172893974276

locale

string optional

Locale

Example:

en_US, de_DE

slug

string optional

slug associated with carrier

Example:

ups

order_date

string optional

The date order is placed, useful for estimated delivery date calculateion

Example:

2020-10-18T00:00:00Z

ship_date

string optional

Ship date of the items in the order

Example:

2020-10-18T00:00:00Z

ozip

string optional

Origin zipcode of the shipment

Example:

94105

dzip

string optional

Destination zipcode of the shipment. It’s one of the validation field for second factor auth. If retailer opt in for 2FA and not valid, page will show masked experience.

Example:

94105

origin_country

string optional

Origin Country

Example:

destination_country

string optional

Destination Country Code

Example:

type

string optional

Type of the shipment

Example:

ret, b, p

service

string optional

Carrier service code, useful for estimated delivery date calculation

Example:

GR, EX

promise_date

string optional

Promise date for delivery that retailer provides

Example:

2020-10-18T00:00:00Z

product_category

string optional

Product category for the items, used for retailer that has EDD rule configured based on category

Example:

women

dc_id

string optional

Retailer distribution center id, useful for estimated delivery date calculation

Example:

DC01

string optional

Token used by url obfuscation service, retailer can encrypt all the request params in token t and url obfuscation service will decrypt token and use the decrpted params to get tracking info

fname

string optional

used only by retailer Uniqlo for carrier Relais Colis integration

string optional

One of the validation field for second factor auth, if not valid, page will show masked experience

Example:

test@gmail.com

phone

string optional

One of the validation field for second factor auth, if not valid, page will show masked experience

Example:

5101345633

Responses

200 200

Body

application/json

Object

order_info

Object

order_number

string

Example:

61245382

order_date

string

Example:

2020-10-22T17:23:48Z

order_items

Array

Object

item_id

string

Example:

7028114292860

retailer

string

sku

string

Example:

NMKTS40110_White_XL

name

string

Example:

Rap's Not Dead Short Sleeve Tee - White - XL

description

string

Example:

Rap's Not Dead Short Sleeve Tee - White

quantity

integer

Example:

item_image

string

Example:

https://cdn.shopify.com/s/files/1/0293/9277/products/08-18-20Studio1_CA_DJ_10-11-56_73_NMKTS40110_White_4841_KL.jpg?v=1597854845

item_url

string

Example:

https://fnova.myshopify.com/products/raps-not-dead-short-sleeve-tee-white

fulfillment_status

string

Example:

FULFILLED

item_promise_date

string

attributes

Object

color

string

size

string

Example:

style

string

shipments

Array

Object

items_info

Array

Object

quantity

integer

Example:

sku

string

Example:

NMKTS40110_White_XL

item_id

string

Example:

7028114292860

carrier

string

Example:

olx

ship_date

string

Example:

2020-10-23T11:14:49Z

tracking_number

string

Example:

UDS607856011

type

string

Example:

shipment

status

string

Example:

INTRANSIT

customer

Object

customer_id

string

Example:

5969412369

line_order_subscription_text

string

Example:

c072017cc795cab11af033df9e3e5db02f6eeb8206ce75ed8f80cbb2c79efe094c73815c1fb039b0b60683b2469458988d36c7ea3cc7b3bf70bad4a87529ab678f6db1fbd799d55ceb1eefef9183b36fe051f4107ac9e4aee2c82147bb8a27da86646e346f57f71d02e77fb9c7d24c6bbc4c705d45ece2d4ee1b26e229fa2ca93dff7b994d8e0e48f83c522

tracking_info

Array

Object

trackingStatusCodes

boolean

Example:

true

resFromDelCr

boolean

pickedByCustomer

boolean

retailer_moniker

string

Example:

fashionnova

weight_uom

integer

packageCount

integer

partner_carrier_tracking_number

string

weight

integer

source

string

Example:

WEB

locale

string

Example:

en_US

service_desc

string

status

string

Example:

On its way

fb_uuid

string

Example:

c7b3657717664045ab647005e00b2a7e::1603932142992

status_token

string

Example:

widgets_tracking_status_intransit_status

status_desc

string

Example:

Current location

tracking_number

string

Example:

UDS607856011

mask_tracking_number

string

guaranteed_delivery_date

string

Example:

2020-10-28 00:00:00

estimated_delivery_date_end

string

Example:

2020-10-28 00:00:00

estimated_delivery_date_begin

string

Example:

2020-10-28 00:00:00

edd_source

string

Example:

CACHE_CARRIEREDD

status_code

string

Example:

INTRANSIT

order_number

string

Example:

61245382

class_of_mail_code

string

pickup_start

string

pickup_end

string

ship_date

string

no_eta_message

string

tracking_status_code

string

Example:

INTR

status_summary

string

last_status_date

string

Example:

2020-10-27 09:17:00

TrackDetail

Array

Object

shipmentLocationType

string

error

string

error_code

string

event

string

Example:

Current location

event_code

string

Example:

INTRANSIT

event_date

string

Example:

2020-10-27 09:17:00

event_city

string

Example:

Shamrock

event_state

string

Example:

event_country_code

string

Example:

event_date_offset

string

track_status_code_mapping

Object

track_status_code

string

Example:

300

track_status_code_desc

string

Example:

Picked-up by Carrier / In-Transit: General

track_status_display_token

string

Example:

tracking_status_intransit_pick_carrier

track_status_bucket

string

Example:

In Transit

track_status_bucket_code

string

Example:

INTR

track_status_bucket_display_token

string

Example:

widgets_tracking_status_intransit_status

track_status_code_raw

string

Example:

300

errors

Object

code

string

Example:

inv.request

message

string

Example:

Unknown Retailer Moniker in the URL

carrier_name

string

Example:

Olx

carrier_url

string

Example:

http://www.websiteurl.com/

carrier_id

string

Example:

olx

partner_carrier_name

string

partner_carrier_url

string

partner_carrier_id

string

carrier_transfer

boolean

service_start_day

integer

service_end_day

integer

carrier_holidays

Array of string

tracking_url

string

narvar_status

string

Example:

INTRANSIT

undeliverable

boolean

package_redirect

boolean

ship_by_date

string

pickup_date

string

is_label_cancelled

boolean

sms_signed_up

boolean

fb_messenger_signed_up

boolean

generic_tracking

boolean

promise_date_begin

string

promise_date_end

string

track_Url_Tracking_Id

string

redirect_to_hold

Object

eligible

boolean

redirect_request_number

string

package_identifier

string

has_nearby_locations

boolean

Example:

true

scheduled

boolean

confirmation_number

string

store_details

Object

is_tracking_status_codes

boolean

Example:

true

schedulable

Object

is_schedulable

boolean

reason

string

is_reschedulable

boolean

is_scheduled

boolean

is_schedulable_later

boolean

is_schedulable_api

boolean

eligibility_status

string

eligibility_message

string

redirect_address

Object

slug

string

Example:

olx

broadcast_messages

Array

Object

status

string

Example:

Active

title

string

Example:

Up To 70% Off SITEWIDE

content

string

Example:

Save BIG On The NEW Arrivals. Use Code: NEW2020

carrier

string

date_modified

string

sub_messages

Array

Object

start_date

string

end_date

string

Example:

2020-07-17 07:00:00.000

signature

Object

required

boolean

is_picked_by_customer

boolean

is_internal_carrier

boolean

pickup_by_date

string

delivery_instructions

Object

polling

boolean

stops

Object

delivery_management_link

string

line_package_subscription_text

string

Example:

c072017fc5a9d9f5aab7d7b84e50fbc8d3f3cd098a20aad2a5183d547a93a6917520e1e9efe7c43e1b0508419e165a773c4d5049d0fb38e182d7b75c99654f718b001f92eb93e9eb1c3d49ac2244775d206bdde09157040d5d6719963bb99b0ce39159f86e7fce5d09fbf5b3e751736bf377c747a9535a996ba1efcea5b82bec2a21017898ade5f60b556a8

invalid_item_vis_request

boolean

status

string

Example:

SUCCESS

messages

Array

Object

code

string

Example:

response.status.success

401 401

Unauthorized

403 403

Forbidden

Body

If Cequence Header present, and tracking number / dzip not valid, 403 will be returned.

404 404

Not Found

500 Internal Server Error

Object

code

string

message

string

Object

city

string

country

string

country_code

string

lat

number float

lng

number float

location_id

integer int32

location_name

string

state

string

street_1

string

street_2

string

zip

string

zip_2

string

Object

filters

FilterProvider

jsonpFunction

string

value

Object

address

string

city

string

company_name

string

country_code

string

postal_code

string

state

string

Object

eligibility_message

string

eligibility_status

string

is_reschedulable

boolean

is_schedulable

boolean

is_schedulable_api

boolean

is_schedulable_later

boolean

is_scheduled

boolean

reason

string

Object

carrier_code

string

carrier_desc

string

code

string

code_desc

string

narvar_code

string

required

boolean

Object

last_location

Location

preceding_stops

integer int32

stops_away

integer int32

total_stops

integer int32

Object

ArrivalLocation

string

CarrierEventCode

string

CarrierEventDesc

string

CarrierMoniker

string

Event

string

EventCity

string

EventCode

string

EventCountry

string

EventDate

string

EventDateOffset

string

EventState

string

EventStreet1

string

EventStreet2

string

EventTime

string

EventZIPCode

string

ShipmentError

string

ShipmentErrorCode

string

TrackingShipmentDisplayToken

string

TrackingStatusBucket

string

TrackingStatusBucketCode

string

TrackingStatusCode

string

TrackingStatusCodeDesc

string

TrackingStatusCodeRaw

string

TrackingStatusDisplayToken

string

lat

string

long

string

Object

AdditionalUrlInfo

string

ApptWindowEnd

string

ApptWindowStart

string

CarrierCode

string

Class

string

ClassOfMailCode

string

Courier

string

CourierImage

string

DeliveryCarrier

string

DeliveryNotificationDate

string

DeliveryStreet

string

DestinationCity

string

DestinationCountryCode

string

DestinationStreet

string

DestinationZip

string

ExpectedDeliveryDate

string

ExpectedDeliveryDateEnd

string

GuranteedDeliveryDate

string

GuranteedDeliveryTime

string

MPDATE

string

OrderNumber

string

OriginCity

string

OriginCountryCode

string

OriginState

string

OriginStreet

string

OriginZip

string

POD

string

PackageCount

string

PackageRedirect

string

PartnerTrackingId

string

PhoneAreaCode

string

PhoneNumber

string

PickupDeliveryDate

string

PinNumber

string

ReceivedOn

string

RecipientName

string

RescheduledDeliveryDate

string

Schedulable

ShipmentAccount

string

ShipperName

string

Status

string

StatusCategory

string

StatusSummary

string

TotalCharge

string

TrackDetail

Array of TrackDetailModel

TrackSummary

TrackDetailModel

TrackUrlTrackingId

string

TrackingStatus

string

TrackingStatusCode

string

TrackingStatusToken

string

UniqueIdentifierNumber

string

UseCarrierDescription

boolean

Weight

string

WeightUnit

string

carrierTransfer

boolean

carrierUrl

string

destinationState

string

isCarrierTransfer

boolean

isDelivered

boolean

isDeliveryCarrier

boolean

isResFromDelCr

boolean

originState

string

redirect_address

RedirectAddressModel

resFromDelCr

boolean

signature

SignatureModel

stops

Stops

Object

MultiTrackInfo

Array of TrackInfoModel

TrackInfo

TrackInfoModel

error

ErrorModel