Get Stock CSV

Based on the specified filters, the service will retrieve and export the articles stock inside a CSV file.

It's recommended to use this web service when it's necessary to retrieve the stock for a big amount of articles, for example the stock of a whole season or shop.
Depending on the amount of requested data, the file 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 CSV file has been created.

The typical use case for the web service is:

Make a POST request sending a JSON body with the filters for extracting the stock and the callback URL that the web service will call (with a POST request) once the CSV file is ready.

The web service getStocksCSV_v2 will respond with a JSON object containing the success property valued to true, and this means the stock retrieval has been taken in charge by KeepIT.

Once the CSV file is ready, KeepIT will POST the URL specified in callbackUrl. The body of the request will contain an URL to download the CSV file.

Important notes

It's only possible to make 1 request per minute, per user, to this web service. The exceeding requests will be discarded.

The download link found in the request response callback can only be used once, and expires after 1 minute since its delivery. When the link expires, it won't allow any other downloads.

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

Request response

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

{
    "succes" : true,
    "code" : 200,
}

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

Filters

This is the list of fields that can be passed in the request body to filter the stock extraction:

Field	Description	Type	Mandatory
callbackUrl	URL to be called with a POST request once the CSV file is ready	String	✓
onlyEcommerce	'T' to only extract stock for the eCommerce, 'F' to extract the stock for all the entities. Defaults to 'F'	Char(1)
onlyLastStocks	'T' only retrieves the last, unprocessed stock records, 'F' retrieves all the stock records. Defaults to 'F'.	Char(1)
system	System code to retrieve last stocks.	Varchar(250	Only with onlyLastStocks = 'T'
startDate	Only extract stocks from this date on (Must be at most 31 days before current date. If specified, onlyLastStocks is ignored.)	Date
hierarchyLevel1	1st hierarchic level to filter the articles	Varchar(250)
hierarchyLevel2	2nd hierarchic level to filter the articles	Varchar(250)
hierarchyLevel3	3rd hierarchic level to filter the articles	Varchar(250)
hierarchyLevel4	4th hierarchic level to filter the articles	Varchar(250)
hierarchyLevel5	5th hierarchic level to filter the articles	Varchar(250)
hierarchyLevel6	6th hierarchic level to filter the articles	Varchar(250)
hierarchyLevel7	7th hierarchic level to filter the articles	Varchar(250)
hierarchyLevel8	8th hierarchic level to filter the articles	Varchar(250)
hierarchyLevel9	9th hierarchic level to filter the articles	Varchar(250)
hierarchyLevel10	10th hierarchic level to filter the articles	Varchar(250)
seasonCode	Season code to filter the articles	Varchar(250)
entityCode	Shop code to filter the articles	Varchar(250)

Callback

Once the CSV file is ready, KeepIT will POST the service specified in the callbackUrl parameter, passing a JSON object composed as follows:

{
    "message" : "10 rows extracted.",
    "csvTemporaryLink" : "https://download-file-path",
}

The link contained in csvTemporaryLink will allow the download of a ZIP file containing the stock.csv file, with all the requested stocks inside it. The link will expire in 1 minute.

CSV File

The CSV will contain the following columns, ordered as they appear below, and separated by ; :

Shop code

Article barcode

Article item code

Article description

Dimension 1 value

Dimension 1 code

Dimension 1 description

Dimension 2 value

Dimension 2 code

Dimension 2 description

Dimension 3 value

Dimension 3 code

Dimension 3 description

Dimension 4 value

Dimension 4 code

Dimension 4 description

Dimension 5 value

Dimension 5 code

Dimension 5 description

Quantity

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses