COMMERCE schema reference

This is for:

In this article

Commerce schema

This article lists the views available for inspecting Coveo commerce-related data within Snowflake and provides users with information stored in each view, enabling them to generate meaningful reports tailored to their specific needs.

Commerce schema

The COMMERCE schema has three views, which contain metrics specific to Coveo for Commerce implementations.

The available public views are the following:

CARTS
CART_ITEMS
TRANSACTIONS

CARTS

The CARTS view contains information about all different carts (baskets) on which products were added.

This view provides information such as a cart’s total value and currency codes.

`BASE_CURRENCY`

The global ISO currency code used (defaults to USD).

This value is used to enable sorting across different currencies.

`BASE_EXCHANGE_RATE`

The exchange rate used between the cart’s currency and the BASE_CURRENCY at the time the event occurred.

`BASE_TOTAL`

The TOTAL value of the cart, expressed in the BASE_CURRENCY.

`CART_ID`

The unique identifier of each cart. Used as a primary key.

If a purchase occurred, then the CART_ID will appear in the TRANSACTIONS view as well. We currently only track transacted carts.

Note

This value is automatically generated by Coveo to uniquely identify each cart in the Snowflake database, and is always of the string data type.

`CURRENCY`

The currency used for the price of the products in the cart at the time of the cart event (for example, USD). This will typically be your home currency, or it may vary if you support multiple currencies.

`ORGANIZATION_ID`

The Coveo organization's unique identifier for this record.

`TOTAL`

The total value of the cart (the sum of the products' prices multiplied by the quantity), in the cart currency.

`USER_ID`

The unique identifier of the logged-in user. This foreign key references the USERS view where all the users are stored.

The value can be NULL if the user is anonymous.

For more information on Snowflake’s supported constraint types, such as primary and foreign keys, see Overview of Constraints.

CART_ITEMS

The CART_ITEMS view contains information about the items contained in each cart to which products were added and purchased.

Each item has information about the Coveo service for which the action of adding the item to the cart was attributed (that is, search, listing, or recommendation).

For more information about the attribution process, see Attribution at Coveo.

`ADD_EVENT_DATE`

The date of the purchase event.

`ADD_EVENT_ID`

The unique identifier of the purchase event. This foreign key references the EVENTS view, establishing a one-to-one relationship.

The value can’t be NULL.

`ADD_EVENT_TIMESTAMP`

The timestamp of the purchase event, in UTC.

`BASE_CURRENCY`

The global ISO currency code used (defaults to USD).

`BASE_EXCHANGE_RATE`

The exchange rate used between the cart item’s currency and the BASE_CURRENCY at the time the event occurred.

`BASE_PRICE`

The price of the item converted to the global currency (that is, the BASE_CURRENCY).

`BASE_SHIPPING` (deprecated)

The shipping cost associated with the item, expressed in the BASE_CURRENCY. This column is deprecated and value will always be 0.

`CART_ID`

The unique identifier of the cart. This foreign key references the CARTS view, establishing a many-to-one relationship.

Note

This value is automatically generated by Coveo to uniquely identify each cart in the Snowflake database, and is always of the string data type.

`CART_ITEM_ID`

The unique identifier of the item in the cart. Used as a primary key.

`CURRENCY`

The currency used for the price of the products in the cart (for example, USD) at the time of the cart event. This will typically be your home currency, or it may vary if you support multiple currencies.

`INSIGHT_ID`

The unique identifier of the insight from which the item was added to the transacted cart. This foreign key references the INSIGHTS view, establishing a many-to-one relationship.

The value is NULL if the item couldn’t be attributed to any Coveo service.

For more information about the attribution process, see Attribution at Coveo.

`ITEM_ID`

The unique identifier of the item being placed in a transacted cart. This foreign key references the ITEMS view where all the items are stored.

The value can’t be NULL.

Note

This value is automatically generated by Coveo to uniquely identify each item in the Snowflake database, and is always of the string data type.

`ORGANIZATION_ID`

The Coveo organization's unique identifier for this record.

`PRICE`

The price of the item.

`QUANTITY`

The quantity of each product added to the cart.

`SHIPPING` (deprecated)

The shipping cost associated with each product in the cart. This column is deprecated and value will always be 0.

TRANSACTIONS

The TRANSACTIONS view contains all purchase event information, such as the total amount, taxes, shipping costs, and associated CART_ID.

`BASE_CART_TOTAL`

The CART_TOTAL value for this transaction, expressed in the BASE_CURRENCY.

`BASE_CURRENCY`

The global ISO currency code used for the transaction (defaults to USD).

`BASE_EXCHANGE_RATE`

The exchange rate used between the transaction’s currency and the BASE_CURRENCY at the time the transaction occurred.

`BASE_SHIPPING`

The SHIPPING value for this transaction, expressed in the BASE_CURRENCY.

`BASE_TAX`

The TAX value for this transaction, expressed in the BASE_CURRENCY.

`BASE_TOTAL`

The TOTAL value for this transaction, expressed in the BASE_CURRENCY.

`CART_ID`

The unique identifier of the cart. This foreign key references the CARTS view, establishing a one-to-one relationship.

For more information on Snowflake’s supported constraint types, such as primary and foreign keys, see Overview of Constraints.

`CART_TOTAL`

For this transaction, the total of product revenue in the cart, expressed in the transaction’s CURRENCY.

`CURRENCY`

`DISCOUNT_CODE`

Placeholder.

The value will always be NULL.

`ORGANIZATION_ID`

The Coveo organization's unique identifier for this record.

`PAYMENT_TYPE`

Placeholder.

The value will always be NULL.

`SHIPPING`

Total shipping cost for this transaction, expressed in the transaction’s CURRENCY.

`SHIPPING_METHOD`

Placeholder.

The value will always be NULL.

`TAX`

Total amount of tax for this transaction, expressed in the transaction’s CURRENCY.

`TOTAL`

Gross total revenue of the transaction (including TAX and SHIPPING) minus any discounts, expressed in the transaction’s CURRENCY.

`TRANSACTION_DATE`

The date of the purchase event.

`TRANSACTION_EVENT_ID`

The unique identifier of the transaction event. This foreign key references the EVENTS view, establishing a one-to-one relationship.

The value can’t be NULL.

`TRANSACTION_ID`

The unique identifier of each purchase event. Used as a primary key.

This can be used to calculate the total number of purchase events.

Note

This value is automatically generated by Coveo to uniquely identify each transaction in the Snowflake database, and is always of the string data type.

After a successful transaction, if a visitor revisits the transaction confirmation page after 30 days, a second purchase event with the same transaction id will be sent.

However, if the visitor revisits the transaction confirmation page within 30 days, the purchase event is deduplicated, meaning that the transaction won’t be counted twice.

`TRANSACTION_TIMESTAMP`

The date and time at which the purchase event occurred, in UTC.

`TRANSACTION_XID`

The external identifier for each transaction.

The value is equal to the received transactionId.

`VISIT_ID`

The unique identifier of the visit in which the transaction occurred.

This foreign key references the VISITS view, establishing a many-to-one relationship.

The value can’t be NULL.

For more information on Snowflake’s supported constraint types, such as primary and foreign keys, see Overview of Constraints.

Was this article useful?

Very useful

Not really