Overview
Products — Base: /v1/products
Products are the items in the store’s catalog/menu — what the merchant sells. Together with their modifiers (variations or extras: size, ingredients, add-ons…) and their categories, they form the catalog that belongs to the place.
A place is an app (sale terminal / POS / location): the point where products are offered. A product is linked to one or more places (its locations) so it appears on those terminals.
This folder covers product CRUD plus reading its relations:
-
GET /products/:productId/modifiers— the product’s modifiers. -
GET /products/:productId/locations— the places/apps where it is available.
The Modifiers subfolder covers the full modifier CRUD under /v1/product-modifiers and the product↔modifier linking.
Related (outside this folder):
- Categories — managed under
/product-categories, but JWT/admin only (they do not accept API key), which is why they are not in this collection.
Scopes: Merchant.product.{read,create,update,delete}.
