GetItemCategoryCatalog

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

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

GetItemCategoryCatalog 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
LastUpdateFrom Integer Optional Last update from 111
LastUpdateTo Integer Optional Last update to 112
Page Integer Optional Page 105
StoreID Integer Optional Store ID 112

GetItemCategoryCatalog 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_GetItemCategoryCatalog>
<Lang>String</Lang>
<Page>Integer</Page>
<StoreID>Integer</StoreID>
</PlentySoapRequest_GetItemCategoryCatalog>

GetItemCategoryCatalog Output

Field Type Occurrence Meaning Available since
Categories ObjectOptional List with categories 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
CategoryID
Integer Optional Category ID 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
Image1
String Optional URL for category image 1 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
Image2
String Optional URL for category image 2 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
Lang
String Optional Language of the category 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
MetaDescription
String Optional Category's meta description 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
MetaKeywords
String Optional Category's meta keywords 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
MetaTitle
String Optional Category 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
Name
String Optional Category name 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
NameURL
String Optional Category URL name 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
Position
Integer Optional Position 105
Categories.
PlentySoapObject_GetItemCategoryCatalog.
Text
String Optional Category text 105
Pages Integer Optional 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

GetItemCategoryCatalog 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 The 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 Page Unused parameter Parameter was not entered. A default value was used for the call.
110 No data The specified item category catalog could not be found.

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>
<Value>Unused parameter</Value>
</item>
<item> </item>
</Warnings>
Nach oben