VTEX · Schema

Cart2

Cart information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
grandTotal integer Total payment value.
relationName string Represents the relationship between the client and the store.
redemptionCode string Gift card identification code used at checkout. Minimum of 6 characters.
discounts integer Discounts value.
shipping integer Shipping value.
taxes integer Taxes value.
items array
itemsTotal integer Total items value.
View JSON Schema on GitHub

JSON Schema

vtex-cart2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Cart2",
  "title": "Cart2",
  "type": "object",
  "description": "Cart information.",
  "required": [
    "grandTotal",
    "relationName",
    "redemptionCode",
    "discounts",
    "shipping",
    "taxes",
    "items",
    "itemsTotal"
  ],
  "properties": {
    "grandTotal": {
      "type": "integer",
      "description": "Total payment value.",
      "example": 182
    },
    "relationName": {
      "type": "string",
      "nullable": true,
      "description": "Represents the relationship between the client and the store.",
      "example": null
    },
    "redemptionCode": {
      "type": "string",
      "description": "Gift card identification code used at checkout. Minimum of 6 characters.",
      "example": "FASD-ASDS-ASDA-ASDA"
    },
    "discounts": {
      "type": "integer",
      "description": "Discounts value.",
      "example": -20
    },
    "shipping": {
      "type": "integer",
      "description": "Shipping value.",
      "example": 2
    },
    "taxes": {
      "type": "integer",
      "description": "Taxes value.",
      "example": 0
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Item"
      }
    },
    "itemsTotal": {
      "type": "integer",
      "description": "Total items value.",
      "example": 200
    }
  }
}