iVendNextDevelopers Request a sandbox

Retail Scan Source

A table the till's scan reads when a code is not an item, a serial or a lot.

Area: Your app: its install, its user and its doors · Why it is here: contract scan_source; recipe unit_codes · Fields: 12

iVendNext's own description: Maps a unit's own code to an item, a batch and a status. The till reads it when a scanned code is not a barcode. 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%20Scan%20Source?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%20Scan%20Source/⟨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%20Scan%20Source" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"source_name": …, "record_type": …, "barcode_field": …, "item_from": …}'

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

s19_unit_codes · s30_units_as_serials

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
Source name source_name Data yes
Record type record_type Link yes DocType
Code field barcode_field Data yes
Enabled enabled Check
Sequence sequence Int
Record the code as capture_as Link Transaction Item Attribute
Item field item_from Data yes
Batch field batch_from Data
Serial field serial_from Data
Status field status_field Data
Sellable statuses available_values Small Text
Warehouse field warehouse_field Data

All record types · What you can use

This record type in the kit