Calculate and Insert/Update Points

To insert or update customers fidelity card points, it's necessary to make a POST call, passing a JSON body as specified below.
The difference with Insert/Update points is that this WS also calculates the amount of points to add, based on a sale document.

The web service response will be composed of:

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

code : HTTP Code for the response

200 means the request was correctly processed

204 means a duplicate record was found in KeepIT, and that no insertion was performed

206 means that not all records were inserted or processed

400 means that the request body is invalid or contains syntax errors

500 means a server error has happened

message: response message for the request (e.g. "Insertion successful" or "Missing required parameter")

errorObjects: Array that contains the objects that caused errors when processed

entityCode : store code specified in the JSON request

documentDate : document date specified in the JSON request

refDocument: reference document specified in the JSON request

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

Field	Description	Type	Mandatory
goods	Object	See below for the the object structure	✓

goods structure

goods: {
    entityCode: 6,
    documentDate: "2016-04-05 00:00:00",
    refDocument: 98,
    currency: "EUR",
    totalAmount: 666.00,
    system: "ECOMMERCE",
    customerCode: "12345",
    card: null,
    cardBarcode: null,
    pointsMultiplier: 2.0,
    spentPoints: 100
}

Response example

{
    success: true,
    code: 200,
    message: "Insert/update successful",
    errorObjects: []
}

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

{
    "goods": {
        "entityCode": 6,
        "documentDate": "2016-04-05 00:00:00",
        "refDocument": 98,
        "causal": "SALE",
        "year": "2016",
        "movementDate": "2016-04-05 00:00:00",
        "currency": "EUR",
        "totalAmount": 666,
        "totalAmountCompany": 666,
        "totalAmountSite": 666,
        "taxFreeNumber": null,
        "system": "ECOMMERCE",
        "startDate": null,
        "endDate": null,
        "customerCode": "12345",
        "card": null,
        "cardBarcode": null,
        "actionType": "PURCHASE",
        "actionStatus": "A",
        "result": "INTERFACE",
        "description": "insertSale",
        "pointsMultiplier": 2,
        "consolidatedDocument": "T"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Calculate and Insert/Update Points

Request

Request Code Samples

Responses