json icon

Update Product

v1.0.0commands

Command to update an existing product in the catalog.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "UpdateProduct",
4  "description": "Command to update an existing product. Only the fields supplied are changed.",
5  "type": "object",
6  "properties": {
7    "productId": {
8      "description": "Unique identifier of the product to update",
9      "type": "string",
10      "format": "uuid"
11    },
12    "name": {
13      "description": "New display name",
14      "type": "string",
15      "minLength": 1
16    },
17    "description": {
18      "description": "New long-form description",
19      "type": "string"
20    },
21    "price": {
22      "description": "New price in minor units (e.g. cents)",
23      "type": "integer",
24      "minimum": 0
25    },
26    "currency": {
27      "description": "ISO 4217 currency code",
28      "type": "string",
29      "pattern": "^[A-Z]{3}$"
30    },
31    "category": {
32      "description": "New category",
33      "type": "string"
34    },
35    "status": {
36      "description": "New lifecycle status",
37      "type": "string",
38      "enum": ["DRAFT", "ACTIVE", "ARCHIVED"]
39    }
40  },
41  "required": ["productId"]
42}
43

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions