VTEX · Schema

CancelChangeStoppedonError

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
reason string Reason why you wish to cancel the order change. The customer will not view the value inserted in this field.
View JSON Schema on GitHub

JSON Schema

vtex-cancelchangestoppedonerror-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CancelChangeStoppedonError",
  "title": "CancelChangeStoppedonError",
  "required": [
    "reason"
  ],
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "Reason why you wish to cancel the order change. The customer will not view the value inserted in this field.",
      "example": "I want to cancel this change order request because it's stopped on a blocking error."
    }
  },
  "example": {
    "reason": "I want to cancel this change order request because it's stopped on a blocking error."
  }
}