SetCategories

Updates a list of existing categories, if category ID is given, or adds a list of new categories.

This call is available since SOAP version 112.

SetCategories Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
SetCategories ObjectOptional Set categories 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CategoryID
Integer Optional CategoryID 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory
ObjectOptional Create category 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Description
String Optional Description 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Description2
String Optional Description 2 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
FulltextActive
String Optional Full text active 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Image
String Optional Image 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Image1Path
String Optional Image 1 path 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Image2
String Optional Image 2 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Image2Path
String Optional Image 2 path 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
ItemListView
String Optional Item list view 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Lang
String Optional Lang 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Level
Integer Optional Level 1-6 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
MetaDescription
String Optional MetaDescription 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
MetaKeywords
String Optional MetaKeywords 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
MetaTitle
String Optional Meta title 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Name
String Optional Name 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
NameURL
String Optional Name URL 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
PageView
String Optional Page view 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
ParentCategoryID
Integer Optional Parent category id 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
PlaceholderTranslation
String Optional Placeholder translation 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
Position
Integer Optional Position 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
PreviewPath
String Optional Preview path 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
RootPath
String Optional Root path 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
ShortDescription
String Optional Short description 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
SingleItemView
String Optional Single Item view 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
WebTemplateExist
String Optional Web template exist 112
SetCategories.
PlentySoapRequestObject_SetCategories.
CreateCategory.
PlentySoapRequestObject_CreateCategory.
WebstoreID
Integer Optional Webstore ID 112
SetCategories.
PlentySoapRequestObject_SetCategories.
IdentificationValue
String Optional IdentificationValue 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetCategoryBase
ObjectOptional Set category base 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetCategoryBase.
PlentySoapRequestObject_SetCategoryBase.
LinkList
Integer Optional Link list: 1 = "Y"; 0 = "N" 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetCategoryBase.
PlentySoapRequestObject_SetCategoryBase.
Right
String Optional Right: "all", "customer" 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetCategoryBase.
PlentySoapRequestObject_SetCategoryBase.
SiteMap
Integer Optional Site map: 1 = "Y"; 0 = "N" 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetCategoryBase.
PlentySoapRequestObject_SetCategoryBase.
Type
String Optional Type 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetLinkList
Integer Optional Set Link list: 1 = "Y", 0 = "N" 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetRight
String Optional Set Right: "all", "customer" 112
SetCategories.
PlentySoapRequestObject_SetCategories.
SetType
String Optional Set Type: "item", "content" 112

SetCategories 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_SetCategories> </PlentySoapRequest_SetCategories>

SetCategories Output

Field Type Occurrence Meaning Available since
Categories ObjectOptional Categories 112
Categories.
PlentySoapResponseObject_SetCategories.
CategoryID
Integer Optional Category ID 112
Categories.
PlentySoapResponseObject_SetCategories.
IdentificationValue
String Optional IdentificationValue 112
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

SetCategories 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

Code Key Value Message Explanation
800 Error setting categories An error occurred while setting categories.
800 Too few parameters were given. At least the parameters CategoryID, Name, Level, WebstoreID and Lang have to be set to create a new category.
800 CategoryID Missing parameter

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>Missing parameter</Value>
<Key>CategoryID</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben