Cart and Item Parameters

cart_id

string

Cart ID.

cart_items

number

The number of items in the cart (unique products).

currency

string

The currency in which the price of items in the cart, as well as taxes, discounts and shipping costs are indicated. If the parameter is not specified, the currency will be displayed as "USD" in the report.

value

number

The value of all items in the cart, including taxes, discounts and shipping costs. In other words, this is the amount which the buyer paid for the purchase. Indicated in money.

profit

number

The seller's net profit from selling all items in the cart. Indicated in money. The calculation currency is used in accordance with "currency".

transaction_fee

number

Transaction fee (payment system commission) for the purchase of all items from the cart. Indicated in money. The calculation currency is used in accordance with "currency".

transaction_id

string

The ID of the transaction related to the payment for the items in the cart.

affiliation

string

The store or branch in which the transaction was performed.

detail

string

Details of the purchase error or the reason for the refund. The field can also be used in case of a successful purchase (Checkout Success) to provide any additional details.

tax_value

number

The total tax for all items in the cart in money. The calculation currency is used in accordance with "currency".

tax_name

string

Tax name.

tax_type

string

Tax type.

discount_value

number

The total discount amount for all items in the cart in money. The calculation currency is used in accordance with "currency".

discount_name

string

Discount name.

discount_type

string

Discount type.

shipping_value

number

The total shipping cost of all items in the cart in money. The calculation currency is used in accordance with "currency".

shipping_name

string

Delivery service name.

shipping_type

string

Shipping type.

checkout_step

number

The number of a step the customer is currently at. You number these steps yourself, according to the Checkout Begin, Checkout Progress and Checkout Success events

checkout_option

string

Cart payment option.

buyer

string

Buyer's name or ID. For example, user login in your website. This parameter is used for generating reports on top buyers. Such reports are useful if products by many third-party sellers are featured on your sites.

seller

string

Seller's name or ID. For example, user login in your website. This parameter is used for generating reports on top sellers. Such reports are useful if products by many third-party sellers are featured on your sites.

id *

string

Stock Keeping Unit (SKU).

name *

string

Item name.

brand

string

Item brand.

category

string

Item category. For example, "Clothes" or "Smartphones".

variant

string

Item variant: color, model, etc.

quantity

number

Item quantity.

currency

string

The currency in which the item price, as well as taxes, discounts and shipping costs are indicated. If the parameter is not specified, the currency will be displayed as "USD" in the report.

price

number

Item value.

value

number

Net item value in money, including taxes, discount and shipping costs: price + tax_value + shipping_value + transaction_fee - discount_value. In other words, this is the amount which the buyer paid for the item. Indicated in money.

profit

number

The seller's net profit from selling the item. Indicated in money. The calculation currency is used in accordance with "currency".

transaction_fee

number

Transaction fee for the purchase of the item. Indicated in money. The calculation currency is used in accordance with "currency".

list_name

string

The name of the list in which the item was presented to the user. For example, Price List.

list_position

number

The position of the item in the list specified in list_name.

tax_value

number

The item tax in money. The calculation currency is used in accordance with "currency".

tax_name

string

Tax name.

tax_type

string

Tax type.

discount_value

number

The discount for the item in money. The calculation currency is used in accordance with "currency".

discount_name

string

Discount name.

discount_type

string

Discount type.

shipping_value

number

The item shipping cost in money. The calculation currency is used in accordance with "currency".

shipping_name

string

Delivery service name.

shipping_type

string

Shipping type.