AddProperty

Use the AddProperty call to create a property in the system or to edit an existing property. Only one property can be created or edited per call. If a property ID (PropertyID) is specified, then this existing property will be edited. Otherwise, a new property will be created. Use the AddPropertyToItem call to add a newly created or an already existing property to an item.

If you use the parameter PropertyChoice, then the property values will be created or edited simultaneously as well. If an ID (SelectionID) is saved for a property value, then this property value will be edited. Otherwise, a new property value will be created and assigned to the property. You can not use this call to delete property values.

You can use the parameter PropertyGroupID to assign a property to a property group.

This call is available since SOAP version 105.
You need to specify a language, set the LANG parameter, otherwise the parameters FrontendName and BackendName will not be used correctly.

AddProperty Input

Field Type Occurrence Meaning Available since
AmazonList ObjectOptional List with Amazon links 105
AmazonList.
PlentySoapObject_AddPropertyAmazon.
AmazonCorrelation
String Optional Amazon correlation 105
AmazonList.
PlentySoapObject_AddPropertyAmazon.
AmazonGenre
String Optional Amazon genre 105
BeezUP Integer Optional BeezUP 108
CallItemsLimit Integer Optional Call items limit for own server 112
Description String Optional Description 105
EbayLayout Integer Optional Placeholder in eBay layout 105
EbayProperty Integer Optional eBay property 105
Home24Property String Optional Home24 property 111
Idealo Integer Optional Idealo 108
Kauflux Integer Optional Kauflux 105
Lang String Optional Language 105
Markup Double Optional Surcharge 105
NeckermannComponent Integer Optional Neckermann component ID 105
NeckermannExternalComponent Integer Optional Neckermann EP component ID 105
NeckermannLogoId Integer Optional Neckermann logo ID 105
Notice String Optional Note 105
OrderProperty Integer Optional Sales order property 105
Position Integer Optional Position 105
PropertyBackendName String Optional Back end name 105
PropertyChoice ObjectOptional List with selection characteristics 105
PropertyChoice.
PlentySoapObject_AddPropertyChoice.
Description
String Optional Description 105
PropertyChoice.
PlentySoapObject_AddPropertyChoice.
Lang
String Optional Language 105
PropertyChoice.
PlentySoapObject_AddPropertyChoice.
Name
String Optional Name 105
PropertyChoice.
PlentySoapObject_AddPropertyChoice.
SelectionID
Integer Optional Selection ID 105
PropertyFrontendName String Optional Front end name 105
PropertyGroupID Integer Optional Property group ID 105
PropertyID Integer Optional Property ID 105
PropertyType String Optional Property type 105
PropertyUnit String Optional Unit 105
RicardoLayout Integer Optional Placeholder in Ricardo layout 105
Searchable Integer Optional Searchable 105
ShopShare Integer Optional ShopShare 105
ShowInItemList Integer Optional Show in the item list 105
ShowInPDF Integer Optional Show in the PDF 105
ShowOnItemPage Integer Optional Show on the item's page 105
Yatego Integer Optional Yatego 105

AddProperty 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_AddProperty>
<BeezUP>Integer</BeezUP>
<Idealo>Integer</Idealo>
<Kauflux>Integer</Kauflux>
<Lang>String</Lang>
<Markup>Double</Markup>
<Notice>String</Notice>
<Position>Integer</Position>
<ShopShare>Integer</ShopShare>
<ShowInPDF>Integer</ShowInPDF>
<Yatego>Integer</Yatego>
</PlentySoapRequest_AddProperty>

AddProperty 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

AddProperty 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
PropertyBackendName 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 PropertyID dynamicValue - The property was added. The ID is returned.

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>PropertyID</Key>
</item>
</Success>

Error messages

Code Key Value Message Explanation
800 Adding property error. An error occured while adding a property.

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

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben