Retail Setting

The till's settings for the whole site: one record.

Area: The retailer's setup · Why it is here: card staff-discount-monthly-allowance; guide chapter 04; recipe configure_no_code · Fields: 73 · One record (a settings record): read it at its own name.

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%20Setting?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%20Setting/⟨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%20Setting" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"⟨field⟩": …}'

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

s5_config_pack · s8_estate_rollout

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.

All record types · What you can use

This record type in the kit