iVendNextDevelopers Request a sandbox

Gift Card Master

A kind of gift card the retailer sells: its value, validity and rules.

Area: Gift cards · Why it is here: retail core · Fields: 14

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%20Master?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%20Master/⟨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%20Master" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"gift_id": …, "item_group": …, "gift_card_type": …}'

Change one with PUT /api/resource/Gift%20Card%20Master/⟨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
Id gift_id Data yes
Description description Data
Item Group item_group Link yes Item Group
Price price Currency
Gift Card Type gift_card_type Select yes one of: System Generated, User Defined
Validity Period (Days) validity_period Int
Barcode barcode Data
Print Format print_format Link Print Format
Use as Store Credit use_as_store_credit Check
Cashback cashback Check
On Hold on_hold Check
Open Price change_price Check
Must Swipe Card must_swipe_card Check
Allow Multiple Redemptions allow_multiple_redemptions Check

All record types · What you can use

This record type in the kit