Skip to main content
Raw Markdown

Order First & Last Touchpoint of an order

POST/{version}/api/order/attribution-touch

Request

Path Params

versionstringrequired
examplev2-4-2

Header Params

ApiKeystring

api secret key

Body Params

application/json
order_idsarray [string]required

The IDs of the order, which Up to 20 orders can be retrieved at a time

Child fields
string
Examples
JSON
{
  "order_ids": [
    "string"
  ]
}

Responses

Body

application/json
codeintegerrequired

1:success; other:failed

messagestringrequired
dataarray [object]requirednullable
Child fields
order_idstring
first_touchpointobjectnullable

First touchpoint(non-direct) of this order

Child fields
campaignstringrequired

The campaign name

channelstringrequired

The channel name, available channel is: direct, referral, creator, ad, email, social media, organic search

sourcestringrequired

The traffic source

mediumstringrequired

The traffic medium

timestringrequired

Time stamp, the timezone follows your store setting

last_touchpointobjectnullable

Last touchpoint(non-direct) of this order

Child fields
campaignstringrequired

The campaign name

channelstringrequired

The channel name, available channel is: direct, referral, creator, ad, email, social media, organic search

sourcestringrequired

The traffic source

mediumstringrequired

The traffic medium

timestringrequired

Time stamp, the timezone follows your store setting

Response Headers