Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Introduction

In the post-pandemic era, engaging with customers after the sale is more crucial to eCommerce business success than ever before. A personalized post-purchase experience is a key differentiator that retailers and DTC businesses need in order to transform today’s buyers into repeat customers.

FenixCommerce’s post-purchase platform allows eCommerce businesses to provide on-brand after sale customer experiences that build trust and rapport, reduce WISMO calls, and drive customer incremental value.

FenixCommerce Branded Tracking Pages

With Fenix, you can create awesome Branded Tracking Pages customized with your brand logo and theme to enable customers to track their shipments in real-time.

Fenix Branded Tracking Page Sections

Fenix Branded Tracking page consists of the following sections:

  • Section 1: Delivery Status

  • Section 2: Important Updates

  • Section 3: Track Event History

  • Section 4: Order Line Items in the Package

  • Section 5: Digital Assets (Vertical images)

  • Section 6: Promotional Videos & Digital Assets (Horizontal image)

  • Section 7: Product Recommendations

  • Section 8: Multi-Shipment View

  • Section 9: Feedback Ratings & Comments

  • Section 10: Delivery status updates subscription

  • Section 11: Headers & Footers

Section 1: Delivery Status

  1. The Delivery Status section depends on TrackingStatus API Response.

  2. This section consists of:

    1. Progress Bar Menu

      1. Progress Bar menu names come from the selected_shipment_activities list. Progress Bar menu names can be configured as per your needs. The bar moves by considering a concise info list.

    2. Delivery Date (delivery_date field from edd_info object)

    3. Delivery Status (latest event from concise info list)

    4. Order Number and Placed on date ( from order_info)

    5. Tracking Number (taking from tracking_number field)

 Section 2: Important Updates

  1. Important updates: Considering the important_updates field from TrackingStatus API Response.

  2. It's easily configurable from the backend.

Section 3: Track Event History

  1. Tracking page API response provides the track events.

  2. We are considering events from the shipment_activities list.

Section 4: Order Line Items in the Package

  1. Fenix will enable the boolean flag display_line_items from the backend configuration if you want to display the order line items on the tracking page

  2. We are considering line items from line_items list from the TrackingStatus API Response.

Section 5: Digital Assets (Vertical images)

  1. Fenix UI team will integrate the Digital Assets (Vertical images) that you provide. It's a static configuration.

Section 6: Promotional Videos & Digital Assets (Horizontal image)

  1. Fenix UI team will integrate the Promotional videos (Youtube) & Digital Assets (Horizontal image) that you provide. It's a static configuration.

Section 7: Product Recommendations

  1. RecommendedProducts API  response provides the recommended product information.

  2. Fenix team uses Shopify Algorithm to display recommended products. 

  3. Fenix team will enable the boolean flag display_recommended_products from the backend configuration if you want to showcase the recommended products on the tracking page.

Note: If you have your own Algorithm or Recommendation engine to retrieve recommended products, you can utilize it to show recommended products.

Section 8: Multi-Shipment View

  1. Fenix provides flexibility to track different shipments of the same order through the multi-shipments view.

  2. MultiShipment View API  Response API provides multi-shipments information.

  3. See Full Order link is enabled only if the order contains multiple shipments.

Section 9: Feedback Ratings & Comments

  1. We are capturing Feedback Ratings and Comments provided by shoppers through Feedback API.

  2. We will store this information in the Fenix data warehouse.

Section 10: Delivery Status updates subscription

  1. We are capturing subscription notifications through the Delivery Status Subscription API.

  2. Currently, Fenix supports two channels for sending delivery status notifications to subscribers:

    1. Email 

    2. SMS

Section 11: Headers & Footers

  1. Fenix UI team will integrate the Headers & Footers that you provide.

Track Status API Details:

  • Section 1, Section 2, Section 3, and Section 4 can be updated by using Track Status API Response.

Resource Name

getTrackHistory

Resource URL

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

Method

GET

Params (query/path)

PathVariable:

Identifier-name

RequestParam:

tracking_number

order_number

notification_id

Headers

Request Payload

Response Payload

{

    "fenixShipping": true, 

    "tracking_number": "1Z1WF7240340744243", 

    "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.dermalogica.com/pages/contact-us\">ecomcustomerservice@dermalogica.com</a> with any questions you have about your order.", 

    "display_emoji": false, 

    "emoji_on": null, 

    "edd_info": {

        "delivery_date": "Tuesday, August 30 2022", 

        "promised_date": "Wednesday, August 31 2022", 

        "delivery_message": "Your order has delivered early.", 

        "expected_shipment_date": "Monday, August 29 2022", 

        "split_delivery_date": {

            "day": "Tuesday", 

            "month": "August", 

            "date": "30", 

            "year": "2022"

        }, 

        "header_name": "Delivery Date"

    }, 

    "display_order_info": true, 

    "order_info": {

        "number": "S762725", 

        "placed_dtm": "2022-08-27T02:14:39-05:00", 

        "formatted_dttm": "Saturday, August 27 2022"

    }, 

    "concise_infos": [

        {

            "description": "SHIPPED", 

            "event_date": "Monday, August 29 2022", 

            "event_code": "SH", 

            "event_message": "Order Confirmed"

        }, 

        {

            "description": "PICKED", 

            "event_date": "Monday, August 29 2022", 

            "event_code": "PU", 

            "event_message": "Left Warehouse"

        }, 

        {

            "description": "Your items are out for delivery, you will get them soon..", 

            "event_date": "Tuesday, August 30 2022", 

            "event_code": "OFD", 

            "event_message": "Out for delivery"

        }, 

        {

            "description": "DELIVERED", 

            "event_date": "Tuesday, August 30 2022", 

            "event_code": "DL", 

            "event_message": "Delivered"

        }

    ], 

    "shipment_activities": [

        {

            "day": "Aug 29, 2022", 

            "time": "03:01 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": "Aug 29, 2022", 

            "time": "06:26 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": "KY", 

                "province_code": "KY", 

                "city": "Louisville", 

                "zip_code": null, 

                "latitude": null, 

                "longitude": null

            }, 

            "event_code": "OR", 

            "fenix_code": null

        }, 

        {

            "day": "Aug 30, 2022", 

            "time": "09:19 AM", 

            "desc": "Out For Delivery Today", 

            "address": {

                "first_name": null, 

                "last_name": null, 

                "name": null, 

                "company": null, 

                "address1": null, 

                "address2": null, 

                "country": "US", 

                "country_code": "US", 

                "province": "KY", 

                "province_code": "KY", 

                "city": "Lexington", 

                "zip_code": null, 

                "latitude": null, 

                "longitude": null

            }, 

            "event_code": "OT", 

            "fenix_code": null

        }, 

        {

            "day": "Aug 30, 2022", 

            "time": "01:40 PM", 

            "desc": "Delivered", 

            "address": {

                "first_name": null, 

                "last_name": null, 

                "name": null, 

                "company": null, 

                "address1": null, 

                "address2": null, 

                "country": "US", 

                "country_code": "US", 

                "province": "KY", 

                "province_code": "KY", 

                "city": "VERSAILLES", 

                "zip_code": "40383", 

                "latitude": null, 

                "longitude": null

            }, 

            "event_code": "FS", 

            "fenix_code": "DL"

        }

    ], 

    "recent_shipment_info": {

        "day": "Aug 30, 2022", 

        "time": "01:40 PM", 

        "desc": "Delivered", 

        "address": {

            "first_name": null, 

            "last_name": null, 

            "name": null, 

            "company": null, 

            "address1": null, 

            "address2": null, 

            "country": "US", 

            "country_code": "US", 

            "province": "KY", 

            "province_code": "KY", 

            "city": "VERSAILLES", 

            "zip_code": "40383", 

            "latitude": null, 

            "longitude": null

        }, 

        "event_code": "FS", 

        "fenix_code": "DL"

    }, 

    "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": "111052", 

            "quantity": 1, 

            "name": "precleanse - travel - gift - 1.0 oz", 

            "title": "precleanse - travel - gift", 

            "variantId": "36070247268504", 

            "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/precleanse_1.7oz_537465b6-7ca6-4ce7-81ce-7388e47f31ee.jpg?v=1647641998", 

            "product_id": "5710539489432", 

            "routing_url": "https://d4u6kiswpriuyqk2-42076831896.shopifypreview.com/products_preview?preview_key=56933d9d163b97fb748b31a574707e83"

        }

    ], 

    "display_lineitems": true, 

    "item_count": {

        "total_ordered": 2, 

        "total_filled": 1, 

        "current_packaged": 1

    }, 

    "remaning_days_to_delivery_info": "Your Order Delivered", 

    "display_recommended_products": true

}

   

