To retrieve a stock for a given item code or SKU or cart, 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

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

fulfillment : is an array containing the information of fulfillment for each shop. (return only param fulfillment is set into body)

stocks : is an object containing all the stock information for each shop.

moreRows: Boolean that indicated wether the are more rows to be retrieved or not

Pagination

The request returns a maximum of 20 elements in the valueObjectList array. If moreRows is true, then you can request the next 20 elements by appending the query parameter &start=X on the request URL, where X is the first element to be retrieved.

Example

Response example

  {
        "success": true,
        "code": 200,
        "stocks": {
            "100": [
                {
                    "itemCode": "011 N",
                    "itemDescription": "SCARPA DONNA",
                    "dimensionLevel1": "24",
                    "dimensionDescription1": "46½",
                    "dimensionLevel2": "125",
                    "dimensionDescription2": "Black",
                    "quantity": 2
                }]
            },
            "moreRows": false,
            "resultSetLength": 1
    }

Response example (if fulfillment is set to true)

  {
      "success": true,
      "code": 200,
      "fulfillment": [
          {
              "100": false
          },
          {
              "101": true
          }
      ],
      "stocks": {
          "100": [
              {
                  "itemCode": "011 N",
                  "itemDescription": "SCARPA DONNA",
                  "dimensionLevel1": "24",
                  "dimensionDescription1": "46½",
                  "dimensionLevel2": "125",
                  "dimensionDescription2": "Black",
                  "quantity": 2
              }
          ],
          "101": [
              {
                  "itemCode": "011 N",
                  "itemDescription": "SCARPA DONNA",
                  "dimensionLevel1": "24",
                  "dimensionDescription1": "46½",
                  "dimensionLevel2": "125",
                  "dimensionDescription2": "Black",
                  "quantity": 12
              },
              {
                  "itemCode": "011 N",
                  "itemDescription": "SCARPA DONNA",
                  "dimensionLevel1": "1",
                  "dimensionDescription1": "35",
                  "dimensionLevel2": "125",
                  "dimensionDescription2": "Black",
                  "quantity": 2
              }
          ]
          ]
      },
        "moreRows": false,
        "resultSetLength": 3
  }

Fields

## Request fields

Field	Description	Type	Mandatory
entityCode	Entity code for which the stock is requested	Varchar(250)	✓ (is mandatory into cart case if city or zipCode is not set)
city	City for which the stock is requested	Varchar(250)	✓ (is mandatory into cart case if entity code or zipCode is not set)
zipCode	Zip code for which the stock is requested	Varchar(250)	✓ (is mandatory into cart case if entity code or city is not set)
province	Province for which the stock is requested	Varchar(3)	ISO code(not managed into cart case)
region	Region for which the stock is requested	Varchar(250)	(not managed into cart case)
fulfillment	Check fulfillment order	Bool	(only managed into cart case)
itemTotal	Return stock a item total	Bool	(only managed into item case)
isCart	Force to cart case (if items array contains one element)	Bool
items	Array of article objects for which the stock is requested(see below) (if array contains more than one element it is considered as a shopping cart)	Varchar(250)	✓

Request Items section

Field	Description	Type	Mandatory
itemCode	Item code	Varchar(250)	✓
dimension1	Code of 1st dimension of article	Varchar(250)	✓ (when items array is cart)
dimension2	Code of 2st dimension of article	Varchar(250)	✓ (when items array is cart)
dimension3	Code of 3st dimension of article	Decimal(4, 0)	✓ (when items array is cart)
dimension4	Code of 4st dimension of article	Datetime	✓ (when items array is cart)
dimension5	Code of 5st dimension of article	Varchar(250)	✓ (when items array is cart)
quantity	Quantity for check fulfillment order	Integer	✓ (when fulfillment is set to true and items array is cart)

Response items

Field	Description	Type
item	item code of the searched article	Varchar(250)
itemDescription	article description	Varchar(250)
dimensionLevel1	code of 1st dimension (ex. 1)	Varchar(250)
dimensionDescription1	description of 1st dimension (ex. UN)	Varchar(250)
dimensionLevel2	code of 2nd dimension (ex. 00000)	Varchar(250)
dimensionDescription2	description of 2nd dimension (ex. Neutral)	Varchar(250)
dimensionLevel3	code of 3rd dimension	Varchar(250)
dimensionDescription3	description of 3rd dimension	Varchar(250)
dimensionLevel4	code of 4th dimension	Varchar(250)
dimensionDescription4	description of 4th dimension	Varchar(250)
dimensionLevel5	code of 5th dimension	Varchar(250)
dimensionDescription5	description of 5th dimension	Varchar(250)
quantity	number of stocked articles	Integer

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Get Stock

Example

Response example

Response example (if fulfillment is set to true)

Fields

Request Items section

Response items

Request

Request Code Samples

Responses

Get Stock

Pagination#

Example#

Response example#

Response example (if fulfillment is set to true)#

Fields#

Request Items section#

Response items#

Request

Request Code Samples

Responses

Pagination

Example

Response example

Response example (if fulfillment is set to true)

Fields

Request Items section

Response items