GET

Description

Get summary for item.

Returns total quantity, available quantity and order shortage per stock point for a given item id.

Method

GET

Version

1

Response

The item summary can return a a single item warehouse information by specifying a ItemId in the URL.

(Stock point code not defined: api/warehouse/stockpoints-v1/itemsummary/ART-1)

 {
        "stockPointId": "c5a73cef-e7f1-4394-9810-a79d0cba5c72",
        "stockPointCode": "KANADA",
        "stockPointName": "Kanada",
        "totalQuantity": 0,
        "availableQuantity": 0,
        "orderShortage": 0,
        "stockLocations": 2
    },
    {
        "stockPointId": "effc300a-381d-4aa0-b4d8-89b6afa6a1f0",
        "stockPointCode": "LAGER",
        "stockPointName": "Standardlager",
        "totalQuantity": 1,
        "availableQuantity": 1,
        "orderShortage": 0,
        "stockLocations": 1
    }

Response

The item summary can return a a single item warehouse information with Stock point code filter as query param:

Example: api/warehouse/stockpoints-v1/itemsummary/ART-1?q=KANADA

{
        "stockPointId": "c5a73cef-e7f1-4394-9810-a79d0cba5c72",
        "stockPointCode": "KANADA",
        "stockPointName": "Kanada",
        "totalQuantity": 0,
        "availableQuantity": 0,
        "orderShortage": 0,
        "stockLocations": 2
    }

Fields

FIELD

DESCRIPTION

stockPointId

UUID, readonly

id of the stockpoint

stockPointCode

String, searchable, readonly

The stock point code

stockPointName

String, readonly

Name of the stock point

totalQuantity

double, readonly

Total quantity in stock

availableQuantity

double, readonly

Available quantity in stock

.

orderShortage

BigDecimal, readonly

The quantity missing to be able to fulfill all open orders

stockLocations

Long, readonly

Number of stock locations that exists on the above stock point