Post
/customers/{customerId}/users/{userId}/product-add
Security
API Key
Header parameter nameaccess_token
Access token Authentication
Path parameters
customerId
stringRequired
userId
stringRequired
Body parameters
object
Example{
"rec": "1",
"idsite": "1234",
"url": "https://example.com",
"urlref": "https://example.com",
"locale": "en_US",
"uid": "{\"customer_id\":\"customer_id\",\"user_type\":\"return_user\",\"testing_group_name\":\"Inactive\",\"session_id\":\"524e0542-5713-4755-a8c0-1430cbd58aa9\"}",
"action_name": "product_add",
"action_detail": "product_add",
"action_type": "ecomm",
"ec_items": "[[\"1234\",\"Product Name\",\"{\"currency_code\":\"usd\"}\",1000,1]]"
}
rec
string
Default parameter to send with event payload
Example1
idsite
string
The tracking_id of the site
Example1234
url
string
The URL of the page
Examplehttps://example.com
urlref
string
The referrer URL
Examplehttps://example.com
locale
string
The locale of the user
Exampleen_US
uid
string
A string representation of the user object
Example{"customer_id":"customer_id","user_type":"return_user","testing_group_name":"Inactive","session_id":"524e0542-5713-4755-a8c0-1430cbd58aa9"}
action_name
string
The name of the action that was performed.
Examplecontent_tracking
action_detail
string
Details on the action that was performed.
Examplesearch_result
action_type
string
The meta action that was performed.
Examplesearch_service
ec_items
string
A string representation of a JSON array containing information about the products. Index 0 is the product's sku, index 1 is the product's name, index 2 is the product's currency, index 3 is the product's price, and index 4 is the product's quantity.
Example[["1234","Product Name","{"currency_code":"usd"}",1000,1]]
context
object
A JSON object of context data. Used to pass dynamic, additional data to the tracker.
Example{
"key1": "value1",
"key2": 1000,
"nested": {
"key": "value"
},
"array": [
"1",
"2",
"3"
]
}
Responses
200
Successful response
400
Bad request
401
Unauthorized
403
Forbidden
500
Internal server error