- DATE:
- AUTHOR:
- The Toast developer communication team
Links
New customAttributes and brand values added to the CatalogProductInfo object in the menus API
The CatalogProductInfo object in the menus API (returned as the catalogProductInfo value on MenuItem) now includes customAttributes and brand values.
The customAttributes value is an array of merchant-defined attributes describing the retail product, such as Material: Cotton or Vintage: 2015. This array is empty when the product has no custom attributes.
The brand value is a CatalogBrand object containing the unique identifier and name of the brand or manufacturer that produces the product.
Like the rest of catalogProductInfo, these values are only populated for menu items that represent products available through a retail product catalog. If your Toast POS location doesn't use a retail product catalog, catalogProductInfo — and these nested values — will be null.
For example:
"catalogProductInfo": {
"product": {
"id": "3f29b6c1-8b7a-4e2a-9c3d-1a2b3c4d5e6f",
"name": "T-Shirt",
"type": "OPTION"
},
"productVariant": {
"id": "7a1c2d3e-4f5b-6a7c-8d9e-0f1a2b3c4d5e",
"name": "T-Shirt - Small"
},
"customAttributes": [
{
"id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
"name": "Material",
"type": "TEXT",
"values": [
{
"id": null,
"name": "Cotton"
}
]
}
],
"brand": {
"id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"name": "My Apparel Co."
}
}
Links