Retail List Mark

A coloured label on rows of a Desk list. A manifest installs it.

Area: Your app: its install, its user and its doors · Why it is here: card products-on-promotion-colour; contract list_mark; guide chapter 07 · Fields: 6

iVendNext's own description: A coloured label on a Desk list row, shown when a record's fields match. 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%20List%20Mark?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%20List%20Mark/⟨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%20List%20Mark" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"record_type": …, "label": …, "colour": …, "conditions": …}'

Change one with PUT /api/resource/Retail%20List%20Mark/⟨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.

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.

Table: Retail Save Rule Condition

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

All record types · What you can use

This record type in the kit