{ "info": { "_postman_id": "minitill-public-api-v1", "name": "MiniTill Public API v1", "description": "Generated from apps/web/src/lib/api-registry.ts. Run `npm run docs:api:generate` after changing the public API registry.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://minitill.co.nz", "type": "string" }, { "key": "apiKey", "value": "{{apiKey}}", "type": "string" }, { "key": "storeId", "value": "", "type": "string", "description": "Default store identifier for examples that need one" } ], "item": [ { "name": "Other", "item": [ { "name": "Read the public gift-card offer and online checkout availability", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/public/stores/:storeSlug/gift-card-offer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "public", "stores", ":storeSlug", "gift-card-offer" ], "variable": [ { "key": "storeSlug", "value": "" } ] }, "description": "Read the public gift-card offer and online checkout availability" } }, { "name": "List business ingredients", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ingredients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ingredients" ], "variable": [] }, "description": "List business ingredients" } }, { "name": "Create a business ingredient", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ingredients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ingredients" ], "variable": [] }, "description": "Create a business ingredient", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a business ingredient", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ingredients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ingredients", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a business ingredient" } }, { "name": "Update or soft-delete a business ingredient", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/ingredients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ingredients", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update or soft-delete a business ingredient", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update or soft-delete a business ingredient", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/ingredients/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "ingredients", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update or soft-delete a business ingredient" } }, { "name": "List business recipes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/recipes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "recipes" ], "variable": [] }, "description": "List business recipes" } }, { "name": "Create a business recipe", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/recipes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "recipes" ], "variable": [] }, "description": "Create a business recipe", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a business recipe", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/recipes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "recipes", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a business recipe" } }, { "name": "Update or soft-delete a business recipe", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/recipes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "recipes", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update or soft-delete a business recipe", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update or soft-delete a business recipe", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/recipes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "recipes", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update or soft-delete a business recipe" } }, { "name": "Get business and store food cost targets", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/businesses/:id/costing-settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "businesses", ":id", "costing-settings" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get business and store food cost targets" } }, { "name": "Update the business default food cost target", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/businesses/:id/costing-settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "businesses", ":id", "costing-settings" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update the business default food cost target", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Catalogue", "item": [ { "name": "Read a product recipe link", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/:id/recipe", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id", "recipe" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Read a product recipe link" } }, { "name": "Set or remove a product recipe link", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id/recipe", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id", "recipe" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Set or remove a product recipe link", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Set or remove a product recipe link", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/:id/recipe", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id", "recipe" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Set or remove a product recipe link" } }, { "name": "List categories for the authenticated business", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "categories" ], "variable": [] }, "description": "List categories for the authenticated business" } }, { "name": "Create a category", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "categories" ], "variable": [] }, "description": "Create a category", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a category", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a category" } }, { "name": "Update a category", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update a category", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Soft-delete a category", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "categories", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Soft-delete a category" } }, { "name": "List products", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [] }, "description": "List products" } }, { "name": "Create a product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products" ], "variable": [] }, "description": "Create a product", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a product", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a product" } }, { "name": "Update a product", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update a product", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Soft-delete a product", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Soft-delete a product" } }, { "name": "List modifier groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/modifier-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "modifier-groups" ], "variable": [] }, "description": "List modifier groups" } }, { "name": "Create a modifier group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/modifier-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "modifier-groups" ], "variable": [] }, "description": "Create a modifier group", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a modifier group", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/modifier-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "modifier-groups", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a modifier group" } }, { "name": "Update a modifier group", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/modifier-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "modifier-groups", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update a modifier group", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Soft-delete a modifier group", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/modifier-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "modifier-groups", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Soft-delete a modifier group" } } ] }, { "name": "Stores", "item": [ { "name": "List store suppliers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "suppliers" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "List store suppliers" } }, { "name": "Create a store supplier", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "suppliers" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Create a store supplier", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a store supplier", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/suppliers/:supplierId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "suppliers", ":supplierId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "supplierId", "value": "" } ] }, "description": "Get a store supplier" } }, { "name": "Update or soft-delete a store supplier", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/suppliers/:supplierId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "suppliers", ":supplierId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "supplierId", "value": "" } ] }, "description": "Update or soft-delete a store supplier", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update or soft-delete a store supplier", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/suppliers/:supplierId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "suppliers", ":supplierId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "supplierId", "value": "" } ] }, "description": "Update or soft-delete a store supplier" } }, { "name": "List store supplier products", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-products" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "List store supplier products" } }, { "name": "Create a store supplier product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-products" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Create a store supplier product", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a store supplier product and price history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-products/:supplierProductId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-products", ":supplierProductId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "supplierProductId", "value": "" } ] }, "description": "Get a store supplier product and price history" } }, { "name": "Update price or soft-delete a store supplier product", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-products/:supplierProductId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-products", ":supplierProductId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "supplierProductId", "value": "" } ] }, "description": "Update price or soft-delete a store supplier product", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update price or soft-delete a store supplier product", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-products/:supplierProductId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-products", ":supplierProductId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "supplierProductId", "value": "" } ] }, "description": "Update price or soft-delete a store supplier product" } }, { "name": "List encrypted store supplier connections", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-connections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-connections" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "List encrypted store supplier connections" } }, { "name": "Create an encrypted store supplier connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-connections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-connections" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Create an encrypted store supplier connection", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a masked store supplier connection", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-connections", ":connectionId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "connectionId", "value": "" } ] }, "description": "Get a masked store supplier connection" } }, { "name": "Update or disconnect a store supplier connection", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-connections", ":connectionId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "connectionId", "value": "" } ] }, "description": "Update or disconnect a store supplier connection", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update or disconnect a store supplier connection", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-connections/:connectionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-connections", ":connectionId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "connectionId", "value": "" } ] }, "description": "Update or disconnect a store supplier connection" } }, { "name": "Test a store supplier connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-connections/:connectionId/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-connections", ":connectionId", "test" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "connectionId", "value": "" } ] }, "description": "Test a store supplier connection", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Synchronize a store supplier catalog and prices", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/supplier-connections/:connectionId/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "supplier-connections", ":connectionId", "sync" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "connectionId", "value": "" } ] }, "description": "Synchronize a store supplier catalog and prices", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "List store ingredient purchase options", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/ingredient-purchase-options", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "ingredient-purchase-options" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "List store ingredient purchase options" } }, { "name": "Create a store ingredient purchase option", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/ingredient-purchase-options", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "ingredient-purchase-options" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Create a store ingredient purchase option", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a store ingredient purchase option", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/ingredient-purchase-options/:optionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "ingredient-purchase-options", ":optionId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "optionId", "value": "" } ] }, "description": "Get a store ingredient purchase option" } }, { "name": "Update or soft-delete a store ingredient purchase option", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/ingredient-purchase-options/:optionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "ingredient-purchase-options", ":optionId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "optionId", "value": "" } ] }, "description": "Update or soft-delete a store ingredient purchase option", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update or soft-delete a store ingredient purchase option", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/ingredient-purchase-options/:optionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "ingredient-purchase-options", ":optionId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "optionId", "value": "" } ] }, "description": "Update or soft-delete a store ingredient purchase option" } }, { "name": "Calculate a recipe cost using store supplier prices", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/recipes/:recipeId/cost", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "recipes", ":recipeId", "cost" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "recipeId", "value": "" } ] }, "description": "Calculate a recipe cost using store supplier prices" } }, { "name": "Calculate product cost and margin for a store", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/products/:productId/cost", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "products", ":productId", "cost" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "productId", "value": "" } ] }, "description": "Calculate product cost and margin for a store" } }, { "name": "List product cost impacts generated by supplier price changes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/cost-change-reviews", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "cost-change-reviews" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "List product cost impacts generated by supplier price changes" } }, { "name": "Update the workflow status of a product cost review", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/cost-change-reviews/:reviewId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "cost-change-reviews", ":reviewId" ], "variable": [ { "key": "storeId", "value": "" }, { "key": "reviewId", "value": "" } ] }, "description": "Update the workflow status of a product cost review", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "List cheaper active ingredient purchase options", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/saving-opportunities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "saving-opportunities" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "List cheaper active ingredient purchase options" } }, { "name": "Hide or restore a store saving opportunity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/saving-opportunities/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "saving-opportunities", "dismiss" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Hide or restore a store saving opportunity", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Hide or restore a store saving opportunity", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/saving-opportunities/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "saving-opportunities", "dismiss" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Hide or restore a store saving opportunity" } }, { "name": "Get store costing coverage and operational health", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/costing/health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "costing", "health" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Get store costing coverage and operational health" } }, { "name": "Get the store food cost target and its effective fallback", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/costing-settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "costing-settings" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Get the store food cost target and its effective fallback" } }, { "name": "Set or clear a store food cost target override", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/costing-settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "costing-settings" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Set or clear a store food cost target override", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Reprocess pending supplier price histories into cost reviews", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:storeId/costing/reprocess", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":storeId", "costing", "reprocess" ], "variable": [ { "key": "storeId", "value": "" } ] }, "description": "Reprocess pending supplier price histories into cost reviews", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "List stores for the authenticated business", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores" ], "variable": [] }, "description": "List stores for the authenticated business" } }, { "name": "Create a store", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores" ], "variable": [] }, "description": "Create a store", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a store", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a store" } }, { "name": "Update a store", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/stores/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update a store", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Soft-delete a store", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/stores/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "stores", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Soft-delete a store" } } ] }, { "name": "Orders", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [] }, "description": "List orders" } }, { "name": "Create an order (supports Idempotency-Key)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders" ], "variable": [] }, "description": "Create an order (supports Idempotency-Key)", "body": { "mode": "raw", "raw": "{\n \"storeId\": \"{{storeId}}\",\n \"fulfillmentType\": \"DINE_IN\"\n}" } } }, { "name": "Get an order", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get an order" } }, { "name": "Update an order", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "orders", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update an order", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Payments", "item": [ { "name": "List payments", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "payments" ], "variable": [] }, "description": "List payments" } }, { "name": "Create a payment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "payments" ], "variable": [] }, "description": "Create a payment", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a payment", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "payments", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a payment" } } ] }, { "name": "Customers", "item": [ { "name": "List customers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers" ], "variable": [] }, "description": "List customers" } }, { "name": "Create a customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers" ], "variable": [] }, "description": "Create a customer", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a customer", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a customer" } }, { "name": "Update a customer", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update a customer", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Delete a customer", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Delete a customer" } }, { "name": "Create a manual loyalty points adjustment (supports Idempotency-Key)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/customers/:id/loyalty-adjustments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "loyalty-adjustments" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Create a manual loyalty points adjustment (supports Idempotency-Key)", "body": { "mode": "raw", "raw": "{\n \"points\": 10,\n \"note\": \"Manual adjustment\"\n}" } } }, { "name": "Get a customer's loyalty ledger", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/customers/:id/loyalty-ledger", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "customers", ":id", "loyalty-ledger" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a customer's loyalty ledger" } } ] }, { "name": "Loyalty", "item": [ { "name": "Get loyalty program settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/loyalty/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "loyalty", "settings" ], "variable": [] }, "description": "Get loyalty program settings" } }, { "name": "Update loyalty program settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/loyalty/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "loyalty", "settings" ], "variable": [] }, "description": "Update loyalty program settings", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Gift Cards", "item": [ { "name": "List gift cards", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/gift-cards", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "gift-cards" ], "variable": [] }, "description": "List gift cards" } }, { "name": "Issue a gift card", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/gift-cards", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "gift-cards" ], "variable": [] }, "description": "Issue a gift card", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Get a gift card", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/gift-cards/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "gift-cards", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a gift card" } }, { "name": "Look up a gift card by code", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/gift-cards/lookup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "gift-cards", "lookup" ], "variable": [] }, "description": "Look up a gift card by code" } }, { "name": "Redeem a gift card (supports Idempotency-Key)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/gift-cards/redeem", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "gift-cards", "redeem" ], "variable": [] }, "description": "Redeem a gift card (supports Idempotency-Key)", "body": { "mode": "raw", "raw": "{\n \"code\": \"GC-0001\",\n \"amount\": 10\n}" } } }, { "name": "Get gift card program settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/gift-cards/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "gift-cards", "settings" ], "variable": [] }, "description": "Get gift card program settings" } }, { "name": "Update gift card program settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/gift-cards/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "gift-cards", "settings" ], "variable": [] }, "description": "Update gift card program settings", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Vouchers", "item": [ { "name": "List vouchers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/vouchers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "vouchers" ], "variable": [] }, "description": "List vouchers" } }, { "name": "Look up a voucher by code", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/vouchers/lookup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "vouchers", "lookup" ], "variable": [] }, "description": "Look up a voucher by code" } }, { "name": "Redeem a voucher (supports Idempotency-Key)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/vouchers/redeem", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "vouchers", "redeem" ], "variable": [] }, "description": "Redeem a voucher (supports Idempotency-Key)", "body": { "mode": "raw", "raw": "{\n \"code\": \"VOUCHER-0001\",\n \"orderTotal\": 25\n}" } } }, { "name": "List voucher templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/voucher-templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "voucher-templates" ], "variable": [] }, "description": "List voucher templates" } }, { "name": "Create a voucher template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/voucher-templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "voucher-templates" ], "variable": [] }, "description": "Create a voucher template", "body": { "mode": "raw", "raw": "{}" } } } ] }, { "name": "Reports", "item": [ { "name": "Get a sales summary report", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/sales", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "sales" ], "variable": [] }, "description": "Get a sales summary report" } }, { "name": "Get customer acquisition and sales report data", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "customers" ], "variable": [] }, "description": "Get customer acquisition and sales report data" } }, { "name": "Get time-bucketed sales with prior-period comparison", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/sales-by-time", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "sales-by-time" ], "variable": [] }, "description": "Get time-bucketed sales with prior-period comparison" } }, { "name": "Get recognised menu sales and available costing estimates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/menu-profitability", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "menu-profitability" ], "variable": [] }, "description": "Get recognised menu sales and available costing estimates" } }, { "name": "Get order sales and customer metrics by channel and fulfilment type", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/order-channels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "order-channels" ], "variable": [] }, "description": "Get order sales and customer metrics by channel and fulfilment type" } }, { "name": "Get recorded discounts, refunds, and unsuccessful order metrics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/revenue-leakage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "revenue-leakage" ], "variable": [] }, "description": "Get recorded discounts, refunds, and unsuccessful order metrics" } }, { "name": "Get aggregate customer retention and loyalty metrics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/customer-retention", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "customer-retention" ], "variable": [] }, "description": "Get aggregate customer retention and loyalty metrics" } }, { "name": "Get bounded product co-purchase affinity metrics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/product-affinity", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "product-affinity" ], "variable": [] }, "description": "Get bounded product co-purchase affinity metrics" } }, { "name": "Get till closing variance and control metrics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/till-variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "till-variance" ], "variable": [] }, "description": "Get till closing variance and control metrics" } }, { "name": "Get logical payment operation reliability metrics", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/payment-reliability", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "payment-reliability" ], "variable": [] }, "description": "Get logical payment operation reliability metrics" } }, { "name": "Get aggregate marketplace settlement reconciliation using date-only YYYY-MM-DD ranges", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/marketplace-reconciliation", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "marketplace-reconciliation" ], "variable": [] }, "description": "Get aggregate marketplace settlement reconciliation using date-only YYYY-MM-DD ranges" } }, { "name": "Get waste quantities, snapshot costs, and sales-relative rates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/waste", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "waste" ], "variable": [] }, "description": "Get waste quantities, snapshot costs, and sales-relative rates" } }, { "name": "Get ledger-based on-hand and explainable replenishment availability", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/inventory-health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "inventory-health" ], "variable": [] }, "description": "Get ledger-based on-hand and explainable replenishment availability" } }, { "name": "Get explainable weekday-hour sales baselines and matured actuals", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/reports/sales-forecast", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "reports", "sales-forecast" ], "variable": [] }, "description": "Get explainable weekday-hour sales baselines and matured actuals" } } ] }, { "name": "Inventory API", "item": [ { "name": "List inventory stock items", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inventory/stock-items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "stock-items" ], "variable": [] }, "description": "List inventory stock items" } }, { "name": "Create an inventory stock item and optional opening entry; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/inventory/stock-items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "stock-items" ], "variable": [] }, "description": "Create an inventory stock item and optional opening entry; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "body": { "mode": "raw", "raw": "{\n \"storeId\": \"{{storeId}}\",\n \"name\": \"House blend beans\",\n \"unit\": \"KILOGRAM\",\n \"reorderPoint\": 5,\n \"targetLevel\": 20,\n \"openingQuantity\": 12\n}" } } }, { "name": "Get a stock item and immutable ledger", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inventory/stock-items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "stock-items", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get a stock item and immutable ledger" } }, { "name": "Update or archive stock item settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/inventory/stock-items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "stock-items", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update or archive stock item settings", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Update or archive stock item settings", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inventory/stock-items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "stock-items", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Update or archive stock item settings" } }, { "name": "Append an immutable inventory ledger entry; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/inventory/stock-items/:id/ledger", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "stock-items", ":id", "ledger" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Append an immutable inventory ledger entry; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "body": { "mode": "raw", "raw": "{\n \"reason\": \"RECEIPT\",\n \"quantityDelta\": 10,\n \"reference\": \"DELIVERY-1001\"\n}" } } }, { "name": "List immutable waste events", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inventory/waste-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "waste-events" ], "variable": [] }, "description": "List immutable waste events" } }, { "name": "Record an immutable waste event; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/inventory/waste-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "waste-events" ], "variable": [] }, "description": "Record an immutable waste event; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "body": { "mode": "raw", "raw": "{\n \"storeId\": \"{{storeId}}\",\n \"stockItemId\": \"{{stockItemId}}\",\n \"reason\": \"SPOILAGE\",\n \"quantity\": 0.5,\n \"notes\": \"Damaged during delivery\"\n}" } } }, { "name": "Get an immutable waste event and linked ledger entry", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/inventory/waste-events/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "waste-events", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Get an immutable waste event and linked ledger entry" } }, { "name": "Append an immutable reversal; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Retry-safe request key" } ], "url": { "raw": "{{baseUrl}}/api/v1/inventory/waste-events/:id/reverse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "inventory", "waste-events", ":id", "reverse" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Append an immutable reversal; requires retained Idempotency-Key header and returns 409 on mismatched reuse", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Recorded against the wrong stock item\"\n}" } } } ] } ] }