Page Comparison

...

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

Code Block

{

language

Image Removed

json

{
    "order_summary":

{

Image Removed

 {
        "number": "AAA",

 
        "placed_date": "Wednesday, September 07 2022",

 
        "promised_date": "Monday, September 12 2022",

 
        "split_delivery_date":

{

Image Removed

"day": "Monday",

 {
            "day": "Monday", 
            "month": "September",

 
            "date": "12",

 
            "year": "2022"

},


        }, 
        "total_item_quantity": 3,

 
        "total_filled_item_quantity": 2,

 
        "line_items":

[

Image Removed

{

Image Removed

 [
            {
                "sku": "456",

 
                "quantity":

1,

"name": "double cleanse full size kit - each",

 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"

},

{

Image Removed

"sku": "123",

"quantity": 1,

"name": "special cleansing gel - travel - 1.7 oz",

"title": "special cleansing gel - travel",

"variantId": "11123",


            }, 
            {
                "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"

},

{

Image Removed


            }, 
            {
                "sku": "232",

 
                "quantity":

1,

 1, 
                "name": "daily microfoliant exfoliator - 2.6 oz",

 
                "title": "daily microfoliant exfoliator",

 
                "variantId": "126",

 
                "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/daily-microfoliant_main-with-benefits.jpg?v=166",

 
                "product_id": "5710551548056",

 
                "routing_url": "https://www.store-us.com/products/daily-microfoliant"

}

]

},


            }
        ]
    }, 
    "shipment_summaries":

[

Image Removed

{

Image Removed

"edd_info": {

Image Removed

 [
        {
            "edd_info": {
                "delivery_date": "Friday, September 09 2022",

 
                "promised_date": "Monday, September 12 2022",

 
                "delivery_message": "Yay, it\"s early...",

"expected

 
                "expected_shipment_date": "Wednesday, September 07 2022",

 
                "split_delivery_date":

{

Image Removed

 {
                    "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":

[

Image Removed

{

Image Removed

 [
                {
                    "sku":

"123",

 "123", 
                    "quantity":

1,

 1, 
                    "name": "special cleansing gel - travel - 1.7 oz",

"title": "special cleansing gel - travel",

 
                    "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"

},

{

Image Removed

"sku": "232",

"quantity": 1,

"name": "daily microfoliant exfoliator - 2.6 oz",

"title": "daily microfoliant exfoliator",

"variantId": "126",


                }, 
                {
                    "sku": "232", 
                    "quantity": 1, 
                    "name": "daily microfoliant exfoliator - 2.6 oz", 
                    "title": "daily microfoliant exfoliator", 
                    "variantId": "126", 
                    "image_url": "https://cdn.shopify.com/s/files/1/0420/7683/1896/products/daily-microfoliant_main-with-benefits.jpg?v=166",

 
                    "product_id":

"5710551548056",

 "5710551548056", 
                    "routing_url": "https://www.store-us.com/products/daily-microfoliant"

}

]

}

]

Response Status

200 - Success

400 – Failure

401 - Un-Authentication

...

Resource Name

createTrackingPageFeedback

Resource URL

api/v1/tracking-page-feedback

Method

POST

Params (query/path)

Headers

Request Payload

Code Block

{

language

Image Removed

json

{
    "comment": "excellent",

 
    "tracking_number": "123",

 
    "rating_value": 5,

 
    "identifier_name": "storename"

Response Payload

Response Status

200 - Success

400 – Failure

401 - Un-Authentication

...

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

Code Block

{

language

Image Removed

json

{
    "channel_type": "EMAIL",

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

 
    "tracking_number": "123",

 
    "track_events":

[

Image Removed

 [
        "OUT_FOR_DELIVERY",

"DELIVERED",

 
        "DELIVERED", 
        "PICKED_UP_BY_CARRIER",

 
        "GENERIC"

],


    ], 
    "email_id": "abc@gmail.com"

Response Payload

{

Code Block

language

Image Removed

json

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

Response Status

200 - Success

400 – Failure

401 - Un-Authentication

...

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

Code Block

{

language

Image Removed

json

{
    "channel_type": "SMS",

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

 
    "tracking_number": "123",

 
    "track_events":

[

Image Removed

 [
        "OUT_FOR_DELIVERY",

 
        "DELIVERED",

 
        "PICKED_UP_BY_CARRIER",

 
        "GENERIC"

],


    ], 
    "phone_number": "98684002210"

Response Payload

Code Block

{

language

Image Removed

json

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

Response Status

200 - Success

400 – Failure

401 - Un-Authentication

...

Versions Compared

Old Version 19

New Version 20

Key