iVendNextDevelopers Request a sandbox

Loyalty Point Entry

One movement of a customer's points in iVendNext's own loyalty: earned on a sale, redeemed or expired.

Area: Loyalty · Why it is here: · Fields: 11

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/Loyalty%20Point%20Entry?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one:

curl -s "https://⟨site⟩/api/resource/Loyalty%20Point%20Entry/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one, if your app's role may:

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

Change one with PUT /api/resource/Loyalty%20Point%20Entry/⟨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.

Field Field name Type Required Read-only Hidden Links to
Loyalty Program loyalty_program Link Loyalty Program
Loyalty Program Tier loyalty_program_tier Data
Customer customer Link Customer
Invoice Type invoice_type Link DocType
Invoice invoice Dynamic Link
Redeem Against redeem_against Link Loyalty Point Entry
Loyalty Points loyalty_points Int
Purchase Amount purchase_amount Currency
Expiry Date expiry_date Date
Posting Date posting_date Date
Company company Link Company

All record types · What you can use

This record type in the kit