Retail Coupon Draw
A draw of coupon codes from a coupon, made for a campaign.
Area: Coupons and promotions · Why it is here: guide chapter 07 · Fields: 11 · Submitted (booked) records: send docstatus: 1 to book it as you create it, or submit a draft with submit.
iVendNext's own description: A draw of the winning coupon(s) a campaign issued in a period, picked fairly at submit and recorded.
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%20Coupon%20Draw?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Retail%20Coupon%20Draw/⟨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%20Coupon%20Draw" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"coupon": …, "from_date": …, "to_date": …, "number_of_winners": …}'
Change one with PUT /api/resource/Retail%20Coupon%20Draw/⟨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 |
|---|---|---|---|---|---|---|
| Coupon | coupon |
Link | yes | Coupon | ||
| From | from_date |
Date | yes | |||
| To | to_date |
Date | yes | |||
| Number of winners | number_of_winners |
Int | yes | |||
| Coupons drawn from | entries_count |
Int | yes | |||
| Random source | random_source |
Data | yes | |||
| Entries digest | entries_digest |
Data | yes | |||
| Drawn by | drawn_by |
Link | yes | User | ||
| Drawn on | drawn_on |
Datetime | yes | |||
| Winners | winners |
Table | yes | Retail Coupon Draw Winner | ||
| Amended From | amended_from |
Link | yes | Retail Coupon Draw |
Table: Retail Coupon Draw Winner
The rows of winners. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Rank | rank |
Int | yes | |||
| Serial number | serial_number |
Data | yes | |||
| Customer | customer |
Link | yes | Customer | ||
| Issuing sale | issuing_sale |
Link | yes | POS Invoice | ||
| Sale date | posting_date |
Date | yes | |||
| Position in the drawn-from list | position |
Int | yes |