Handleiding i-Reserve - API - Gift

Home Functionele informatie Beschikbare API's API-Gift

Documentatie

Moeilijkheidsgraad:

Deze sectie is alleen van toepassing indien de module Kadobon actief is.

POST gift/validate

Gebruikt voor

Controleren van een kadobon code.
Er kunnen maximaal 10 kadobonnen tegelijk worden gevalideerd.
Indien een kadobon ongeldig is, wordt dit via teruggeven door het attribuut valid op false te zetten.
Indien een kadobon geldig is, wordt een lijst met kenmerkern meegegeven, waaronder een kortingsprijs (price) òf percentage.
Functioneel: een kadobon met een percentage wordt ook wel kortingsbon genoemd.

Authenticatie

Gebruiker dient ingelogd te zijn op beheerdersniveau.

Parameters

Parameter	Omschrijving	Verplicht	Voorbeeld
voucher	Lijst van kadobonnen of losse kadobon	Ja	["VOUCHER1", "VOUCHER2"]] of "VOUCHER1"
product_id	Product ID waarvoor de kadobon gebruikt gaat worden Indien niet opgegeven dient een com_id te worden opgegeven.	Nee	1
com_id	Arrangement ID waarvoor de kadobon gebruikt gaat worden. Indien niet opgegeven dient een product_id te worden opgegeven.	Nee	2

Response codes

200 OK

Voorbeeld

Valideer kadobon codes VALIDVOUCHER1, VALIDVOUCHER2 en INVALIDVOUCHER voor product 1.

POST api/rest/gift/validate/

Request: 
{
  "voucher": ["VALIDVOUCHER1","VALIDVOUCHER2","INVALIDVOUCHER"],
  "product_id": 1
}
Response: 
{
  "VALIDVOUCHER1": {
    "valid": true,
    "validtill": "2024-11-30T00:00:00+0100",
    "percentage": 100,
    "price": "0",
    "currency": "EUR",
    "product_id": "1",
    "combi_id": "0"
  },
  "VALIDVOUCHER2": {
    "valid": true,
    "validtill": "2018-05-31T00:00:00+0200",
    "percentage": 0,
    "price": "10",
    "currency": "EUR",
    "product_id": "1",
    "combi_id": "0"
  },
  "INVALIDVOUCHER": {
    "valid": false
  }
}