VTEX · Schema

Page Confirmation

Sends a confirmation informing the products that were bought.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
session object
anonymous object
products array Array of objects containing products. If the event type is `page.cart`, the array contains all the products in the cart, with their ID and quantity. Each interaction should include all products inside
order string Order ID.
type string Type of event, which can be one of the following: `page.cart`, `page.empty_cart`, `search.query`, `page.confirmation`, `session.ping`, `search.click`.
View JSON Schema on GitHub

JSON Schema

vtex-pageconfirmation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PageConfirmation",
  "title": "Page Confirmation",
  "description": "Sends a confirmation informing the products that were bought.",
  "type": "object",
  "required": [
    "session",
    "anonymous",
    "type",
    "order",
    "products"
  ],
  "properties": {
    "session": {
      "$ref": "#/components/schemas/UserIdentification/properties/session"
    },
    "anonymous": {
      "$ref": "#/components/schemas/UserIdentification/properties/anonymous"
    },
    "products": {
      "type": "array",
      "title": "products",
      "description": "Array of objects containing products. If the event type is `page.cart`, the array contains all the products in the cart, with their ID and quantity.  Each interaction should include all products inside the shopping cart at that time. In case a product is removed, sent the updated card. If there are no products in the cart (page.`empty_cart`), the array is empty. If the event type is `page.confirmation`, the array contains all the products that were purchased, with their ID, price and quantity.",
      "items": {
        "$ref": "#/components/schemas/OrderProduct"
      }
    },
    "order": {
      "type": "string",
      "title": "order",
      "description": "Order ID.",
      "example": "123ABC"
    },
    "type": {
      "type": "string",
      "title": "type",
      "description": "Type of event, which can be one of the following: `page.cart`, `page.empty_cart`, `search.query`, `page.confirmation`, `session.ping`, `search.click`.",
      "example": "page.confirmation"
    }
  }
}