To validate a giftcart it's necessary to make a GET call passing the barcode in the request.

The web service response will be composed of:

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

giftcard: If giftcard is valid contains the giftcard data

Actors

API Client: The system or user initiating the request.

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

Fields

Giftcard

Field	Description	Type
id	VILU_500_440_2000000001814	String
companyId	company id	String
siteId	ite id	number
branchCode	branch code	String
entityCode	enty code	String
cardBarcode	giftcard barcode, ex: 2000000001814	String
issueDate	isseu date, ex: 2021-10-04 00:00:00	String
activationDate	activate date, ex 2021-10-04 00:00:00	String
expirationDate	expiration date, ex: 2021-06-01 00:00:00	String
flgActive	Y/N, Y if giftcard is active	String
priceList	price list	String
priceListType	price list type	String
decimalNumber	giftcard decimal number	String
currencySymbol	currency symbol, ex: €	String
currency	currency code, ex: EUR	String
originalAmount	original giftcard amount	number
amount	current giftcard amount	String
itemType	item type	String
itemSubtype	item subtype	String
itemCode	item code	String
taxRate	tax rate	number
vatCode	vat code	String
printerDepartmentCode	printer department code	String
flgNetworkUsage	enable network Usage Y/N	String
flgPartiallyUsage	enable partially usage Y/N	String
paymentTermCode	01	String
flgAllowOfflineUsage	enable allow offline usage Y/N	String
taxation	taxation, ex:RT,XM7	String

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get Giftcard (GAE Call) - success response

application/json

Body

Example

{
    "success": true,
    "giftcard": {
        "id": "SVILU_500_440_2000000001814",
        "companyId": "SVILU",
        "siteId": 500,
        "branchCode": 1,
        "entityCode": 440,
        "cardBarcode": "2000000001814",
        "issueDate": "2021-10-04 00:00:00",
        "activationDate": "2021-10-04 00:00:00",
        "expirationDate": "2021-11-04 00:00:00",
        "flgActive": "Y",
        "priceList": "1",
        "priceListType": "V",
        "decimalNumber": 2,
        "currencySymbol": "€",
        "currency": "EUR",
        "originalAmount": 390,
        "amount": 390,
        "itemType": "FINANCIAL",
        "itemSubtype": "GIFTCARD",
        "itemCode": "GF440VP15_400_3",
        "taxRate": 21,
        "vatCode": 3,
        "printerDepartmentCode": 1,
        "flgNetworkUsage": "Y",
        "flgPartiallyUsage": "Y",
        "paymentTermCode": 201,
        "flgAllowOfflineUsage": "N",
        "taxation": ""
    }
}

🟠422Unique constraint error

Get Giftcard

Actors#

Fields#

Giftcard#

Request

Request Code Samples

Responses

Actors

Fields

Giftcard