订单的客户旅程
/{version}/api/order/event请求
路径参数
versionstring必需v2-4-2请求头
ApiKeystringapi secret key
请求体
application/jsonorder_idstring必需The ID of the order
pageinteger必需page_sizeinteger必需min:1;max:100
请求示例
{
"order_id": "string",
"page": 0,
"page_size": 0
}响应
响应体
application/jsoncodeinteger必需messagestring必需dataobject必需子字段
order_idstring必需totalinteger必需Total amount of events
pageinteger必需page_sizeinteger必需eventsarray [object]必需子字段
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
子字段
creator_idstring必需Influencer id
creator_namestring必需Influencer's name
creator_urlstring必需The trackable url
creator_short_urlstring必需The trackable short URL
creator_origin_urlstring必需landing_page_url
creator_typestring必需The influencer type: Influencer, affiliate, newmedia
creator_costinteger必需The one time cost of this campaign
creator_sourcestring必需删除The campaign source
creator_campaignstring必需The campaign name
creator_platformstring必需The platfrom that influencer places the campaign
adobjectnullableEvent detail of ads
子字段
account_idstring必需The ad account number
account_namestring必需The ad account name
campaign_idstring必需Campaign id
campaign_namestring必需Campaign name
set_idstring必需Ad set id
set_namestring必需Ad set name
ad_idstring必需Ad id
ad_namestring必需Ad name
ad_platformstring必需Ad platform
keywordstring必需The keyword in ad
emailobjectnullableEmail event
子字段
receiver_emailstring必需The contact's email address
email_platformstring必需The Email Service Provider
social_mediaobjectnullableSocial media event
子字段
social_media_platformstring必需The channel name
organic_searchobjectnullableOrganic search event
子字段
organic_search_platformstring必需The channel name
organic_search_querystring必需The query string
productsarray [object]nullableProduct information
子字段
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
子字段
currencystring必需The ISO code of the currency.
total_priceinteger必需The total price in the cart
shop_currency_total_priceinteger必需The total price in the cart in store's currency
total_quantityinteger必需Total quantity
checkout_startedobjectnullableCheckout started event
子字段
other_order_idstring必需The ID of the order.
other_order_nostring必需The integer representation of the order
currencystring必需The ISO code of the currency.
total_priceinteger必需The total price of the order in USD
shop_currency_total_priceinteger必需The total price of the order in store's currency
checkout_completedobjectnullableCheckout completed event
子字段
other_order_idstring必需The ID of the order.
other_order_nostring必需The integer representation of the order
currencystring必需The ISO code of the currency.
total_priceinteger必需The total price of the order in USD
shop_currency_total_priceinteger必需The total price of the order in store's currency
payment_info_submittedobjectnullablePayment info submitted event
子字段
other_order_idstring必需The ID of the order.
other_order_nostring必需The integer representation of the order
currencystring必需The ISO code of the currency.
total_priceinteger必需The total price of the order
shop_currency_total_priceinteger必需The total price of the order in store's currency
search_submittedobjectnullableSearch submitted event
子字段
search_querystringThe search term