json icon

Cancel Order

v1.0.0commands

Command to cancel an existing order.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "CancelOrder",
4  "description": "Command to cancel an existing order",
5  "type": "object",
6  "properties": {
7    "orderId": {
8      "description": "Identifier of the order to cancel",
9      "type": "string",
10      "format": "uuid"
11    },
12    "reason": {
13      "description": "Why the order is being cancelled",
14      "type": "string",
15      "enum": ["CUSTOMER_REQUESTED", "PAYMENT_FAILED", "OUT_OF_STOCK", "FRAUD"]
16    }
17  },
18  "required": ["orderId", "reason"]
19}
20

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions