Retail Extension Package
Your manifest as the retailer installs it: the summary, the consent and the version.
Area: Your app: its install, its user and its doors · Why it is here: guide chapter 07; guide chapter 08; guide chapter 14a; recipe approvals; recipe manifest · Fields: 28
iVendNext's own description: A partner's app, one version per record. Check, consent, install; later update or remove.
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%20Package?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%20Package/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: the retailer's administrator installs your manifest on it, with consent. All the record calls and their answers: the API reference.
Samples that use it
s1_warranty · s2_bins · s3_price_audit · s4_receipt_pack · s11_approvals · s14_approvals_stores · s23_till_guard · s32_coupon_rules · s34_po_check · s36_duty_free · s37_age_check · s39_pharmacy_counter · s46_payment_method_rules · s47_customers_by_store · s48_customer_code_check · s49_post_sale_feedback · s50_required_sale_details · s51_refund_rules
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 |
|---|---|---|---|---|---|---|
| The partner's file (manifest.json) | manifest |
Code | ||||
| Status | status |
Select | yes | one of: Draft, Refused, Checked, Queued, Installing, Installed, Upgrading, Upgrade Failed, Failed, Superseded, Uninstalling, Uninstalled | ||
| App | app |
Data | yes | |||
| Version | version |
Data | yes | |||
| Publisher | publisher |
Data | yes | |||
| Title | package_title |
Data | yes | |||
| Name prefix | prefix |
Data | yes | |||
| Last action | job_action |
Select | yes | one of: install, upgrade, uninstall | ||
| Refused because | refusals |
Long Text | yes | |||
| What it will do | summary |
Long Text | yes | |||
| What changes from the installed version | changes |
Long Text | yes | |||
| Consented by | consent_by |
Link | yes | User | ||
| Consented on | consent_on |
Datetime | yes | |||
| What went wrong | error |
Small Text | yes | |||
| Before each part works | todo |
Long Text | yes | |||
| Hosted app | connection |
Small Text | yes | |||
| Installed, updated or removed by | installed_by |
Link | yes | User | ||
| Export | export_file |
Attach | yes | |||
| Undo not finished | undo_pending |
Check | yes | |||
| Fingerprint of "What it will do" (SHA-256) | summary_sha256 |
Data | yes | |||
| What it will do, in plain words | summary_parts |
Long Text | yes | yes | ||
| What it needs from you after installing | check_warnings |
Long Text | yes | yes | ||
| Fingerprint of the partner's file (SHA-256) | manifest_sha256 |
Data | yes | |||
| App library key | library_key |
Small Text | yes | |||
| Shelf app's own key | app_key |
Password | yes | yes | ||
| Fingerprint of "What it will do" you consented to (SHA-256) | consent_summary_sha256 |
Data | yes | |||
| Fingerprint of the partner's file you consented to (SHA-256) | consent_manifest_sha256 |
Data | yes | |||
| Saved forms | saved_forms |
Long Text | yes | yes |