json icon

Create Product

v1.0.0commands

Command to add a new product to the catalog.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "CreateProduct",
4  "description": "Command to add a new product to the catalog",
5  "type": "object",
6  "properties": {
7    "sku": {
8      "description": "Stock keeping unit — must be unique",
9      "type": "string"
10    },
11    "name": {
12      "description": "Display name of the product",
13      "type": "string",
14      "minLength": 1
15    },
16    "description": {
17      "description": "Long-form product description",
18      "type": "string"
19    },
20    "price": {
21      "description": "Price in minor units (e.g. cents)",
22      "type": "integer",
23      "minimum": 0
24    },
25    "currency": {
26      "description": "ISO 4217 currency code",
27      "type": "string",
28      "pattern": "^[A-Z]{3}$"
29    },
30    "category": {
31      "description": "Category the product belongs to",
32      "type": "string"
33    },
34    "status": {
35      "description": "Initial lifecycle status — defaults to DRAFT",
36      "type": "string",
37      "enum": ["DRAFT", "ACTIVE", "ARCHIVED"]
38    }
39  },
40  "required": ["sku", "name", "price", "currency"]
41}
42

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions