Developer documentation

Stock

Use the Stock API to retrieve and filter stock levels. This page covers the stock model and listing endpoint.

View current stock levels per variant. This page explains the stock model and how to list and filter stock.

Guide: Increase Stock (Sandbox)

**UI only – not API**

This is a UI guide, not an API flow. Read: Increase Stock (Sandbox).

Response models

These response models describe the objects returned by this resource.

The stock model

Field	Description
`id` stringOptional	Read-only.
`article_code` stringOptional	-
`ean` stringOptional	-
`sku` stringOptional	-
`stock_physical` integerOptional	-

List all stock

GET/wms/stock/

Retrieves a collection of stock

Try it

Send a live request against the development middleware using your current API test session.

GET

Request attributes

Field	Description
`article_code` stringOptional	Filter by article code.
`ean` stringOptional	Filter by EAN.
`sku` stringOptional	Filter by SKU.
`search` stringOptional	Search by name, SKU, EAN, or article code.
`modified_gte` datetimeOptional	Return stock modified on or after this timestamp.
`limit` integerOptional	Limit the number of results. Default is 50.
`page` integerOptional	The page number to retrieve.
`direction` stringOptional	Sort direction. Options: `asc` or `desc`. Default is `asc`.
`sort` stringOptional	Sort field. Options: `id`, `createdAt`, `modifiedAt`, `name`, or `articleCode`. Default is `name`.

Request examplecURL

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/stock/

Response exampleJSON

[
  {
    "id": "5060691c-2812-48e2-bd07-82ff3fd19382",
    "article_code": "13378",
    "ean": "13378",
    "sku": null,
    "stock_physical": 99,
    "stock_salable": -8,
    "stock_available": -8,
    "stock_quarantine": 0,
    "stock_pickable": 4,
    "modified_at": "2022-10-27T11:42:50+00:00",
    "variant": {
      "id": "5060691c-2812-48e2-bd07-82ff3fd19382",
      "article_code": "13378",
      "name": "13378",
      "description": null,
      "ean": "13378",
      "sku": null,
      "hs_tariff_code": null,
      "height": null,
      "depth": null,
      "width": null,
      "weight": null,
      "expirable": false,
      "country_of_origin": null,
      "using_serial_numbers": false,
      "value": 0
    }
  },
  {
    "id": "b04f5233-9980-4307-bb20-bc7460b49933",
    "article_code": "1338",
    "ean": "1338",
    "sku": null,
    "stock_physical": 0,
    "stock_salable": -47,
    "stock_available": -47,
    "stock_quarantine": 0,
    "stock_pickable": 0,
    "modified_at": "2022-10-21T07:40:16+00:00",
    "variant": {
      "id": "b04f5233-9980-4307-bb20-bc7460b49933",
      "article_code": "1338",
      "name": "1338",
      "description": null,
      "ean": "1338",
      "sku": null,
      "hs_tariff_code": null,
      "height": null,
      "depth": null,
      "width": null,
      "weight": null,
      "expirable": false,
      "country_of_origin": null,
      "using_serial_numbers": false,
      "value": 0
    }
  }
]