Loyalty Journal
One movement of a customer's loyalty points: earned, spent or expired.
Area: Loyalty · Why it is here: retail core · 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%20Journal?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%20Journal/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: the loyalty app writes it from each sale. 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 | yes | yes | Loyalty Setup | |
| Customer | customer |
Link | yes | yes | Customer | |
| Transaction Type | transaction_type |
Link | yes | yes | DocType | |
| Transaction Id | transaction_id |
Dynamic Link | yes | yes | ||
| Redeem Against | redeem_against |
Data | yes | |||
| Loyalty Points | loyalty_points |
Float | yes | yes | ||
| Expiry Date | expiry_date |
Date | yes | yes | ||
| Posting Date | posting_date |
Date | yes | yes | ||
| Company | company |
Link | yes | Company | ||
| Referral Setup Key | referral_setup_key |
Data | yes | |||
| Referral Customer | referral_customer |
Data | yes |