VTEX · Schema

requestCancelOrderMarketplace

Object used to request the cancellation of an order on the marketplace.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
reason string Insert here the reason for the order's cancellation.
View JSON Schema on GitHub

JSON Schema

vtex-requestcancelordermarketplace-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/requestCancelOrderMarketplace",
  "title": "requestCancelOrderMarketplace",
  "type": "object",
  "description": "Object used to request the cancellation of an order on the marketplace.",
  "required": [
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Insert here the reason for the order's cancellation.",
      "example": "Product is unavailable."
    }
  }
}