VTEX · Schema

Purchase information.

Purchase information object.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentData object
clientPreferences object Client preferences.
isToSavePersonalData boolean Defines if personal data will be saved (`true`) or not (`false`).
lastUserPurchases array Array with latest purchases from the client.
lastPurchasesAddressId string Unique identifier of the client address.
View JSON Schema on GitHub

JSON Schema

vtex-purchaseinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PurchaseInfo",
  "title": "Purchase information.",
  "type": "object",
  "description": "Purchase information object.",
  "properties": {
    "paymentData": {
      "$ref": "#/components/schemas/PaymentData"
    },
    "clientPreferences": {
      "type": "object",
      "description": "Client preferences.",
      "properties": {}
    },
    "isToSavePersonalData": {
      "type": "boolean",
      "description": "Defines if personal data will be saved (`true`) or not (`false`)."
    },
    "lastUserPurchases": {
      "type": "array",
      "description": "Array with latest purchases from the client.",
      "items": {
        "type": "object",
        "description": "Purchase information.",
        "properties": {
          "creationDate": {
            "type": "string",
            "description": "Purchase date in the ISO 8601 format."
          },
          "orderId": {
            "type": "string",
            "description": "Unique identifier of the order."
          },
          "orderGroup": {
            "type": "string",
            "description": "Unique identifier of the order group."
          },
          "value": {
            "type": "number",
            "description": "Purchase value."
          }
        }
      }
    },
    "lastPurchasesAddressId": {
      "type": "string",
      "description": "Unique identifier of the client address."
    }
  }
}