GetItemCategoryTree

The GetItemCategoryTree call returns the category tree for a particular multishop. Additionally, you can decide whether you want the active categories to be returned only.

This call is available since SOAP version 104.

GetItemCategoryTree Input

Field Type Occurrence Meaning Available since
GetCategoryNames Boolean Optional Enter "true" in order to receive the category names, too 106
Lang String Optional Language 106
StoreID Integer Optional Store ID 110

GetItemCategoryTree 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_GetItemCategoryTree>
<Lang>String</Lang>
<StoreID>Integer</StoreID>
</PlentySoapRequest_GetItemCategoryTree>

GetItemCategoryTree Output

Field Type Occurrence Meaning Available since
MultishopTree ObjectOptional List with the category trees 105
MultishopTree.
PlentySoapObject_ItemCategoryMultishopTree.
CategoryTree
ObjectOptional List with the category tree nodes 105
MultishopTree.
PlentySoapObject_ItemCategoryMultishopTree.
CategoryTree.
PlentySoapObject_ItemCategoryTreeNode.
Active
Boolean Optional true = Active category
false = Category not activated
105
MultishopTree.
PlentySoapObject_ItemCategoryMultishopTree.
CategoryTree.
PlentySoapObject_ItemCategoryTreeNode.
CategoryPath
String Optional Category IDs, separated by semicolons 105
MultishopTree.
PlentySoapObject_ItemCategoryMultishopTree.
CategoryTree.
PlentySoapObject_ItemCategoryTreeNode.
CategoryPathNames
String Optional Category name 106
MultishopTree.
PlentySoapObject_ItemCategoryMultishopTree.
StoreID
Integer Optional Multishop ID 110
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

GetItemCategoryTree 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 - - - -

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

For this call no error messages exist

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.

Warnings

Code Key Value Message Explanation
110 No data Unable to load data records No data records could be loaded.

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.

Nach oben