Block · Schema
CatalogObject
The wrapper object for catalog entries of a given object type.
CommerceCryptocurrencyeCommerceFintechPaymentsPoint Of SaleSquare
Properties
| Name | Type | Description |
|---|---|---|
| type | string | The type of this object. |
| id | string | Unique ID for this CatalogObject. |
| version | integer | The version of the object for optimistic concurrency control. |
| item_data | object | Structured data for a CatalogItem. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/block/main/json-schema/block-catalog-object-schema.json",
"title": "CatalogObject",
"description": "The wrapper object for catalog entries of a given object type.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of this object.",
"enum": ["ITEM", "ITEM_VARIATION", "CATEGORY", "TAX", "DISCOUNT", "MODIFIER_LIST", "MODIFIER"],
"example": "ITEM"
},
"id": {
"type": "string",
"description": "Unique ID for this CatalogObject.",
"example": "RYOIMONN5KRSWHVY7TNKH"
},
"version": {
"type": "integer",
"description": "The version of the object for optimistic concurrency control.",
"example": 1554399346626
},
"item_data": {
"type": "object",
"description": "Structured data for a CatalogItem.",
"properties": {
"name": { "type": "string", "example": "Caramel Macchiato" },
"description": { "type": "string", "example": "Hot or iced espresso beverage" }
}
}
}
}