Attribute

Description

sessionTrackId

mandatory

"sessionTrackId":"123123-2323-1231-23123"

• Unique session track id generated on per session basis on client side

orderId

"orderId": "123123123"

• Order Id generated by the retailer system

cartId

"cartId": "123123123"

• A Cart Id generated by the retailer system

buyerZipCode

mandatory

"buyerZipCode" : "95129"

• The zip of the item's buyer.

pageType

mandatory

"pageType": "cop"

• Rules are tied to page type value.

E.g., Show fastest EDD on PDP and show all EDD options on COP.

PDP - Product Detail Page

CART - CART page/shopping Bag page

COP - Check out Page

MC - Mini Cart

CA - Cart Abandonment

OC - Order Confirmation

SC - Shipping Confirmation

Send Values as part of a delivery estimate request

moneytoryValue

mandatory

"monetaryValue": 50.0

• Item price in PDP or the total cart in cart or total checkout value at checkout

responseFormat

mandatory

"responseFormat" : "json"

• The attribute provides the desired delivery estimate response format. Allowed formats are “Json” and “binary.” The default response format is JSON.

additionalProcessing

"additionalProcessing": true

• True if a particular item required additional processing time than normal SKU

customerTags

"customerTags": [

"USA",

"Dealer"

]

• This is applicable for only Shopify retailers to send Customer specific tags

shippingInfo

"shippingInfo": {

            "carrier": "string",

            "service": {

                        "name": "string"

                        "method": "string",

            },

            "shippingDate": "string",

            "trackId": "Z12372y312923182u3821"

}

In case of subscriptions/recurring orders in your business, if you want to provide EDD after pick-pack-ship

• carrier : The carrier name

• name : The service name of the carrier

• method : The shipping service method name

• shippingDate: The expected/planned ship date of any order

• trackId: The tracking number generated as part of label creation

skus

mandatory

"skus": [{

            "sku": "SKU-001",

            "category": "Mens|topwear",

            "digitalProduct": false,

            "itemType": "FREE",

            "leadTime": 0 ,

            "nonShip": false,

            "productName": "Red T-shirt",

            "quantity": 1,

            "dimensions": {

                        "girth": 3,

                        "height": 3,

                        "length": 3,

                        "width": 0,

                        "thickness": 6,

                        "units": "CM/IN"

            },

            "skuInventories": [{

                        "locationId": "Dc-01",

                        "quantity": 1

            }],

            "weight": {

                        "units": "LB",

                        "value": 0

            }

}]

• sku: The item's SKU (stock keeping unit).

• category: The item category name

• digitalProduct: The item is digital/downloadable item

• itemType: The type of the item e.g. FREE,GIFT,E-GIFT, Bundled etc

• leadTime: The time required to prepare the item to ship

• nonship: The item is not eligible for shipping to buyer

• productName: The name of the product

• quantity: The number of items that were chosen to buy.

• dimensions:  The dimensions and weight of the item along with unit of measurement. Required only when there is no product & inventory sync integration with Fenix Commerce

• skuInventories: Inventory location and quantity details of SKU

• locationId : The physical location (DC/Store ID) of the item. Required only when there is no product & inventory sync integration with Fenix Commerce

• quantity :The total quantity

• weight: The total weight of the item

buyerAddress

"buyerAddress": {

            "name": "Sharath Chandra",

            "address1": "5437",

            "address2": "castle",

            "city": " San Jose ",

            "state": "CA",

            "country": "USA",

            "zipcode": "95129",

            "dealerAddress": true,

            "details": {

                        "dealer": true,

                        "dealerId": "SFO-SJ-D001",

                        "apoFpoAddress": true,

                        "poAddress": true

            }

}

• name: Full name of the buyer

• address1: The street address of the buyer address.

• address2: An optional additional field for the street address of the buyer address.

• city: The city, town, or village of the buyer address

• state: The state of the buyer address

• country: The country code of the buyer address

• zipcode: The postal code (zip, postcode, Eircode, …) of the buyer address.

• dealerAddress: If true, In case if you’re shipping to your dealer address then the address will dealer address of the buyer address.

• dealer: the buyer is a dealer

• dealerId: The dealer unique ID

• poAddress: The address is pobox address of the buyer address.

• apoFpoAddress: The zipcode falls in apo/fpo zipcode List of the buyer address.