iRetail PRO store node 1.0.0-m1: pricing
6 operations
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
Operations
POST
/v1/pricing/proposals
Prices proposed from the last receiving cost by a markup rule (spec/PRICING.md). Writes nothing.
operationId
proposePrices · Permission price.edit
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). |
Request body required
application/jsonPriceProposalRequest
Responses
-
200OKPriceProposals -
400Error (spec/API.md).Error -
401Error (spec/API.md).Error -
403Error (spec/API.md).Error -
422Error (spec/API.md).Error
GET
/v1/expiry-rules
Expiry rules (spec/PRICING.md, Expiry rules).
operationId
listExpiryRules · 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). |
Responses
-
200OKarray of ExpiryRule -
401Error (spec/API.md).Error -
403Error (spec/API.md).Error
POST
/v1/expiry-rules
Add an expiry rule.
operationId
createExpiryRule · Permission expiry.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/jsonExpiryRuleWrite
Responses
PATCH
/v1/expiry-rules/{id}
Change an expiry rule.
operationId
patchExpiryRule · Permission expiry.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/jsonExpiryRulePatch
Responses
DELETE
/v1/expiry-rules/{id}
Delete an expiry rule.
operationId
deleteExpiryRule · Permission expiry.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. |
Responses
POST
/v1/expiry-rules/run
Run today's expiry rules if they have not run; answers the day's documents either way.
operationId
runExpiryRules · Permission expiry.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). |
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 |
PriceProposalRequest object
Either item_ids or group_id.
item_ids
|
array of string (uuid) |
|
group_id
|
string (uuid) |
|
markup_ppm required
|
integer |
|
round_to_minor
|
integer |
|
ending_minor
|
integer | null |
|
ending_base
|
integer | null |
PriceProposals object
lines required
|
array of object |
ExpiryStep object
days_before required
|
integer |
|
rate_ppm required
|
integer |
ExpiryRule object
spec/PRICING.md, Expiry rules; hub-owned in a chain.
id required
|
string (uuid) |
|
item_ids required
|
array of string (uuid) |
|
group_ids required
|
array of string (uuid) |
|
markdowns required
|
array of ExpiryStep |
|
auto_post required
|
boolean |
|
write_off_expired required
|
boolean |
|
round_to_minor required
|
integer |
|
ending_minor required
|
integer | null |
|
ending_base required
|
integer | null |
|
active required
|
boolean |
|
version required
|
integer (int64) |
ExpiryRuleWrite object
item_ids
|
array of string (uuid) |
|
group_ids
|
array of string (uuid) |
|
markdowns required
|
array of ExpiryStep |
|
auto_post
|
boolean |
|
write_off_expired
|
boolean |
|
round_to_minor
|
integer |
|
ending_minor
|
integer | null |
|
ending_base
|
integer | null |
|
active
|
boolean |
ExpiryRulePatch object
item_ids
|
array of string (uuid) |
|
group_ids
|
array of string (uuid) |
|
markdowns
|
array of ExpiryStep |
|
auto_post
|
boolean |
|
write_off_expired
|
boolean |
|
round_to_minor
|
integer |
|
ending_minor
|
integer | null |
|
ending_base
|
integer | null |
|
active
|
boolean |
ExpiryRun object
The documents a day's expiry run made.
business_date required
|
string (date) |
|
ran_at required
|
string (date-time) |
|
price_change_ids required
|
array of string (uuid) |
|
write_off_id required
|
string (uuid) | null |