...
Section 1, Section 2, Section 3, and Section 4 can be populated by using Track Status API Response.
Resource Name | getTrackHistory | |||||
Resource URL | api/v1/{identifier-name}/track-status?tracking_number=123¬ification_id=undefined | |||||
Method | GET | |||||
Params (query/path) | PathVariable: Identifier-name RequestParam: tracking_number order_number notification_id | |||||
Headers | ||||||
Request Payload | ||||||
Response Payload |
| |||||
Response Status | 200 - Success 400 – Failure 401 - Un-Authentication |
Track Status API Components | |
identifier-name | |
notification_id | |
important_updates | Message which retailer wants to display in the tracking page. |
edd_info | Contains information regarding
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.
|
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. |
recent_shipment_info | |
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.
|
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 total ordered and current packaged count “See full Order” will be displayed if order has multiple shipments. |
display_recommended_products | Refers to whether to call Recommended products API or not.
Note: If ‘false’ then product recommendations section will be hidden. |
RecommendedProducts API Details
Using RecommendedProducts API, Section 7 will be populated.
Fenix completely relying on Shopify Recommended Product API to get and display recommended products.
Resource Name | getRecommendations | ||
Resource URL | /api/v3/{identifier-name}/recommended_products?tracking_number=123 | ||
Method | GET | ||
Params (query/path) | PathVariable: Identifier-name RequestParam: tracking_number order_number | ||
Headers | |||
Request Payload | |||
Response Payload |
| ||
Response Status | 200 - Success 400 – Failure 401 - Un-Authentication |
Multi-Shipment Visibility API Details
Using the Multi-Shipment Visibility API, Section 8 data will be populated.
Resource Name | getTrackHistory | |||||
Resource URL | api/v2/{identifier-name}/track-status?order_number=AAA&place_dttm=2022-07-19T14:16:04-05:00 | |||||
Method | GET | |||||
Params (query/path) | PathVariable: Identifier-name RequestParam: place_dttm order_number | |||||
Headers | ||||||
Request Payload | ||||||
Response Payload |
| |||||
Response Status | 200 - Success 400 – Failure 401 - Un-Authentication |
Multi Shipment Status API Components | |
place_dttm | |
order_summary | Contains order related information such as { "number": "AAA", "placed_date": "Wednesday, September 07 2022", "promised_date": "Monday, September 12 2022", "split_delivery_date": { "day": "Monday", "month": "September", "date": "12", "year": "2022" }, "total_item_quantity": 3, "total_filled_item_quantity": 2, "line_items": [ { "sku": "456", "quantity": 1, "name": "double cleanse full size kit - each", "title": "double cleanse full size kit", "variantId": "41694522802328", "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/double-cleanse-set_carton-front.jpg?v=1653587001", "product_id": "7255087710360", "routing_url": "https://www.store-us.com/products/double-cleanse-full-size-kit" } ] } line_items : Contains all the product details which are part of order. Note : If there is discrepancy between total_filled_item_quantity and total_item_quantity then Fenix will display remaining items as unshipped items. |
shipment_summaries | Contains list of shipments. Each shipments contains information such as [ { "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" }, "tracking_number": "123", "carrier_name": "UPS", "event_message": "Left Warehouse", "item_quantity": 2, "line_items": [ { "sku": "123", "quantity": 1, "name": "special cleansing gel - travel - 1.7 oz", "title": "special cleansing gel - travel", "variantId": "11123", "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/specialcleansinggel_1.7oz_98dee553-f068-43c8-a94b-5cb93e84d0c1.jpg?v=164", "product_id": "5710539751576", "routing_url": "https://www.store-us.com/products/special-cleansing-gel-travel" }
]
Note : If line_items contains tracking_number then we can track the shipment from the current page, otherwise we will display No Tracking Details Found text. |
Feedback API Details
Using the Feedback API, Section 9 data will be populated.
Resource Name | createTrackingPageFeedback | |||||
Resource URL | api/v1/tracking-page-feedback | |||||
Method | POST | |||||
Params (query/path) | ||||||
Headers | ||||||
Request Payload |
| |||||
Response Payload | ||||||
Response Status | 200 - Success 400 – Failure 401 - Un-Authentication |
Delivery Status Subscription API
Using Delivery Status Subscription API, Section 10 will be populated.
Email Subscription
Resource Name | subscribeForEmail | |||||
Resource URL | api/v1/btp/{identifier-name}/trackevent-notification/email-subscription | |||||
Method | POST | |||||
Params (query/path) | PathVariable: Identifier-name | |||||
Headers | ||||||
Request Payload |
| |||||
Response Payload |
| |||||
Response Status | 200 - Success 400 – Failure 401 - Un-Authentication |
SMS Subscription
Resource Name | subscribeForSMS | |||||
Resource URL | api/v1/btp/{identifier-name}/trackevent-notification/sms-subscription | |||||
Method | POST | |||||
Params (query/path) | PathVariable: Identifier-name | |||||
Headers | ||||||
Request Payload |
| |||||
Response Payload |
| |||||
Response Status | 200 - Success 400 – Failure 401 - Un-Authentication |
Delivery Status Subscription API Components | |
|---|---|
channel_type | |
channel_hub_id | |
track_events | |