VTEX · Schema

MiniCart

Minicart information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
buyer object
shipping object
items array Items information.
taxValue number Total tax value.
listRegistry object
View JSON Schema on GitHub

JSON Schema

vtex-minicart-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MiniCart",
  "title": "MiniCart",
  "description": "Minicart information.",
  "required": [
    "buyer",
    "shipping",
    "items",
    "taxValue",
    "listRegistry"
  ],
  "type": "object",
  "properties": {
    "buyer": {
      "$ref": "#/components/schemas/Buyer"
    },
    "shipping": {
      "$ref": "#/components/schemas/Shipping"
    },
    "items": {
      "type": "array",
      "description": "Items information.",
      "items": {
        "$ref": "#/components/schemas/Item"
      }
    },
    "taxValue": {
      "type": "number",
      "description": "Total tax value.",
      "example": 5.58
    },
    "listRegistry": {
      "$ref": "#/components/schemas/ListRegistry"
    }
  }
}