GET api/stocks/{shopId}/combined/{variantId}
Provides combined stock quantities, given shop id and variant id. Stock at shop, stock in transfer and stock purchased.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
shopId |
Six digit DdD identifier. |
integer |
Required |
variantId |
Unique identifier corresponding to an item. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Combined stock object.
PublicAPI.Models.CombinedStockViewModelName | Description | Type | Additional information |
---|---|---|---|
VariantId |
Identifier for an item |
string |
None. |
Ean |
The EAN of the variant |
integer |
None. |
StockInShop |
The amount of items in stock at shop |
integer |
None. |
TransferDrafts |
The amount of transfer items internally |
integer |
None. |
PurchaseDrafts |
The amount of transfer from supplier |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "VariantId": "sample string 1", "Ean": 2, "StockInShop": 3, "TransferDrafts": 4, "PurchaseDrafts": 5 }
application/xml, text/xml
Sample:
<CombinedStockViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models"> <Ean>2</Ean> <PurchaseDrafts>5</PurchaseDrafts> <StockInShop>3</StockInShop> <TransferDrafts>4</TransferDrafts> <VariantId>sample string 1</VariantId> </CombinedStockViewModel>