The catalogue item

The fields of a catalogue item, as every catalogue endpoint returns it.

A catalogue item is one thing your own system sells, keyed by your externalId. See Sync your catalogue for how items are used.

Attributes

idstringrequired
Localoy's ID for the item. You never need it — address items by externalId.
externalIdstringrequired
Your ID for the item. Unique among your items, and never changes.
namestringrequired
The item's name.
descriptionstring | nullrequired
A longer description, or null.
priceCentsintegerrequired
The price in minor units — 45000 is ৳450.00.
currencystringrequired
ISO 4217 currency code, upper case. BDT unless you set another.
availablebooleanrequired
Whether you are selling the item.
stockinteger | nullrequired
Units in stock, or null when you do not track stock. 0 means tracked and empty.
metadataobject | nullrequired
Your own key–value data, returned as you sent it.
localoyRefobject | nullrequired

The Localoy bookable this item stands for, or null.

  • type — event_ticket, activity_item or dining.
  • id — the bookable's ID, from GET /bookables.
managedByobject | nullrequired

The integration that manages the item, or null for an item you created with your own key. See Items managed by an integration.

  • type — TECHNOLOGY_PROVIDER for a Technology Provider, or ADAPTER for a store sync such as WooCommerce.
  • key — the integration's identifier.
  • name — its display name.
createdAtstringrequired
When the item was created, ISO 8601 UTC.
updatedAtstringrequired
When the item was last changed, ISO 8601 UTC.
The catalogue item
{
  "id": "cm1q2w3e4r5t6y7u8i9o0p1a2",
  "externalId": "sku-4471",
  "name": "Kacchi Biryani (full)",
  "description": "Mutton kacchi with borhani",
  "priceCents": 45000,
  "currency": "BDT",
  "available": true,
  "stock": 12,
  "metadata": { "posCategory": "mains" },
  "localoyRef": { "type": "dining", "id": "cm4d1n1ng00000000000001" },
  "managedBy": null,
  "createdAt": "2026-09-26T08:15:30.123Z",
  "updatedAt": "2026-09-26T08:15:30.123Z"
}