Customer journey of an order
/{version}/api/order/eventRequest
Path Params
versionstringrequiredv2-4-2Header Params
ApiKeystringapi secret key
Body Params
application/jsonorder_idstringrequiredThe ID of the order
pageintegerrequiredpage_sizeintegerrequiredmin:1;max:100
Examples
{
"order_id": "string",
"page": 0,
"page_size": 0
}Responses
Body
application/jsoncodeintegerrequiredmessagestringrequireddataobjectrequiredChild fields
order_idstringrequiredtotalintegerrequiredTotal amount of events
pageintegerrequiredpage_sizeintegerrequiredeventsarray [object]requiredChild fields
event_idstringevent_atstringTime stamp in YYYYMMDD HH:ii:ss
event_page_urlstringThe page URL
event_page_titlestringThe page title
event_page_referrerstringRefferral address from last hop
event_page_ipstringVisitor's IP address
event_page_user_agentstringVisitor's user agent
event_campaignstringThe event campaign name
event_sourcestringThe traffic source of this event
event_mediumstringThe medium of this event
event_typestringEvent type: ads, Email, social media, organic search, referral, influencer, direct
creatorobjectnullableThe influencer event detail
Child fields
creator_idstringrequiredInfluencer id
creator_namestringrequiredInfluencer's name
creator_urlstringrequiredThe trackable url
creator_short_urlstringrequiredThe trackable short URL
creator_origin_urlstringrequiredlanding_page_url
creator_typestringrequiredThe influencer type: Influencer, affiliate, newmedia
creator_costintegerrequiredThe one time cost of this campaign
creator_sourcestringrequired删除The campaign source
creator_campaignstringrequiredThe campaign name
creator_platformstringrequiredThe platfrom that influencer places the campaign
adobjectnullableEvent detail of ads
Child fields
account_idstringrequiredThe ad account number
account_namestringrequiredThe ad account name
campaign_idstringrequiredCampaign id
campaign_namestringrequiredCampaign name
set_idstringrequiredAd set id
set_namestringrequiredAd set name
ad_idstringrequiredAd id
ad_namestringrequiredAd name
ad_platformstringrequiredAd platform
keywordstringrequiredThe keyword in ad
emailobjectnullableEmail event
Child fields
receiver_emailstringrequiredThe contact's email address
email_platformstringrequiredThe Email Service Provider
social_mediaobjectnullableSocial media event
Child fields
social_media_platformstringrequiredThe channel name
organic_searchobjectnullableOrganic search event
Child fields
organic_search_platformstringrequiredThe channel name
organic_search_querystringrequiredThe query string
productsarray [object]nullableProduct information
Child fields
other_product_idstringProduct id
other_variant_idstringProduct variant
product_namestringProduct name
variant_namestringVariant name
final_namestringFinal name
currencystringThe ISO code of the currency.
priceintegerThe price
shop_currency_priceintegerThe price in store's currency
quantityintegerProduct quantity
cart_viewedobjectnullableCart viewed event
Child fields
currencystringrequiredThe ISO code of the currency.
total_priceintegerrequiredThe total price in the cart
shop_currency_total_priceintegerrequiredThe total price in the cart in store's currency
total_quantityintegerrequiredTotal quantity
checkout_startedobjectnullableCheckout started event
Child fields
other_order_idstringrequiredThe ID of the order.
other_order_nostringrequiredThe integer representation of the order
currencystringrequiredThe ISO code of the currency.
total_priceintegerrequiredThe total price of the order in USD
shop_currency_total_priceintegerrequiredThe total price of the order in store's currency
checkout_completedobjectnullableCheckout completed event
Child fields
other_order_idstringrequiredThe ID of the order.
other_order_nostringrequiredThe integer representation of the order
currencystringrequiredThe ISO code of the currency.
total_priceintegerrequiredThe total price of the order in USD
shop_currency_total_priceintegerrequiredThe total price of the order in store's currency
payment_info_submittedobjectnullablePayment info submitted event
Child fields
other_order_idstringrequiredThe ID of the order.
other_order_nostringrequiredThe integer representation of the order
currencystringrequiredThe ISO code of the currency.
total_priceintegerrequiredThe total price of the order
shop_currency_total_priceintegerrequiredThe total price of the order in store's currency
search_submittedobjectnullableSearch submitted event
Child fields
search_querystringThe search term