Retail Override Request
A request for a manager to let a save past a rule, and the answer.
Area: Your app: its install, its user and its doors · Why it is here: recipe till_guard · Fields: 29
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Retail%20Override%20Request?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Retail%20Override%20Request/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one, if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Retail%20Override%20Request" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"⟨field⟩": …}'
Change one with PUT /api/resource/Retail%20Override%20Request/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s18_rule_guard · s23_till_guard
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Request Type | request_type |
Select | yes | one of: Markdown, Discount Stack, Open Price, Void Line, No-Receipt Return, Sale Discount, Action, Item Return, Transaction Approval, Lot Approval | ||
| Requested By | requested_by |
Link | yes | yes | User | |
| Requester Cap | requester_cap |
Percent | yes | |||
| Outlet | outlet |
Link | yes | POS Profile | ||
| Store | store |
Link | yes | Warehouse | ||
| Basket Line Index | line_index |
Int | yes | |||
| Sale Reference | sale_ref |
Data | yes | |||
| Approved Right | capability |
Data | yes | |||
| Approved Action | verb |
Data | yes | |||
| Status | status |
Select | yes | one of: Pending, Approved, Denied, Expired, Superseded, Consumed | ||
| Expires On | expires_on |
Datetime | yes | |||
| Request Reason | request_reason |
Data | yes | |||
| Item | item_code |
Link | yes | Item | ||
| Item Name | item_name |
Data | yes | |||
| Qty | qty |
Float | yes | |||
| Requested % | requested_pct |
Percent | yes | |||
| Line Amount | line_amount |
Currency | yes | |||
| Discount Value | discount_value |
Currency | yes | |||
| Currency | currency |
Link | yes | Currency | ||
| Basket Lines | basket_line_count |
Int | yes | |||
| Basket Total | basket_total |
Currency | yes | |||
| Resolved Approver | resolved_approver |
Link | yes | User | ||
| Resolved On | resolved_on |
Datetime | yes | |||
| Decision Surface | decision_surface |
Select | yes | one of: Remote, In-person | ||
| Deny Reason | deny_reason |
Small Text | yes | |||
| Superseded By | superseded_by |
Link | yes | Retail Override Request | ||
| Consumed On | consumed_on |
Datetime | yes | |||
| Consumed By Invoice | consumed_invoice |
Data | yes | |||
| Basket Snapshot | basket_snapshot |
Code | yes |