Page Comparison

Track Status API Components

identifier-name

Unique Name For Retailer

notification_id

We identify the notification from where the tracking page got triggered using notification_id.

important_updates

Message which retailer wants to display in the tracking page.

edd_info

Contains information regarding 

• Delivery date

• Delivery message

• Split delivery date

• Header name 

Note : Header name refers to whether the delivery date is the promised delivery date which is shown in checkout page or expected delivery date which is provided by the carrier after pickup or delivery date on package delivered to customer.

{
    "delivery_date": "Friday, September 09 2022", 
    "promised_date": "Monday, September 12 2022", 
    "delivery_message": "Yay, it\"s early...", 
    "expected_shipment_date": "Wednesday, September 07 2022", 
    "split_delivery_date": {
        "day": "Friday", 
        "month": "September", 
        "date": "09", 
        "year": "2022"
    }, 
    "header_name": "Expected Delivery Date"
}

display_order_info

Refers to whether to display order details(refer to order_info field)  on the page or not.

• true : display

• false : not to display

order_info

Contains Order related information such as 

{
    "number": "AAA", 
    "placed_dtm": "2022-09-07T10:55:11-05:00", 
    "formatted_dttm": "Wednesday, September 07 2022"
}

concise_infos

Moves the progress bar to the latest status (event). Events that Fenix can track are:

• Order Confirmed

• Shipment Confirmed

• Ready To Ship

• Shipment Cancelled

• Left Warehouse

• Shipment Exception

• Intransit

• Out for delivery

• Delivery Exception

• Return To Sender

• Returned To Sender

• Delivered

Depending on the last tracked event, Fenix shows only 4 events in the progress bar.

For more details refer here.

shipment_activities

To display Shipment Track Event History.

recent_shipment_info

Latest Track Event info which we will show in Latest update in Delivery Status section.

selected_shipment_activities

To build the complete progress bar section with stoppers.

line_items

Contains all the product details which are part of order or shipments. We will display line items information in Section 4.

display_lineitems

Refers to whether to display order line items on the tracking page or not. 

• true : display

• false : not to display

item_count

Refers to whether Single or MultiShipment package.

{
    "total_ordered": 3, 
    "total_filled": 2, 
    "current_packaged": 2
}

• total_filled: Items shipped by retailer.

• current_packaged:  Items which exist in the current package.

Note : If totalordered Count equals to currentPackaged then split_shipment flag will disable otherwise flag will be enable.

split_shipment

Refers to whether to display a multi shipment section or not.

• true : display “See full Order”

• false : not display ““See full Order”.

display_recommended_products

Refers to whether to call Recommended products API or not.

• true : call API

• false : not call API

Note: If ‘false’ then product recommendations section will be hidden.

page_by_ordernumber

Whether to trigger tracking page api by providing order_number. 

• true : both by order_number or tracking_number

• false : only by tracking_number

subscribed_for_delivery_notifications

Refers to whether to display Subscription section or not.

• true : display Subscription section

• false : not display subscription section