GetCurrentStocks

The GetCurrentStocks call returns the current stock for items from a specific warehouse. The amount of stock will only be returned if it has changed during a specific time period. Both the warehouse ID (WarehouseID) and the time when changes were last made (LastUpdate) need to be transmitted.

It is possible to transmit a 0 as the time. This will return the stock for all items within a warehouse. However, this call is very extensive and should only be carried out one time. After having retrieved all of the stocks one time, you should only use LastUpdate to retrieve stocks incrementally.

This call is available since SOAP version 100.
If you transmit a warehouse ID, then you will receive the stock of 250 items/variants per page.
Another possibility is to transmit a list of SKUs. If you do, then the stock of these items will be returned and the parameters WarehouseID and LastUpdate will be ignored.
A further possibility is to transmit a list of EANs. If you do, then the stock of these items will be returned. WarehouseID can also be used, but it is optional. LastUpdate will be ignored.
You can transmit a maximum of 100 SKUs or EANs and will receive the stock of 100 items/variants accordingly.

GetCurrentStocks Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
GetCurrentStocksByEAN Boolean Optional Get current stocks by ean 111
Items ObjectOptional Items 105
Items.
PlentySoapRequestObject_GetCurrentStocks.
EAN
String Optional EAN 111
Items.
PlentySoapRequestObject_GetCurrentStocks.
EAN2
String Optional EAN 2 112
Items.
PlentySoapRequestObject_GetCurrentStocks.
EAN3
String Optional EAN 3 112
Items.
PlentySoapRequestObject_GetCurrentStocks.
EAN4
String Optional EAN 4 112
Items.
PlentySoapRequestObject_GetCurrentStocks.
SKU
String Optional Item SKU 105
LastUpdate Integer Required Timestamp of the last update 105
Page Integer Optional Page 105
WarehouseID Integer Required Warehouse ID 105

GetCurrentStocks Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapRequest_GetCurrentStocks>
<Page>Integer</Page>
</PlentySoapRequest_GetCurrentStocks>

GetCurrentStocks Output

Field Type Occurrence Meaning Available since
CurrentStocks ObjectOptional List with stocks 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
AveragePrice
Double Optional Average price 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
EAN
String Optional EAN 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
EAN2
String Optional EAN2 112
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
EAN3
String Optional EAN3 112
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
EAN4
String Optional EAN4 112
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
NetStock
String Optional Net stock 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
PhysicalStock
String Optional Physical stock 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
SKU
String Optional Artikel-SKU 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
StorageLocationID
Integer Optional Storage location ID 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
StorageLocationName
String Optional Storage location name 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
StorageLocationStock
String Optional Stock at this storage location 106
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
VariantEAN
String Optional Variant EAN 112
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
VariantEAN2
String Optional Variant EAN2 112
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
VariantEAN3
String Optional Variant EAN3 112
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
VariantEAN4
String Optional Variant EAN4 112
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
WarehouseID
Integer Optional Warehouse ID 105
CurrentStocks.
PlentySoapObject_GetCurrentStocks.
WarehouseType
String Optional Warehouse type 105
Pages Integer Optional Page 105
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

GetCurrentStocks Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

Identification Keys

(The dynamicValue stands for any parameter values that could be outputted.)

Key Value
SKU dynamicValue

Identification Output schema

The box below lists all identification fields that could be outputted in the call response (version 112). The dynamicValue stands for any parameter values that could be outputted. To learn more about an individual field or its type, click its name in the box.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 - - Data records have been retrieved from data base Stocks were successfully loaded.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 50 Max. 100 Items allowed A maximum of 100 items can be retrieved.
800 WarehouseID Missing parameter Required parameter was not entered.
800 LastUpdate Missing parameter Required parameter was not entered.
800 EAN Missing parameter Required parameter was not entered.
800 Unable to load data records Stock could not be loaded.

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<ErrorMessages>
<item> </item>
<item>
<Value>Missing parameter</Value>
<Key>WarehouseID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>LastUpdate</Key>
</item>
<item>
<Value>Missing parameter</Value>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data No current stocks were found.
110 SKU Ignored parameter Parameter ist invalid or missing and was not used for the call.
110 Page Unused parameter Parameter was not entered. A default value was used for the call.

Warnings Output schema

The box below lists all warning fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<Warnings>
<item> </item>
<item>
<Value>Ignored parameter</Value>
</item>
<item>
<Value>Unused parameter</Value>
</item>
</Warnings>
Nach oben