iRetail PRO store node 1.0.0-m1: catalog
4 operations
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
Operations
GET
/v1/recipes
Recipes (spec/STOCK.md, Recipes and production).
operationId
listRecipes · Permission item.read
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
product_item_id
|
query | string (uuid) |
One product's. |
Responses
POST
/v1/recipes
Add a recipe.
operationId
createRecipe · Permission production.manage
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
Idempotency-Key
|
header | string |
spec/API.md, Idempotency. |
Request body required
application/jsonRecipeWrite
Responses
PATCH
/v1/recipes/{id}
Change a recipe.
operationId
patchRecipe · Permission production.manage
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonRecipePatch
Responses
GET
/v1/items/{id}/price-split
How a quantity of the item splits into lines by batch price (spec/PRICING.md, Batch prices); nothing is held.
operationId
priceSplit · Permission item.read
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
id required
|
path | string (uuid) |
Id. |
quantity_milli required
|
query | integer (int64) |
The item's whole quantity on the receipt. |
lot
|
query | string |
A GS1 code's lot, taken first. |
Responses
Schemas
Error object
Every error response.
error required
|
string |
Stable code, see spec/API.md. |
message required
|
string |
English text for logs. |
details
|
object |
ReceiptLineBatch object
batch_id required
|
string (uuid) |
|
quantity_milli required
|
integer (int64) |
|
item_id
|
string (uuid) |
A kit line's component the batch belongs to (spec/STOCK.md, Kits). |
Component object
A kit's or a recipe's component: how much of the item (spec/STOCK.md).
item_id required
|
string (uuid) |
|
quantity_milli required
|
integer (int64) |
Recipe object
spec/STOCK.md, Recipes and production; hub-owned in a chain.
id required
|
string (uuid) |
|
product_item_id required
|
string (uuid) |
|
yield_milli required
|
integer (int64) |
|
components required
|
array of Component |
|
active required
|
boolean |
|
version required
|
integer (int64) |
RecipeWrite object
product_item_id required
|
string (uuid) |
|
yield_milli required
|
integer (int64) |
|
components required
|
array of Component |
|
active
|
boolean |
RecipePatch object
yield_milli
|
integer (int64) |
|
components
|
array of Component |
|
active
|
boolean |
PriceSplitLine object
One line of the price split (spec/PRICING.md, Batch prices).
unit_price_minor required
|
integer (int64) |
|
quantity_milli required
|
integer (int64) |
|
batches required
|
array of ReceiptLineBatch |
PriceSplit object
item_id required
|
string (uuid) |
|
lines required
|
array of PriceSplitLine |