Retail Extension Module

A certified sandboxed module at an extension point. A manifest installs it.

Area: Your app: its install, its user and its doors · Why it is here: contract partner_check; contract price; guide chapter 07; guide chapter 08; guide chapter 09; recipe configure_no_code; recipe manifest · Fields: 13

iVendNext's own description: A partner's small program that does one job (one extension point). One version per record.

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%20Extension%20Module?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%20Extension%20Module/⟨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%20Extension%20Module" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"point": …, "partner_name": …, "version": …, "module_file": …, "certificate": …}'

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

All record types · What you can use

This record type in the kit