Versions Compared

Old Version 22

changes.mady.by.user Former user

Saved on

compared with

New Version 23

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Resource Name

getTrackHistory

Resource URL

api/v1/{identifier-name}/track-status?tracking_number=123&notification_id=undefined

Method

GET

Params (query/path)

PathVariable:

Identifier-name

RequestParam:

tracking_number

order_number

notification_id

Headers

Request Payload

Response Payload

Code Block
languagejson
{
    "fenixShipping": true, 
    "tracking_number": "123", 
    "carrier_name": "UPS", 
    "important_updates": "Please note that carrier delays can occur due to weather or COVID-19. Many carrier hubs have had to adjust to ensure the health + safety of their employees and it may impact transit times. Please reach out to <a href =\"https://www.yourstore.com/pages/contact-us\">yourstore.com</a> with any questions you have about your order.", 
    "display_emoji": false, 
    "emoji_on": null, 
    "edd_info": {
        "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": true, 
    "order_info": {
        "number": "AAA", 
        "placed_dtm": "2022-09-07T10:55:11-05:00", 
        "formatted_dttm": "Wednesday, September 07 2022"
    }, 
    "concise_infos": [
        {
            "description": "SHIPPED", 
            "event_date": "Wednesday, September 07 2022", 
            "event_code": "SH", 
            "event_message": "Order Confirmed"
        }, 
        {
            "description": "PICKED", 
            "event_date": "Wednesday, September 07 2022", 
            "event_code": "PU", 
            "event_message": "Left Warehouse"
        }
    ], 
    "shipment_activities": [
        {
            "day": "Sep 07, 2022", 
            "time": "12:09 PM", 
            "desc": "Shipper created a label, UPS has not received the package yet.", 
            "address": {
                "first_name": null, 
                "last_name": null, 
                "name": null, 
                "company": null, 
                "address1": null, 
                "address2": null, 
                "country": "US", 
                "country_code": "US", 
                "province": null, 
                "province_code": null, 
                "city": null, 
                "zip_code": null, 
                "latitude": null, 
                "longitude": null
            }, 
            "event_code": "MP", 
            "fenix_code": "IT"
        }, 
        {
            "day": "Sep 07, 2022", 
            "time": "06:43 PM", 
            "desc": "Origin Scan", 
            "address": {
                "first_name": null, 
                "last_name": null, 
                "name": null, 
                "company": null, 
                "address1": null, 
                "address2": null, 
                "country": "US", 
                "country_code": "US", 
                "province": "FL", 
                "province_code": "FL", 
                "city": "Orlando", 
                "zip_code": null, 
                "latitude": null, 
                "longitude": null
            }, 
            "event_code": "OR", 
            "fenix_code": "IT"
        }, 
        {
            "day": "Sep 08, 2022", 
            "time": "12:49 PM", 
            "desc": "Received by the local post office", 
            "address": {
                "first_name": null, 
                "last_name": null, 
                "name": null, 
                "company": null, 
                "address1": null, 
                "address2": null, 
                "country": null, 
                "country_code": null, 
                "province": null, 
                "province_code": null, 
                "city": null, 
                "zip_code": null, 
                "latitude": null, 
                "longitude": null
            }, 
            "event_code": "YH", 
            "fenix_code": "IT"
        }
    ], 
    "recent_shipment_info": {
        "day": "Sep 08, 2022", 
        "time": "12:49 PM", 
        "desc": "Received by the local post office", 
        "address": {
            "first_name": null, 
            "last_name": null, 
            "name": null, 
            "company": null, 
            "address1": null, 
            "address2": null, 
            "country": null, 
            "country_code": null, 
            "province": null, 
            "province_code": null, 
            "city": null, 
            "zip_code": null, 
            "latitude": null, 
            "longitude": null
        }, 
        "event_code": "YH", 
        "fenix_code": "IT"
    }, 
    "selected_shipment_activities": [
        {
            "event_code": "SH", 
            "display_message": "Order Confirmed"
        }, 
        {
            "event_code": "PU", 
            "display_message": "Left Warehouse"
        }, 
        {
            "event_code": "OFD", 
            "display_message": "Out for delivery"
        }, 
        {
            "event_code": "DL", 
            "display_message": "Delivered"
        }
    ], 
    "line_items": [
        {
            "sku": "101102", 
            "quantity": 1, 
            "name": "special cleansing gel - travel - 1.7 oz", 
            "title": "special cleansing gel - travel", 
            "variantId": "123", 
            "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/specialcleansinggel_1.7oz_98dee553-f068-43c8-a94b-5cb93e84d0c1.jpg?v=164764199788", 
            "product_id": "123", 
            "routing_url": "https://www.yourstore.com/products/special-cleansing-gel-travel"
        }, 
        {
            "sku": "111249", 
            "quantity": 1, 
            "name": "daily microfoliant exfoliator - 2.6 oz", 
            "title": "daily microfoliant exfoliator", 
            "variantId": "123", 
            "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/daily-microfoliant_main-with-benefits.jpg?v=16600853368", 
            "product_id": "123", 
            "routing_url": "https://www.yourstore.com/products/daily-microfoliant"
        }
    ], 
    "display_lineitems": true, 
    "item_count": {
        "total_ordered": 3, 
        "total_filled": 2, 
        "current_packaged": 2
    }, 
    "remaning_days_to_delivery_info": "Your Order is Going to Deliver Today", 
    "display_recommended_products": true
}

Response Status

200 - Success

400 – Failure

401 - Un-Authentication 

Track Status API

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

To move the progress bar to the latest status(event).

shipment_activities

To display Shipment Track Event History.

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 Section4.

display_lineitems

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

  • true : display

  • false : not to display

item_count

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

  {

        "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 : Based on discrepancy between total ordered and current packaged count.

display_recommended_products

Refers to whether to call Recommended products API or not.

  • true : call API

  • false : not call API

RecommendedProducts API Details

...