Retail Extension Log
One call to your service at an extension point: when, what it answered, and how long it took.
Area: Your app: its install, its user and its doors · Why it is here: contract desk_action; contract doccheck; contract partner_capture; contract partner_check; guide chapter 09; recipe document_check · Fields: 20
iVendNext's own description: One row per partner call that matters. Written by iVendNext only, never edited. Cleared after 90 days by Log Settings.
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%20Log?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%20Log/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: iVendNext writes it for each call to your service. All the record calls and their answers: the API reference.
Samples that use it
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 |
|---|---|---|---|---|---|---|
| Extension point | point |
Data | yes | |||
| Outcome | outcome |
Select | yes | one of: answered, answer refused, timeout, unreachable, not called offline, down answer, drained, refused, booked after payment, no answer, not asked | ||
| Flagged | flagged |
Check | yes | |||
| Verdict | verdict |
Data | yes | |||
| Subscription | subscription |
Link | yes | Retail Extension Subscription | ||
| POS Profile | pos_profile |
Link | yes | POS Profile | ||
| Sale number | sale_ref |
Data | yes | |||
| Record type | reference_doctype |
Link | yes | DocType | ||
| Record | reference_name |
Data | yes | |||
| Records | reference_names |
Small Text | yes | |||
| Request id | request_id |
Data | yes | |||
| Time taken (ms) | latency_ms |
Int | yes | |||
| Mode of payment | mode_of_payment |
Link | yes | Mode of Payment | ||
| Limit (smallest unit, e.g. cents) | cap_minor |
Int | yes | |||
| Confirmed | confirmed |
Check | yes | |||
| Approver | approver |
Link | yes | User | ||
| Sale attempt key | idempotency_key |
Data | yes | |||
| Check answer | check_answer |
Select | yes | one of: allow, refuse, ask, approve, fill | ||
| Basket fingerprint | fingerprint |
Data | yes | |||
| Tenders taken off the sheet | exclude_tenders |
Small Text | yes |