VTEX · Schema

ChangesDatum

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
reason string Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails.
discountValue integer Order change discount value.
incrementValue integer Order change increment value.
itemsAdded array List of items added to the order.
itemsRemoved array List of items removed from the order.
receipt object
View JSON Schema on GitHub

JSON Schema

vtex-changesdatum-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChangesDatum",
  "title": "ChangesDatum",
  "required": [
    "reason",
    "discountValue",
    "incrementValue",
    "itemsAdded",
    "itemsRemoved",
    "receipt"
  ],
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails."
    },
    "discountValue": {
      "type": "integer",
      "description": "Order change discount value."
    },
    "incrementValue": {
      "type": "integer",
      "description": "Order change increment value."
    },
    "itemsAdded": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of items added to the order."
    },
    "itemsRemoved": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ItemsRemoved"
      },
      "description": "List of items removed from the order."
    },
    "receipt": {
      "$ref": "#/components/schemas/Receipt"
    }
  },
  "example": {
    "reason": "Blah",
    "discountValue": 3290,
    "incrementValue": 0,
    "itemsAdded": [],
    "itemsRemoved": [
      {
        "id": "1234568358",
        "name": "Bay Max L",
        "quantity": 1,
        "price": 3290,
        "unitMultiplier": null
      }
    ],
    "receipt": {
      "date": "2019-02-06T20:46:04.4003606+00:00",
      "orderId": "v5195004lux-01",
      "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-changesdatum"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.