GetItemCategoryCatalogBase

The GetItemCategoryCatalogBase call returns a list of categories according to the transferred parameters.

This call is available since SOAP version 100.
A maximum of 250 categories are returned per call.

GetItemCategoryCatalogBase Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
CategoryID Integer Optional Category ID 112
Lang String Required Language 105
Page Integer Optional Page 105
StoreID Integer Optional Store ID 112

GetItemCategoryCatalogBase 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_GetItemCategoryCatalogBase>
<Lang>String</Lang>
<Page>Integer</Page>
<StoreID>Integer</StoreID>
</PlentySoapRequest_GetItemCategoryCatalogBase>

GetItemCategoryCatalogBase Output

Field Type Occurrence Meaning Available since
Categories ObjectOptional List with categories 105
Categories.
PlentySoapObject_GetItemCategoryCatalogBase.
CategoryID
Integer Optional Category ID 105
Categories.
PlentySoapObject_GetItemCategoryCatalogBase.
Lang
String Optional Language of the category 105
Categories.
PlentySoapObject_GetItemCategoryCatalogBase.
Name
String Optional Category name 105
Pages Integer Optional The number of pages 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

GetItemCategoryCatalogBase 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

For this call no identification keys and values exist.

Identification Output schema

For this call no identification output schema exists.

Success messages

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

Code Key Value Message Explanation
100 - - - The category was successfully returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 StoreID Invalid parameter Value of entered parameter is not allowed

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>
<Value>Invalid parameter</Value>
<Key>StoreID</Key>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data No appropriate category was found.
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>Unused parameter</Value>
</item>
</Warnings>
Nach oben