# StockItem Sum

With this API you can list all article items with their summarized stock count.

# The stock item sum resource

# JSON object

{
  "customerId": 1000050,
  "articleId": 71035893,
  "articleNumber": "A1000-BLUE",
  "articleUnit": "ST",
  "batchNumber": null,
  "quantities": {
    "total": 100.0,
    "available": 80.0,
    "reserved": 15.0,
    "blocked": 5.0
  }
}

# Properties

customerId int32 - read-only
The id of the customer the stock item belongs to.
articleId int32 - read-only
The id of the article to identify the article in the API.
articleNumber string - read-only
The article number to identify from the shop or third party.
articleUnit string - read-only
Defines the unit of the article.
batchNumber string (default: null) - read-only
Defines the batch number of the stock item. Included only if the corresponding parameter is set.
quantities object
All quantities of the requested stock item.
- total double
  The total number of stock items.
- available double
  The number of available stock items.
- reserved double
  The number of stock items which are already reserved for orders.
- blocked double
  The number of stock items which are currently blocked.

# GET - Retrieve a list of stock items

Requires scope StockItem.Read

Use this operation to retrieve a list of stock items that meet the specified criteria. This endpoint implements pagination. Click here to learn more.

curl -X GET \
  'https://{domain}.logistic.cloud/api/{version}/stock/items/sum' \
  -H 'X-API-KEY: YOUR_API_KEY'

Parameters

customerId string
Retrieve only stock items for the given customer id.
articleIds string
Retrieve only stock items with the given article ids specified by a comma-separated list.
includeBatchNumber bool
Includes the batch number of a stock item and apply grouping, if set to true.
page int32 (default: 0)
The page number that contains the results. If not specified the first page will be returned.
pageSize int32 (default: 50)
The maximum number of results returned per page. Value must be between 1 and 250.

Responses

200 - OK
Returns a list of stock item resources.

# Examples

This examples shows how to list the stock items sum for specific article ids by specifying the articleIds parameter.

curl -X GET \
  'https://{domain}.logistic.cloud/api/{version}/stock/items/sum?articleIds=71035893,71035899' \
  -H 'X-API-KEY: YOUR_API_KEY'

To list the sum of stock items for each batch number set the includeBatchNumber parameter to true.

curl -X GET \
  'https://{domain}.logistic.cloud/api/{version}/stock/items/sum?includeBatchNumber=true' \
  -H 'X-API-KEY: YOUR_API_KEY'