Fields Reference · VTEX
VTEX Fields List
36 fields · 22 dimensions · 14 metrics · 4 groups
| Field name | Label | Category | Description |
|---|---|---|---|
discounts_value | Discounts | amounts | Discounts (totals.Discounts). VTEX reports it as a negative amount. |
items_value | Items Value | amounts | Items subtotal (totals.Items). |
line_list_value | Line List Value | amounts | listPrice x quantity: the line at list price, before discounts. |
line_revenue | Line Revenue | amounts | sellingPrice x quantity: what the line sold for, after item-level discounts. |
order_value | Order Value | amounts | Order total (value), items + shipping + tax + discounts. |
shipping_value | Shipping | amounts | Shipping (totals.Shipping). |
tax_value | Tax | amounts | Tax (totals.Tax); 0 when the order has none. |
available_quantity | Stock Available | inventory | totalQuantity – reservedQuantity. A SKU is out of stock where this is 0 and stock is not unlimited. |
reserved_quantity | Stock Reserved | inventory | reservedQuantity: held by orders not yet shipped. |
total_quantity | Stock On Hand | inventory | totalQuantity in the warehouse. |
unlimited_stock | Unlimited Stock | inventory | True when VTEX marks the SKU as having unlimited quantity in this warehouse; quantities are then not meaningful. |
warehouse_id | Warehouse ID | inventory | VTEX warehouse id. |
warehouse_name | Warehouse | inventory | Warehouse name. |
creation_date | Order Date | order | Day the order was created, in the store's time zone, taken from the time zone each of its sales channels declares. VTEX itself stores UTC. |
currency_code | Currency | order | Currency of every amount on the row (e.g. COP). |
has_return_invoice | Has Return Invoice | order | True when the order has an input (return) invoice. Stores that do not register returns in VTEX show few or none. |
line_unique_id | Line ID | order | VTEX line id (uniqueId), unique within the order. |
order_id | Order ID | order | VTEX order id (orderId). |
order_status | Order Status | order | VTEX order status, e.g. invoiced, canceled, handling, ready-for-handling. |
orders | Orders | order | Number of orders. Average order value is order_value / orders. |
origin | Origin | order | Marketplace or Fulfillment, as VTEX reports it. |
payment_names | Payment Methods | order | Payment method names, comma-separated. |
sales_channel_id | Sales Channel ID | order | VTEX sales channel (trade policy) id. |
sales_channel_name | Sales Channel | order | Name of the sales channel, from the account's sales channel list. |
seller_name | Seller | order | Seller that fulfils the order (the first seller VTEX lists on it). |
units | Units | order | Sum of item quantities in the order. |
brand_name | Brand | product | Brand of the product. |
category_name | Category | product | Most specific category of the product (the leaf of its category path). |
product_id | Product ID | product | VTEX product id. |
product_name | Product Name | product | Product name. |
quantity | Quantity Sold | product | Units on the line. |
ref_id | Reference Code | product | Merchant reference code of the SKU (refId). |
sku_id | SKU ID | product | VTEX SKU id. |
sku_is_active | SKU Active | product | Whether the SKU is active in the catalog. |
sku_name | SKU Name | product | SKU name. |
skus | SKUs | product | Number of SKUs. |