Product
APIs for managing products
List ProductsGET
List all products with pagination and filtering options.
Create ProductPOST
Create a new product with its modifiers, prices, ingredients and recipes.
Detail ProductGET
Get details of a specific product by its ID.
Update ProductPOST
Update an existing product and its modifiers, prices, ingredients and recipes.
Delete ProductDELETE
Delete a product by its ID.
Quick Create ProductPOST
Quickly create a product with a single option.
Quick Update ProductPOST
Quickly update a product and its single option.
Sort ProductsPOST
Reorder products within a market and branch.
Delete ProductsDELETE
Delete multiple products by their IDs.
List Product CategoriesGET
List product categories with pagination, search, sector/market/branch filtering and per-branch sort order.
Create Product CategoryPOST
Create a product category with its icon, optional image URL and localized names.
Detail Product CategoryGET
Get a product category by its ID, including its linked sectors.
Update Product CategoryPOST
Update a product category's icon, image URL or localized names.
Delete Product CategoryDELETE
Delete a product category by its ID.
Sort Product CategoriesPOST
Replace the product category display order for a market and branch.
List Product IngredientsGET
List the ingredients attached to a product.
Create Product IngredientPOST
Attach an ingredient to a product.
Detail Product IngredientGET
Get a single ingredient attached to a product.
Update Product IngredientPOST
Update an ingredient attached to a product.
Delete Product IngredientDELETE
Detach an ingredient from a product.
List Product ModifiersGET
List the modifiers of a product.
Create Product ModifierPOST
Add a modifier to a product.
Detail Product ModifierGET
Get a single modifier of a product.
Update Product ModifierPOST
Update a modifier of a product.
Delete Product ModifierDELETE
Remove a modifier from a product.
List Product PricesGET
List the payment-method prices of a product.
Upsert Product PricePOST
Add or update a product price for a payment method or order type.
Detail Product PriceGET
Get a single price of a product.
Delete Product PriceDELETE
Remove a price from a product.
List Product RecipesGET
List the recipes attached to a product.
Create Product RecipePOST
Attach a recipe to a product.
Detail Product RecipeGET
Get a single recipe attached to a product.
Update Product RecipePOST
Update a recipe attached to a product.
Delete Product RecipeDELETE
Detach a recipe from a product.
List Product IngredientsGET
List the ingredients attached to a product.
Create Product IngredientPOST
Attach an ingredient to a product.
Detail Product IngredientGET
Get a single ingredient attached to a product.
Update Product IngredientPOST
Update an ingredient attached to a product.
Delete Product IngredientDELETE
Detach an ingredient from a product.
Preview Modifier ChargePOST
Compute a per-modifier before/after price, tax, and total for a paginated list of product modifiers against a priceable (order type or payment method), reflecting saved overrides or a staged overrides payload.
List Product PricesGET
List the payment-method prices of a product.
Upsert Product PricePOST
Add or update a product price for a payment method or order type.
Detail Product PriceGET
Get a single price of a product.
Delete Product PriceDELETE
Remove a price from a product.
List Product RecipesGET
List the recipes attached to a product.
Create Product RecipePOST
Attach a recipe to a product.
Detail Product RecipeGET
Get a single recipe attached to a product.
Update Product RecipePOST
Update a recipe attached to a product.
Delete Product RecipeDELETE
Detach a recipe from a product.
Generate SKUPOST
Generate a random SKU that is not currently used by any option/add-on in the given market (and branch, when given). The value is not reserved — it is still validated for uniqueness again when the caller submits it on create/update.