Response Status

200 - Success

400 – Failure

401 - Un-Authentication 

RecommendedProducts API Details

  • Using RecommendedProducts API, Section 7 will be updated.

Resource Name

getRecommendations

Resource URL

/api/v3/{identifier-name}/recommended_products?tracking_number=1234

Method

GET

Params (query/path)

PathVariable:

Identifier-name

RequestParam:

tracking_number

order_number

Headers

Request Payload

Response Payload

    [

    {

        "id": 5710541553816, 

        "imageUrl": "//cdn.shopify.com/s/files/1/0420/7683/1896/products/Multi-Active-Toner_8.4oz.jpg?v=1620852997", 

        "productName": "multi-active toner", 

        "productUrl": "http://dermalogica-us.myshopify.com/products/multi-active-toner?pr_prod_strat=collection_fallback&pr_rec_id=e74725625&pr_rec_pid=5710541553816&pr_ref_pid=5710539489432&pr_seq=uniform ", 

        "title": "multi-active toner", 

        "price": "$12.00 - $39.00", 

        "vendor": "dermalogica", 

        "type": "toners", 

        "variants": [

            {

                "id": 36070252773528, 

                "title": "1.7 oz", 

                "sku": "110615"

            }, 

            {

                "id": 36070252740760, 

                "title": "8.4 oz", 

                "sku": "110616"

            }

        ]

    }, 

    {

        "id": 5710541914264, 

        "imageUrl": "//cdn.shopify.com/s/files/1/0420/7683/1896/products/Multivitamin-Power-Recovery-Masque_2.5oz.jpg?v=1620852708", 

        "productName": "multivitamin power recovery mask", 

        "productUrl": "http://dermalogica-us.myshopify.com/products/multivitamin-power-recovery-masque?pr_prod_strat=collection_fallback&pr_rec_id=e74725625&pr_rec_pid=5710541914264&pr_ref_pid=5710539489432&pr_seq=uniform ", 

        "title": "multivitamin power recovery mask", 

        "price": "$15.50 - $62.00", 

        "vendor": "dermalogica", 

        "type": "masques", 

        "variants": [

            {

                "id": 36070253723800, 

                "title": "0.5 oz", 

                "sku": "410716"

            }, 

            {

                "id": 36070253691032, 

                "title": "2.5 oz", 

                "sku": "110716"

            }

        ]

    }, 

    {

        "id": 5710544634008, 

        "imageUrl": "//cdn.shopify.com/s/files/1/0420/7683/1896/products/7fizzmaskwhite-min.jpg?v=1641950134", 

        "productName": "blackhead clearing fizz mask", 

        "productUrl": "http://dermalogica-us.myshopify.com/products/blackhead-clearing-fizz-mask?pr_prod_strat=collection_fallback&pr_rec_id=e74725625&pr_rec_pid=5710544634008&pr_ref_pid=5710539489432&pr_seq=uniform ", 

        "title": "blackhead clearing fizz mask", 

        "price": "$23.00", 

        "vendor": "dermalogica", 

        "type": "masques", 

        "variants": [

            {

                "id": 36070263292056, 

                "title": "1.7 oz", 

                "sku": "111287"

            }

        ]

    }

]

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

Resource Name

getTrackHistory

Resource URL

api/v2/{identifier-name}/track-status?order_number=1234&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

