Stock

A stock level is the overview of which and the amount of variants there are currently in stock.

The stock model

Properties

  • Name
    id
    Type
    string
    Readonly
    readonly
    Description
  • Name
    article_code
    Type
    string
    Description
  • Name
    ean
    Type
    string
    Description
  • Name
    sku
    Type
    string
    Description
  • Name
    stock_physical
    Type
    integer
    Description
  • Name
    stock_salable
    Type
    integer
    Description
  • Name
    stock_available
    Type
    integer
    Description
  • Name
    stock_quarantine
    Type
    integer
    Description
  • Name
    stock_pickable
    Type
    integer
    Description
  • Name
    variant
    Type
    Variant
    Description
  • Name
    created_at
    Type
    datetime
    Readonly
    readonly
    Description
  • Name
    modified_at
    Type
    datetime
    Readonly
    readonly
    Description
GET/wms/stock/

List all stock

Retrieves a collection of stock

Optional attributes

  • Name
    article_code
    Type
    string
    Description
  • Name
    ean
    Type
    string
    Description
  • Name
    sku
    Type
    string
    Description
  • Name
    search
    Type
    string
    Description

    Search for name, sku, ean and article code

  • Name
    modified_gte
    Type
    datetime
    Description
  • Name
    limit
    Type
    integer
    Description
    Limits the amount of results.
  • Name
    page
    Type
    integer
    Description
    Only works in combination with the limit attribute.
  • Name
    from
    Type
    date
    Description
    Accepts date format %Y-%m-%d. IE: 2022-10-22
  • Name
    to
    Type
    date
    Description
    Accepts date format %Y-%m-%d. IE: 2022-10-22
  • Name
    direction
    Type
    string
    Description
    Sort direction. Options: asc | desc
    Default
    Default: asc
  • Name
    sort
    Type
    string
    Description
    You can sort on the following fields:
    • id
    • createdAt
    • modifiedAt
    • name
    • articleCode
    Default
    Default: name

Request

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

Response

[
{
    "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.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.0
    }
}
]