iVendNextDevelopers Request a sandbox

Item Variant Settings

Which fields a variant item copies from its template: one record.

Area: The retailer's setup · Why it is here: recipe age_check; recipe restaurant_back_office · Fields: 3 · 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/Item%20Variant%20Settings?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/Item%20Variant%20Settings/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one, if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Item%20Variant%20Settings" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"⟨field⟩": …}'

Change one with PUT /api/resource/Item%20Variant%20Settings/⟨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

s37_age_check · s39_pharmacy_counter · s45_restaurant_back_office

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
Do not update variants on save do_not_update_variants Check
Allow Rename Attribute Value allow_rename_attribute_value Check
Fields fields Table Variant Field

Table: Variant Field

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

Field Field name Type Required Read-only Hidden Links to
Field Name field_name Autocomplete yes

All record types · What you can use

This record type in the kit