Insert/Update points

To insert or update points, it's necessary to make a POST call, passing a JSON body as specified below.

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

insertedObjects: Array that contains the correctly processed objects

progId: Identifier of the inserted object

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

Field	Description	Type	Mandatory
pointsRecords	Array of points objecs	See below for the the object structure To update points also specify the progId, which is the identifier for the point record	✓

pointsRecords structure

{
    "pointsRecords": [{
        "refDocument": "",
        "card": "",
        "cardType": "",
        "cardBarcode": "",
        "collectionPointType": "",
        "circuit": "",
        "causal": "",
        "system": "",
        "entityCode": ""
    }]
}

Response example

{
    "success": true,
    "code": 200,
    "message": "Insert/update successful",
    "errorObjects": [],
    "insertedObjects": [
        {
            "progId": "2604",
            "pointsBalance": 2135 
        }
    ]
}

Notes

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

Request

Query Params

Header Params

Body Params application/json

Example

{
    "pointsRecords": [{
    	"refDocument": "",
		"card": "",
		"cardType": "",
		"cardBarcode": "",
		"collectionPointType": "",
		"circuit": "",
		"causal": "",
		"system": "",
		"entityCode": ""
    }]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert/Update points

Request

Request Code Samples

Responses