LocaloyDevelopers
Open Network APIv1

List items

Page through your catalogue items, newest first.

GET{BASE_URL}/catalog/items

Returns your catalogue items, newest first, one page at a time. Requires the INVENTORY scope. Items mirrored from a connected store are included.

Query parameters

limitintegeroptional
Items per page, at least 1. Default 50; values above 200 are treated as 200.
offsetintegeroptional
Items to skip, at least 0. Default 0.
availablestringoptional
true or false to return only items with that availability. Omit for both.

Response

data.itemsobject[]required
The page of catalogue items.
data.totalintegerrequired
How many items match, across all pages.
data.limitintegerrequired
The page size used.
data.offsetintegerrequired
The offset used.

To read everything, repeat with offset increased by limit until offset reaches total.

Status codes#

StatusMeaning
200Success. An empty catalogue returns an empty items array.
400limit, offset or available is invalid.
cURL
curl "$LOCALOY_BASE_URL/catalog/items?limit=2&offset=0" \
  -H "Authorization: Bearer $LOCALOY_API_KEY"
Response · 200
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "cm1q2w3e4r5t6y7u8i9o0p1a2",
        "externalId": "sku-4471",
        "name": "Kacchi Biryani (full)",
        "description": "Mutton kacchi with borhani",
        "priceCents": 45000,
        "currency": "BDT",
        "available": true,
        "stock": 12,
        "metadata": null,
        "localoyRef": null,
        "managedBy": null,
        "createdAt": "2026-09-26T08:15:30.123Z",
        "updatedAt": "2026-09-26T08:15:30.123Z"
      }
    ],
    "total": 1,
    "limit": 2,
    "offset": 0
  }
}