4WS Suite
Home
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Stock
  • Document Manager
    • Orders
      • Save Sale Order
      • Save Return Order
    • Orchestrated Orders
      • Orchestrated Order
      • Orchestrated Return order
      • Orchestrated Update order
    • Cart
      • Cart Validation
      • Cart Full Validation
    • Sales
      • Save receipt
      • Salve only Order
      • Replace or update sale
      • Get last digital order
    • Warehouse
      • Save Entry from supplier
      • Save Transfer document
      • Save Free Entry
    • Purchase
      • Save Purchase
    • Get Document
      GET
    • Update Document external references
      POST
  • Customer
    • Get Customer
      GET
    • Set Customer Opt-in
      POST
  • Loyalty vouchers
    • Get customer loyalty vouchers
      GET
    • Get loyalty vouchers at a time interval
      GET
    • Get last loyalty vouchers
      GET
  • Giftcard
    • Get Giftcard
      GET
    • Update Giftcard
      POST
    • Generate Gift Card Barcode
      POST
    • Gift Card PDF Generation
      POST
  • Stock
    • Get Stock
      POST
    • Get last stock
      GET
    • Insert Stock
      POST
  1. Stock

Get Stock

POST
/api
Last modified:2025-11-25 07:09:54
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
FieldDescriptionTypeMandatory
entityCodeEntity code for which the stock is requestedVarchar(250)✓ (is mandatory into cart case if city or zipCode is not set)
cityCity for which the stock is requestedVarchar(250)✓ (is mandatory into cart case if entity code or zipCode is not set)
zipCodeZip code for which the stock is requestedVarchar(250)✓ (is mandatory into cart case if entity code or city is not set)
provinceProvince for which the stock is requestedVarchar(3)ISO code(not managed into cart case)
regionRegion for which the stock is requestedVarchar(250)(not managed into cart case)
fulfillmentCheck fulfillment orderBool(only managed into cart case)
itemTotalReturn stock a item totalBool(only managed into item case)
isCartForce to cart case (if items array contains one element)Bool
itemsArray 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#

FieldDescriptionTypeMandatory
itemCodeItem codeVarchar(250)✓
dimension1Code of 1st dimension of articleVarchar(250)✓ (when items array is cart)
dimension2Code of 2st dimension of articleVarchar(250)✓ (when items array is cart)
dimension3Code of 3st dimension of articleDecimal(4, 0)✓ (when items array is cart)
dimension4Code of 4st dimension of articleDatetime✓ (when items array is cart)
dimension5Code of 5st dimension of articleVarchar(250)✓ (when items array is cart)
quantityQuantity for check fulfillment orderInteger✓ (when fulfillment is set to true and items array is cart)

Response items#

FieldDescriptionType
itemitem code of the searched articleVarchar(250)
itemDescriptionarticle descriptionVarchar(250)
dimensionLevel1code of 1st dimension (ex. 1)Varchar(250)
dimensionDescription1description of 1st dimension (ex. UN)Varchar(250)
dimensionLevel2code of 2nd dimension (ex. 00000)Varchar(250)
dimensionDescription2description of 2nd dimension (ex. Neutral)Varchar(250)
dimensionLevel3code of 3rd dimensionVarchar(250)
dimensionDescription3description of 3rd dimensionVarchar(250)
dimensionLevel4code of 4th dimensionVarchar(250)
dimensionDescription4description of 4th dimensionVarchar(250)
dimensionLevel5code of 5th dimensionVarchar(250)
dimensionDescription5description of 5th dimensionVarchar(250)
quantitynumber of stocked articlesInteger

Request

Query Params

Header Params

Body Params application/json

Example
{
    "entityCode": "100",
    "items": [
        {
            "itemCode": "011 N",
            "dimension1": "24",
            "dimension2": "125"
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '/api?cmd=getStocks_v1&applicationId={{APPLICATION_ID}}&appId={{APPLICATION_ID}}&loadRoles=Y' \
--header 'applicationId: {{APPLICATION_ID}}' \
--header 'appId: {{APPLICATION_ID}}' \
--header 'namespace: {{NAMESPACE}}' \
--header 'languageId: {{LANGUAGE}}' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'loadRoles: Y' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entityCode": "100",
    "items": [
        {
            "itemCode": "011 N",
            "dimension1": "24",
            "dimension2": "125"
        }
    ]
}'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2025-11-25 07:09:54
Previous
Gift Card PDF Generation
Next
Get last stock
Built with