VTEX · Schema

RatesAndBenefitsData

Information on promotions and taxes that apply to the order.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string ID of the rate or benefit.
rateAndBenefitsIdentifiers array Information about order's promotions and taxes identifiers.
View JSON Schema on GitHub

JSON Schema

vtex-ratesandbenefitsdata-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RatesAndBenefitsData",
  "title": "RatesAndBenefitsData",
  "description": "Information on promotions and taxes that apply to the order.",
  "required": [
    "id",
    "rateAndBenefitsIdentifiers"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the rate or benefit."
    },
    "rateAndBenefitsIdentifiers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Information about order's promotions and taxes identifiers."
    }
  },
  "example": {
    "id": "ratesAndBenefitsData",
    "rateAndBenefitsIdentifiers": []
  }
}