Catalog
The catalog entity represents a product, ticket, or other item available for purchase in a commerce transaction. Each catalog item defines the product details, pricing, and availability.
| Field | Type | Description |
|---|---|---|
key |
String | Unique key for the catalog item. |
code |
String | Catalog code identifier (e.g., "GEN-TICKET-001"). |
name |
String | Name of the catalog item. |
status |
String | Status of the catalog item. Values: "active", "archived", "draft". |
type |
String | Type of the catalog item. Values: "ordinary", "discount", "feePlatform". |
description |
String | Description of the catalog item. |
imageUrl |
String | URL of the catalog item image. |
currency |
String | Currency code used for pricing (e.g., "AUD", "USD"). |
quantity |
Number | Quantity available in the catalog. |
price |
Number | Price of the catalog item. |
cost |
Number | Cost of the catalog item. |
brand |
Brand | Associated brand entity. |
weight |
Number | Weight of the catalog item. |
custom |
Object | Custom metadata for the catalog item. |
createdAt |
DateTime | Date when the catalog item was created. |
modifiedAt |
DateTime | Date when the catalog item was last modified. |