Get customer discount

Deprecated

POST

/api

Last modified:2024-08-14 15:35:25

To get the customer discount (including the discount coming from the purchases), it's necessary to make a POST call, passing a JSON body as specified below.

The web service response will be a JSON object with the same structure as the one returned by the insertion/update services.

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

Field	Description	Type	Mandatory
cardsRecords	Array of card records	Array of objects	✓

Each card record is composed as follows:

Field	Description	Type	Mandatory
cardBarcode	Barcode of the customer card	Text	✓
receiptDate	The discount will be calculated up to the provided date (format YYYY-MM-DD)	Date	✓

At least one of the above fields must be specified

A response example is:

    {
      "success": true,
      "discountObjects": [
        {
          "discount": 15,
          "discountType": "P"
        }
      ]
    }

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

{
    "cardsRecords": [
        {
            "cardBarcode": "9999997298594",
            "receiptDate": "2019-10-25"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api?cmd=getDiscount_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 '{
    "cardsRecords": [
        {
            "cardBarcode": "9999997298594",
            "receiptDate": "2019-10-25"
        }
    ]
}'

Responses

🟢200Get Cliente - Success

text/html

Example

{"subjects":{"progId":58297,"subjectCode":"58297","subjectName":"Luca","subjectSurname":"Biasotto","address1":"via Comunale di Camino 22/D","state":"E","latitude":"45.7919099","longitude":"12.4961486","mobile":"F","mobileCreation":"F","isCompany":"F","validData":"T","ecommerceGuestRegister":"F","foreignPerson":"F","subjectType":"CUSTOMER","subjectSubtype":"4","country":"IT","language":"IT"},"contacts":[{"contactType":"EMAIL","value":"luca.biasotto@sinesy.it"},{"contactType":"PHONE","value":"555555555566"}],"cards":[{"cardType":"FID","cardSubtype":"2","circuit":"SINESY","card":"778899","cardBarcode":"778899","active":"T","issueDate":"2017-06-19 00:00:00","activationDate":null,"expirationDate":null,"cardMaster":null,"cardFather":null,"cardMother":null,"entityCode":null,"earnedPoints":22}],"mappings":[{"system":"SHOP","externalCode":"99887773"}]}

🟠422Unique constraint error

Modified at 2024-08-14 15:35:25

Get subject data

Insert/Update customer