Get giftcard

Deprecated

POST

/api

Last modified:2024-08-14 15:38:11

To retrieve a card, it's necessary to make a POST call, passing a JSON body as specified below.

This is the list of fields that can be passed in the request body:

Field	Description	Type	Mandatory
cardBarcode	Barcode for the card to be searched	String	✓

Response example

[{
    progId: 21,
    companyId: "DEMO1",
    siteId: 500,
    cardBarcode: "0093799361353",
    issueDate: "2016-04-11 00:00:00",
    active: "T",
    activationDate: "2016-04-11 00:00:00",
    expirationDate: "2017-04-11 00:00:00",
    cardValue: 200,
    userIdCreate: "ADMIN",
    createDate: "2017-05-03 09:05:42",
    userIdUpdate: "ADMIN",
    lastUpdate: "2017-05-04 15:39:26",
    dataSource: null,
    rowVersion: 0,
    status: "E",
    giftcardsStatus: "1",
    country: "IT",
    valueBalance : 100
}]

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{  
	"cardBarcode": 0093799361353
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api?cmd=getGift_v3&appId=KEEPIT&applicationId=KEEPIT' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{  
	"cardBarcode": 0093799361353
}'

Responses

🟢200Get giftcard - Success

application/json

Body

Example

[
    {
        "progId": 21,
        "companyId": "DEMO1",
        "siteId": 500,
        "cardBarcode": "0093799361353",
        "issueDate": "2016-04-11 00:00:00",
        "active": "T",
        "activationDate": "2016-04-11 00:00:00",
        "expirationDate": "2017-04-11 00:00:00",
        "cardValue": 200,
        "userIdCreate": "ADMIN",
        "createDate": "2017-05-03 09:05:42",
        "userIdUpdate": "ADMIN",
        "lastUpdate": "2017-05-04 15:39:26",
        "dataSource": null,
        "rowVersion": 0,
        "status": "E",
        "giftcardsStatus": "1",
        "country": "IT",
        "valueBalance": 100
    }
]

🟢200Update Code - Fail

🟢200Update Code - Success

🟠422Unique constraint error

Modified at 2024-08-14 15:38:11

Insert CRM user

Insert/Update giftcards