{

    "order_summary": {

        "number": "S762725", 

        "placed_date": "Saturday, August 27 2022", 

        "promised_date": "Wednesday, August 31 2022", 

        "split_delivery_date": {

            "day": "Wednesday", 

            "month": "August", 

            "date": "31", 

            "year": "2022"

        }, 

        "total_item_quantity": 2, 

        "total_filled_item_quantity": 1, 

        "line_items": [

            {

                "sku": "111448", 

                "quantity": 1, 

                "name": "breakout clearing kit Auto renew - each", 

                "title": "breakout clearing kit Auto renew", 

                "variantId": "41159256440984", 

                "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/ecomm-pdp-kit_2048x2048_63e08784-3ed7-4d59-aa21-6a3e127543d8.jpg?v=1660084634", 

                "product_id": "7079600980120", 

                "routing_url": "https://www.dermalogica.com/products/breakout-clearing-kit "

            }, 

            {

                "sku": "111052", 

                "quantity": 1, 

                "name": "precleanse - travel - gift - 1.0 oz", 

                "title": "precleanse - travel - gift", 

                "variantId": "36070247268504", 

                "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/precleanse_1.7oz_537465b6-7ca6-4ce7-81ce-7388e47f31ee.jpg?v=1647641998", 

                "product_id": "5710539489432", 

                "routing_url": "https://d4u6kiswpriuyqk2-42076831896.shopifypreview.com/products_preview?preview_key=4a66c66fc7211ef860150dd0958c2a42"

            }

        ]

    }, 

    "shipment_summaries": [

        {

            "edd_info": {

                "delivery_date": "Tuesday, August 30 2022", 

                "promised_date": "Wednesday, August 31 2022", 

                "delivery_message": "Your order has delivered early.", 

                "expected_shipment_date": "Monday, August 29 2022", 

                "split_delivery_date": {

                    "day": "Tuesday", 

                    "month": "August", 

                    "date": "30", 

                    "year": "2022"

                }, 

                "header_name": "Delivery Date"

            }, 

            "tracking_number": "1Z1WF7240340744243", 

            "carrier_name": "UPS", 

            "event_message": "Delivered", 

            "item_quantity": 1, 

            "line_items": [

                {

                    "sku": "111052", 

                    "quantity": 1, 

                    "name": "precleanse - travel - gift - 1.0 oz", 

                    "title": "precleanse - travel - gift", 

                    "variantId": "36070247268504", 

                    "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/precleanse_1.7oz_537465b6-7ca6-4ce7-81ce-7388e47f31ee.jpg?v=1647641998", 

                    "product_id": "5710539489432", 

                    "routing_url": "https://d4u6kiswpriuyqk2-42076831896.shopifypreview.com/products_preview?preview_key=56933d9d163b97fb748b31a574707e83"

                }

            ]

        }

    ]

}

Response Status

200 - Success

400 – Failure

401 - Un-Authentication 

Feedback API Details

  • Using the Feedback API, Section 9 data will be updated.

Resource Name

createTrackingPageFeedback

Resource URL

api/v1/tracking-page-feedback

Method

POST

Params (query/path)

Headers

Request Payload

{

    "comment": "excellent", 

    "tracking_number": "9400109202043610144714", 

    "rating_value": 5, 

    "identifier_name": "gruntstyle"

}

Response Payload

Response Status

200 - Success

400 – Failure

401 - Un-Authentication 

Delivery Status Subscription API

  • Using Delivery Status Subscription API, Section 10 will be updated.

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

{

    "channel_type": "EMAIL", 

    "channel_hub_id": "30685b53-95c8-4f20-ad9c-b2f0526c7b4b", 

    "tracking_number": "1ZRV6719YW00498440", 

    "track_events": [

        "OUT_FOR_DELIVERY", 

        "DELIVERED", 

        "PICKED_UP_BY_CARRIER", 

        "GENERIC"

    ], 

    "email_id": "abc@gmail.com"

}

Response Payload

{

    "subscription_id": "72cef79c-43c1-45b1-920e-0969cbff737b"

}

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

{

    "channel_type": "SMS", 

    "channel_hub_id": "30685b53-95c8-4f20-ad9c-b2f0526c7b4b", 

    "tracking_number": "1ZRV6719YW00498440", 

    "track_events": [

        "OUT_FOR_DELIVERY", 

        "DELIVERED", 

        "PICKED_UP_BY_CARRIER", 

        "GENERIC"

    ], 

    "phone_number": "98684002210"

}

Response Payload

{

    "subscription_id": "72cef79c-43c1-45b1-920e-0969cbff737b"

}

Response Status

200 - Success

400 – Failure

401 - Un-Authentication 

  • No labels