Report buyer behavior events

Requires read_data_report access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/cdp/track.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

Report buyer behavior events to record buyer actions in the marketing system, such as product browsing, adding items to the cart, placing orders, etc.

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

channel_id string
[]
Marketing channel ID, generated by the CDP system.
[]
Example: 6689609588495885399
eventsobject[]
[]
List of buyer behavior events. Maximum size: 128
attrs map
[]
Event attributes. Refer to the event metadata in the CDP system for values.
[]
Example: [object Object]
event_code string
[]
Event code. Refer to the event metadata in the CDP system for values.
[]
Example: Z_sales_order
event_date long
[]
The time when the event occurred in the marketing system.
[]
Example: 1728957677000
parent_event_id string
[]
Parent event ID, indicating the ID of the event to which this event belongs. The reporter determines the event relationship.
[]
Example: 8725726607153220
user_idobject[]
[]
List of buyer identities. Maximum size: 32
channel_type string
[]
Marketing channel type.
[]
Example: Z_store
type string
[]
Buyer identity type. Maximum length: 128
[]
Example: idCard
value string
[]
Value of buyer identity information.
[]
Example: 324568754
user_traits map
[]
Attributes of the buyer, such as name, age, email, etc. Refer to the buyer attribute metadata in the CDP system for filling in the values.
[]
Example: [object Object]

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

dataobject
[]
Response data.
channel_id string
[]
Marketing channel ID, generated by the CDP system.
[]
Example: 6689609588495885399
eventsobject[]
[]
List of buyer behavior events. Maximum size: 128
attrs map
[]
Event attributes. Refer to the event metadata in the CDP system for values.
[]
Example: [object Object]
errors string
[]
Error information.
[]
Example: The event code doesn't exist
event_code string
[]
Event code. Refer to the event metadata in the CDP system for values.
[]
Example: Z_sales_order
event_date long
[]
The time when the event occurred in the marketing system.
[]
Example: 1728957677000
id string
[]
Event ID, generated by the CDP system.
[]
Example: 8725726607153221
one_id string
[]
A unique ID for a buyer in the CDP system, which is generated by the CDP system.
[]
Example: 0155eb0038b6f96a3b6d5f977ad076fa
parent_event_id string
[]
Parent event ID, indicating the ID of the event to which this event belongs. The reporter determines the event relationship.
[]
Example: 8725726607153220

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Body

Body required

{
  "channel_id": "6689609588495885399",
  "events": [
    {
      "attrs": {},
      "event_code": "Z_sales_order",
      "event_date": 1728957677000,
      "parent_event_id": "8725726607153220",
      "user_id": [
        {
          "channel_type": "Z_store",
          "type": "idCard",
          "value": "324568754"
        }
      ],
      "user_traits": {}
    }
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/cdp/track.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json' \
     --data '
{
  "channel_id": "6689609588495885399",
  "events": [
    {
      "attrs": {},
      "event_code": "Z_sales_order",
      "event_date": 1728957677000,
      "parent_event_id": "8725726607153220",
      "user_id": [
        {
          "channel_type": "Z_store",
          "type": "idCard",
          "value": "324568754"
        }
      ],
      "user_traits": {}
    }
  ]
}
'

Was this article helpful to you?

SHOPLINE

Legal

Error loading component.