VTEX · Schema
ChangesAttachment
Information about changes in the order.
CommerceE-CommerceRetailMarketplacePayments
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Object ID, the expect value is `changeAttachment`. |
| changesData | array | Order change details. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ChangesAttachment",
"title": "ChangesAttachment",
"description": "Information about changes in the order.",
"required": [
"id",
"changesData"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Object ID, the expect value is `changeAttachment`."
},
"changesData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangesDatum"
},
"description": "Order change details."
}
},
"example": {
"id": "changeAttachment",
"changesData": [
{
"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"
}
}
]
}
}