To insert one or more articles stock, it's necessary to make a POST call, passing a JSON body as specified below.

Depending on the amount of requested data, the stock creation can last some seconds up to many minutes, so this is why the web service is asynchronous, and it's mandatory to specify a callback URL that will be called once the stock has been created.
If a callback has been specified in the request, this callback will be called in POST when the queue has ended. If you wish you can specify a payload that will be returned to you in the callback.

The max allowed stock array size: 50 ITEMS

Request response

The web service will respond with a JSON object composed as follows:

{
"success" : true
}

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

Callback

The callback url will be called in POST when the request has ended. In case of success the callback reuqest body is the following JSON:

Successful

    { 
        "success": true,
        "code": 200,
        "message": "Insert/Update successful.",
        "jobName": COMPANY_WS_INSERT_STOCKS_jobName_Date.now() or COMPANY_WS_INSERT_STOCKS_Date.now(),
        "errorObjects": [],
        "insertedObjects": [{
            "entityCode" : "yyy",
            "itemBarcode": "xxx"
        }],
        "additionalData": {
            "additionalField": "Will be returned in response as-is"
        }
    }

Mandatory field not found in the JSON request

    {
        "success": false,
        "code": 400,
        "message": "Error: was not performed, check the error message of the returned records.";
        "jobName": COMPANY_WS_INSERT_STOCKS_jobName_Date.now() or COMPANY_WS_INSERT_STOCKS_Date.now(),
        "errorObjects": [
        {
            "entityCode" : "yyy",
            "itemBarcode": "xxx",
            "errorMessage": "Errore: xxx non valorizzato."
        }
        ],
        "insertedObjects": [],
        "additionalData": {
            "additionalField": "Will be returned in response as-is"
        }
    }

Partial successful

    { 
        "success": true,
        "code": 206,
        "message": insertedObjects.length + " record inserted/updated and " + errorObjects.length + " record in error",
        "jobName": COMPANY_WS_INSERT_STOCKS_jobName_Date.now() or COMPANY_WS_INSERT_STOCKS_Date.now(),
        "errorObjects": [
        {
            "entityCode" : "yyy",
            "itemBarcode": "xxx",
            "errorMessage": msgError
        }
        ],
        "insertedObjects": [{
            "entityCode" : "yyy",
            "itemBarcode": "xxx"
        }]
    }

Fields

Root

Field	Description	Type	Mandatory
callbackUrl	URL to be called with a POST request once the stock creation is termined	String
jobName	Job name returned if callbackUrl is set (if not set default is COMPANY_WS_INSERT_STOCKS_Date.now())	String
stocks	Array of articles stock object [MAX ALLOWED 50 ITEMS](see below for the complete structure).	Array	✓
additionalData	An object containing any data, that will be returned as-in in response. Useful to store information required in the callbackUrl	JSON Object

Stocks

Field	Description	Type	Mandatory
entityCode	Shop code	Varchar(250)	✓
entityLocation	Location code	Varchar(250)	✓(if you want lease management)
itemBarcode	Barcode of the article for insert stock	Varchar(50)	✓
quantityStock	Quantity in stock	Integer	✓
quantityGeneric1	Quantity configurable1	Integer
quantityGeneric2	Quantity configurable2	Integer
quantityGeneric3	Quantity configurable3	Integer
quantityGeneric4	Quantity configurable4	Integer
quantityGeneric5	Quantity configurable5	Integer
quantityArrived	Quantity arrived	Integer
quantityArrivedWarehouse	Quantity arrived from warehouse	Integer
quantityArrivedStore	Quantity arrived from store	Integer
quantityArrivedSupplier	Quantity arrived from supplier	Integer
quantityOnDelivery	Quantity on delivery	Integer
quantityOrder	Quantity order	Integer
quantityRiassort	Quantity restocking	Integer
quantityCommitted	Quantity committed	Integer
quantityDispatched	Quantity dispatched	Integer
quantityInvoiced	Quantity invoiced	Integer
quantityReceipted	Quantity receipted	Integer
quantitySaleB2B	Quantity sales delivery note	Integer
quantityCanceled	Quantity canceled	Integer
quantityReturned	Quantity returned	Integer
quantityAdjusted	Quantity adjusted	Integer
quantityTransfered	Quantity transfered	Integer

Insert Stock

Request response

Callback

Successful

Mandatory field not found in the JSON request

Partial successful

Fields

Root

Stocks

Request

Request Code Samples

Responses

Insert Stock

Request response#

Callback#

Successful#

Mandatory field not found in the JSON request#

Partial successful#

Fields#

Root#

Stocks#

Request

Request Code Samples

Responses

Request response

Callback

Successful

Mandatory field not found in the JSON request

Partial successful

Fields

Root

Stocks