...
Section 1, Section 2, Section 3, and Section 4 can be populated by using Track Status API Response.
Resource Name | getTrackHistory |
Resource URL | BTP by Tracking Number: api/v1/{identifier-name}/track-status?tracking_number=1Zu98dw9dxn¬ification_id=undefined |
CYO178t8cd¬ification_id=undefined | ||||||
Method | GET | |||||
Params (query/path) | PathVariable: Identifier-name RequestParam: tracking_number order_number notification_id Note: | |||||
Headers | ||||||
Request Payload | ||||||
Response Payload |
| |||||
Response Status | 200 - Success 400 – Failure 401 - Un-Authentication |
Track Status API Components | |
identifier-name | Unique Name For Retailer |
notification_id | |
It identifies the source channel through which shoppers route to branded tracking page. It’s provide us with which channels or notifications drive us more BTP open rates. | |||
Tracking Number (or) Order Number | Fenix BTP serves ether by tracking number or order number. In the order confirmation emails, put the tracking page link with order number(by that time, no tracking number is available). However, in the shipment confirmation and respected shipment status email put the tracking page link with tracking number specific to that shipment. | ||
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.
| ||
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
| ||
concise_infos | Moves the progress bar to the latest status (event). Events that Fenix can track are:
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.
| ||
item_count | Refers to whether Single or MultiShipment 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.
| ||
display_recommended_products | Refers to whether to call Recommended products API or not.
Note: If ‘false’ then product recommendations section will be hidden. | ||
page_by_ordernumber | Whether to trigger tracking page api by providing order_number.
| ||
subscribed_for_delivery_notifications | Refers to whether to display Subscription section or not.
|
RecommendedProducts API Details
Using RecommendedProducts API, Section 7 will be populated.
Fenix completely relies 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 | This is the date when order was placed. | ||
order_summary | Contains order related information such as
Note : If there is discrepancy between total_filled_item_quantity and total_item_quantity then we will display remaining items as unshipped items. | ||
shipment_summaries | Contains list of shipments. Each shipments contains information such as [
]
Note : If shipment contains tracking_number then we can track the shipment from the current page, otherwise we will display No Tracking Details Found message. | ||
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 |