iRetail PRO store node 1.0.0-m1: holds
4 operations
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
Operations
GET
/v1/holds
Active hard holds.
operationId
listHolds · Permission stock.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). |
item_id
|
query | string (uuid) |
Only this item. |
Responses
POST
/v1/holds
Place a hard hold (spec/STOCK.md).
operationId
createHold · Permission stock.hold
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. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Request body required
application/jsonHoldCreate
Responses
POST
/v1/holds/{id}/extend
Extend a hold by the store's TTL.
operationId
extendHold · Permission stock.hold
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. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
Responses
DELETE
/v1/holds/{id}
Release a hold.
operationId
releaseHold · Permission stock.hold
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. |
Approval-Token
|
header | string |
One-time approval from POST /v1/approvals for this operation's permission. |
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 |
Hold object
id required
|
string (uuid) |
|
item_id required
|
string (uuid) |
|
quantity_milli required
|
integer (int64) |
|
workplace_id required
|
string (uuid) | null |
|
expires_at required
|
string (date-time) |
|
split
|
array of PriceSplitLine |
The item's price split for the quantity held, when its batches carry prices of their own (spec/PRICING.md). |
HoldCreate object
item_id required
|
string (uuid) |
|
quantity_milli required
|
integer (int64) |
At most 10^12 (spec/API.md, Payments; 422 amount_too_large). |
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). |
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 |