VTEX · Schema

Total

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.
name string Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.
value integer Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.
View JSON Schema on GitHub

JSON Schema

vtex-total-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Total",
  "title": "Total",
  "required": [
    "id",
    "name",
    "value"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`."
    },
    "name": {
      "type": "string",
      "description": "Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`."
    },
    "value": {
      "type": "integer",
      "description": "Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`."
    }
  },
  "example": {
    "id": "Items",
    "name": "Total dos Itens",
    "value": 3290
  }
}