content_type

The content_type object property's value must be set to either "product", or "product_group." If you use sku_id as content_id, use "product", if you use item_group_id as content_id, use "product_group".

This field is required for VSA.

Must be either 'product' or 'product_group'

{ "content_type" : "product" }

✅

contents

A list of content objects that represent relevant products in a web event with product information.

Must be an array of objects

{ contents: [ { content_id: '301', content_name: 'dress', quantity: 1, price: 8, }, { content_id: '401', content_name: 'dress', quantity: 1, price: 1.2, }], content_type:'product', value: 9.2, currency: 'USD'}

✅

✅

content_id

Unique ID of the product or content. Recommend using sku id or item_group_id, this should match the sku_id or item_group_id you set up in the catalog (if available)

This field is required for VSA

string

{

"content_id" : "401"

}

✅

price

The price of the item.

Note: Price is the price for a single item, and value is the total price of the order. For example, if you have two items each sold for $10, the price parameter would pass 10 and the value parameter would pass 20.

number

{

"price" : 25

}

✅

quantity

The number of the item.

number

{

"quantity" : 4

}

✅

content_name

Name of the page/product.

string

{

"content_name" : "shirt"

}

content_category

Category of the page/product.

string

{

"content_category" : "apparel"

}

currency

ISO 4217 code. Examples: "EUR", "USD", "JPY"

List of currencies currently supported:

AED, ARS, AUD, BDT, BHD, BIF, BOB, BRL, CAD, CHF, CLP, CNY, COP, CRC, CZK, DKK, DZD, EGP, EUR, GBP, GTQ, HKD, HNL, HUF, IDR, ILS, INR, ISK, JPY, KES, KHR, KRW, KWD, KZT, MAD, MOP, MXN, MYR, NGN, NIO, NOK, NZD, OMR, PEN, PHP, PHP, PKR, PLN, PYG, QAR, RON, RUB, SAR, SEK, SGD, THB, TRY, TWD, UAH, USD, VES, VND, ZAR

enum(string)

{ "currency" : "USD" }

✅

value

Value of the order or items sold.

Note: Price is the price for a single item, and value is the total price of the order. For example, if you have two items each sold for ten dollars, the price parameter would pass 10.00 and the value parameter would pass 20.00.

Values should always be formatted as an integer or decimal (ex: 10.00) regardless of the location, currency, etc. It cannot contain any currency signs, special characters, letters, or commas.

number

{ "value" : 10.00100}

✅

✅

query

The text string that was input by a user. For instance, if a person searches for a product on your website, you can forward the keyword being searched. If a person enters a coupon code at check out, you can forward the code.

string

{ "query" : "SAVE10COUPON" }

description

Description of the item or page.

string

{ "description" : "Lightweight cotton" }

status

Status of an order, item, or service.

Note: Depending on your use of 'status', Events API may be required in order to share status changes to TikTok.

string

{ "status" : "submitted" }