Track a purchase order event. This event is used to track when a user makes a purchase order

  • Published on Dec 18, 2024
  • 1 minute(s) read
Prev Next
Post
/customers/{customerId}/users/{userId}/purchase-order
Security
API Key
Header parameter nameaccess_token

Access token Authentication

Path parameters
customerId
stringRequired
userId
stringRequired
Body parameters
Expand All
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": "purchase_order", "action_detail": "purchase_order", "action_type": "ecomm", "revenue": 1000, "ec_id": "1234", "ec_items": "[[\"1234\",\"Product Name\",\"{\"currency_code\":\"usd\"}\",1000,1]]", "ec_st": 1000, "ec_tx": 100, "ec_dt": "25", "idgoal": "1", "version": "2" }
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
revenue
number

The revenue. Should be sent with purchase events.

Example1000
ec_id
string

The Order ID. Should be sent with purchase events.

Example1234
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]]
ec_st
number

The total revenue

Example1000
ec_tx
number

The total tax

Example1000
ec_dt
string

The total discount

Example100
idgoal
string

The goal ID

Example0
version
string

The version of the event

Example2
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