AddItemCategory

With the AddItemCategory call, you add a new item category.

This call is available since SOAP version 100.

AddItemCategory Input

Field Type Occurrence Meaning Available since
CatID Integer Optional Category ID 105
Lang String Required Language 105
Level Integer Required Category levels 105
MetaDescription String Optional Meta description 105
MetaKeywords String Optional Meta keywords 105
MetaTitle String Optional Meta title 105
Name String Required Category name 105
NameURL String Optional Category URL name 105
Position Integer Optional Position 108
Text String Optional Category text 105

AddItemCategory 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_AddItemCategory>
<CatID>Integer</CatID>
<Lang>String</Lang>
<Level>Integer</Level>
<Name>String</Name>
<NameURL>String</NameURL>
<Position>Integer</Position>
<Text>String</Text>
</PlentySoapRequest_AddItemCategory>

AddItemCategory Output

Field Type Occurrence Meaning Available since
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

AddItemCategory 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
CategoryID 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 CategoryID dynamicValue Category successfully added The category with the transferred category ID was successfully added.

Success Messages Output schema

The box below lists all success messages 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.

<SuccessMessages>
<item>
<Value>dynamicValue</Value>
<Key>CategoryID</Key>
</item>
</Success>

Error messages

Code Key Value Message Explanation
800 Level Missing parameter Required parameter was not entered
800 Lang Missing parameter Required parameter was not entered
800 Name Missing parameter Missing parameter, Name Required parameter was not entered
800 Error creating Category Error while creating the category

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

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben