Retail Desk Action

A button on a form or a list that calls your service. A manifest installs it.

Area: Your app: its install, its user and its doors · Why it is here: contract desk_action; recipe call_centre_orders; recipe desk_action; recipe expiry_markdown · Fields: 15

iVendNext's own description: A partner's button on a Desk form or list: who sees it, when, what it asks and which fields it sends. System Manager only.

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%20Desk%20Action?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one, with its tables:

curl -s "https://⟨site⟩/api/resource/Retail%20Desk%20Action/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Retail%20Desk%20Action" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"record_type": …, "label": …, "placement": …, "service": …, "roles": …, "send_fields": …}'

Change one with PUT /api/resource/Retail%20Desk%20Action/⟨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

s16_pick_route · s28_merge_and_history · s35_call_centre_orders · s38_expiry_markdown · s44_lucky_draw · s45_restaurant_back_office · s49_post_sale_feedback

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	Links to
Record type	`record_type`	Link	yes	DocType
Label	`label`	Data	yes
Menu	`group`	Data
Enabled	`enabled`	Check
Shown on	`placement`	Select	yes	one of: form, list, both
Partner service	`service`	Link	yes	Retail Extension Subscription
Roles	`roles`	Table MultiSelect	yes	Has Role
On a draft	`on_draft`	Check
On a submitted record	`on_submitted`	Check
On a cancelled record	`on_cancelled`	Check
Only in these states	`states`	Small Text
Only when	`conditions`	Table		Retail Save Rule Condition
Inputs	`inputs`	Table		Retail Desk Action Input
Confirm sentence	`confirm_text`	Data
Fields sent	`send_fields`	Small Text	yes

Table: Has Role

The rows of roles. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Read-only	Hidden	Links to
Role	`role`	Link				Role

Table: Retail Desk Action Input

The rows of inputs. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Links to
Field name	`fieldname`	Data	yes
Label	`label`	Data	yes
Type	`fieldtype`	Select	yes	one of: Data, Int, Float, Date, Select, Link, Check, Small Text
Options	`options`	Small Text
Required	`reqd`	Check
Default	`default`	Data

Table: Retail Save Rule Condition

The rows of conditions. Each row also has idx (its place), parent, parentfield and parenttype.

Field	Field name	Type	Required	Links to
Field	`field`	Data	yes
Operator	`operator`	Select	yes	one of: =, !=, >, >=, <, <=, is set, is not set, in
Value	`value`	Data

All record types · What you can use

This record type in the kit