Gift Card
One gift card by its number, with its balance and expiry. Read a card's balance with get_gift_card_status.
Area: Gift cards · Why it is here: recipe gift_card_on_spend; retail core · Fields: 18
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/Gift%20Card?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Gift%20Card/⟨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/Gift%20Card" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"serial_number": …, "item_code": …}'
Change one with PUT /api/resource/Gift%20Card/⟨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.
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 |
|---|---|---|---|---|---|---|
| First Name | first_name |
Data | ||||
| Serial Number | serial_number |
Data | yes | |||
| Item | item_code |
Link | yes | Item | ||
| Expiry Days | expiry_days |
Int | yes | yes | ||
| Total | total |
Currency | ||||
| Balance | balance |
Currency | ||||
| Expiry Date | expiry_date |
Date | ||||
| Gift Card Type | gift_card_type |
Data | yes | |||
| Cashback | cashback |
Check | yes | |||
| Use as Store Credit | use_as_store_credit |
Check | yes | |||
| Expired | expired |
Check | yes | |||
| Recharge | recharge |
Check | yes | |||
| Allow Multiple Redemptions | allow_multiple_redemptions |
Check | yes | |||
| POS Invoice | pos_invoice |
Link | yes | POS Invoice | ||
| Posting Date | posting_date |
Date | yes | |||
| POS Invoice Item | pos_invoice_item |
Data | yes | |||
| Store Credit Sales Invoice Payment | store_credit_sales_invoice_payment |
Data | yes | |||
| Warehouse | warehouse |
Link | yes | Warehouse |