Returns the vouchers that are still active and that have been activated in the indicated period startDate - endDate.

NB: returns only the vouchers active in the indicated period.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful or not

moreRows: Boolean that indicated wether the are more rows to be retrieved or not

valueObjectList: Array of customer voucher

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Pagination

The request returns a maximum of 20 elements in the valueObjectList array. If moreRows is true, then you can request the next 20 elements by appending the query parameter &start=X on the request URL, where X is the first element to be retrieved.

For example, the first request returns 20 elements and moreRows is true. You can then make a new call to the web service, appending &start=20 on the URL to get the records from 21 to 40.

Fields

Voucher

Field	Description	Type
id	Voucher id	String
barcode	Voucher barcode	String
totalAmount	Voucher amount	Number
documentType	Document type	String
cause	Document cause	String
documentStatus	OPEN=voucher not used, CLOSE=voucher spent	String
branchCode	Branch code	Number
branchDescription	Branch description	String
cardBarcode	Customer fidelity card	String
clientCode	Customer code	String
clientIdKeepit	KeepIT subject id	String
subjectDenomination	Subject denomination	String
confirmationDateOrder	Validity start date with format "yyyy-MM-dd HH:mm:ss", using GMT time	String
endValidity	End validity data with format "yyyy-MM-dd HH:mm:ss", using GMT time	String
currency	Currency (ex EUR)	String
currencySymbol	Currency symbol	String
sellerCode	Seller code	String
sellerDescription	Seller description	String

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get voucher - success

application/json

Body

Example

{
    "success": true,
    "valueObjectList": [
        {
            "id": "502eddd9-0178-49d3-b7a7-18e8850f1c25",
            "barcode": "FAKE-123456",
            "totalAmount": 10,
            "documentType": "LOALTY",
            "cause": "VOUCHER",
            "documentStatus": "ACTIVE",
            "branchCode": 1001,
            "branchDescription": "TEST - MILANO SAN BABILA",
            "cardBarcode": "0099000001209",
            "clientCode": "31031989",
            "clientIdKeepit": "31031989",
            "subjectDenomination": "Biasotto Luca",
            "confirmationDateOrder": "2020-02-06 13:22:19",
            "endValidity": "2020-12-31 00:00:00",
            "currency": "EUR",
            "currencySymbol": "€",
            "sellerCode": "1001",
            "sellerDescription": "Marco Bianchi"
        },
        {
            "id": "8abe6b18-d81a-468f-b4dd-5de54d4956db",
            "barcode": "FAKE-123456",
            "totalAmount": 10,
            "documentType": "LOYALTY",
            "cause": "VOUCHER",
            "documentStatus": "ACTIVE",
            "branchCode": 1001,
            "branchDescription": "TEST - MILANO SAN BABILA",
            "cardBarcode": "0099000001209",
            "clientCode": "31031989",
            "clientIdKeepit": "31031989",
            "subjectDenomination": "Biasotto Luca",
            "confirmationDateOrder": "2020-02-06 13:22:19",
            "endValidity": "2020-12-31 00:00:00",
            "currency": "EUR",
            "currencySymbol": "€",
            "sellerCode": "1001",
            "sellerDescription": "Marco Bianchi"
        },
        {
            "id": "9ea137e7-24a4-4a8c-836f-6aa92cdc70f7",
            "barcode": "FAKE-123456",
            "totalAmount": 10,
            "documentType": "LOYALTY",
            "cause": "VOUCHER",
            "documentStatus": "ACTIVE",
            "branchCode": 1001,
            "branchDescription": "TEST - MILANO SAN BABILA",
            "cardBarcode": "0099000001209",
            "clientCode": "31031989",
            "clientIdKeepit": "31031989",
            "subjectDenomination": "Biasotto Luca",
            "confirmationDateOrder": "2020-02-06 13:22:19",
            "endValidity": "2020-12-31 00:00:00",
            "currency": "EUR",
            "currencySymbol": "€",
            "sellerCode": "1001",
            "sellerDescription": "Marco Bianchi"
        },
        {
            "id": "ac35f63f-eefc-46ba-a149-b46cc5adbd26",
            "barcode": "FAKE-123456",
            "totalAmount": 10,
            "documentType": "LOYALTY",
            "cause": "VOUCHER",
            "documentStatus": "ACTIVE",
            "branchCode": 1001,
            "branchDescription": "TEST - MILANO SAN BABILA",
            "cardBarcode": "0099000001209",
            "clientCode": "31031989",
            "clientIdKeepit": "31031989",
            "subjectDenomination": "Biasotto Luca",
            "confirmationDateOrder": "2020-02-06 13:22:19",
            "endValidity": "2020-12-31 00:00:00",
            "currency": "EUR",
            "currencySymbol": "€",
            "sellerCode": "1001",
            "sellerDescription": "Marco Bianchi"
        },
        {
            "id": "e7854e9b-e3d1-4271-80b0-b62a2b862cf3",
            "barcode": "FAKE-123456",
            "totalAmount": 10,
            "documentType": "LOYALTY",
            "cause": "VOUCHER",
            "documentStatus": "ACTIVE",
            "branchCode": 1001,
            "branchDescription": "TEST - MILANO SAN BABILA",
            "cardBarcode": "0099000001209",
            "clientCode": "31031989",
            "clientIdKeepit": "31031989",
            "subjectDenomination": "Biasotto Luca",
            "confirmationDateOrder": "2020-04-20 09:36:03",
            "endValidity": "2020-12-31 00:00:00",
            "currency": "EUR",
            "currencySymbol": "€",
            "sellerCode": "1001",
            "sellerDescription": "Marco Bianchi"
        },
        {
            "id": "f9483c8b-ecac-4569-b3e0-df5c3ad6fe7f",
            "barcode": "FAKE-123456",
            "totalAmount": 10,
            "documentType": "LOYALTY",
            "cause": "VOUCHER",
            "documentStatus": "ACTIVE",
            "branchCode": 1001,
            "branchDescription": "TEST - MILANO SAN BABILA",
            "cardBarcode": "0099000001209",
            "clientCode": "31031989",
            "clientIdKeepit": "31031989",
            "subjectDenomination": "Biasotto Luca",
            "confirmationDateOrder": "2020-02-06 13:22:19",
            "endValidity": "2020-12-31 00:00:00",
            "currency": "EUR",
            "currencySymbol": "€",
            "sellerCode": "1001",
            "sellerDescription": "Marco Bianchi"
        }
    ],
    "moreRows": false
}

🟠422Unique constraint error

Get loyalty vouchers at a time interval

Actors#

Pagination#

Fields#