AddItemAttributeValueSets

The AddItemAttributeValueSets call lets you assign attribute values to an item, thus creating item variants.

Attributes and variants are very complicated. For further information, please refer to the corresponding pages of the manual.

Assigning attribute values:
If you assign an attribute value to an item, then the item will automatically be linked to the corresponding attribute as well. Use the parameter ActivateVariations if you want to assign attribute values. This contains a combination of AttributeID and AttributeValueID. A maximum of 100 attribute values can be assigned per call.

Creating variants:
If you want to create a variant, then you have to transmit an attribute value ID of the attribute that is assigned to the item. Only the attribute value IDs are important when creating a variant. Example:

The attribute with attribute ID 1 is a color
Attribute value ID 4 = green
Attribute value ID 5 = blue

The attribute with attribute ID 2 is a finish
Attribute value ID 85 = matte
Attribute value ID 86 = glossy

The attribute with attribute ID 3 is a size
Attribute value ID 90 = small
Attribute value ID 91 = large

A variant can now be created from the attribute value IDs, e.g. 4-85-90 (green, matte, small). For each attribute, you are only allowed to transmit one attribute value ID to create a variant. However, you have to specify an attribute value ID for every attribute. No additional attribute can be assigned after a variant has been created. Attribute values and variants always relate to the item ID (ItemID) that was transmitted. You can create variants from attribute values that you assigned in the same call, or from already existing attribute values (or a combination of both). You can also choose to assign attribute values only or to create variants only.

Up to 100 variants can be created per call.

This call is available since SOAP version 102.

AddItemAttributeValueSets Input

Field Type Occurrence Meaning Available since
ActivateVariations ObjectOptional 105
ActivateVariations.
PlentySoapObject_AttributeVariantion.
AttributeID
Integer Required Attribute ID 105
ActivateVariations.
PlentySoapObject_AttributeVariantion.
AttributeValueID
Integer Required Attribute value ID 105
AddAttributeValueSets ObjectOptional 105
AddAttributeValueSets.
PlentySoapObject_AddItemAttributeVariationList.
AttributeValueIDs
ObjectOptional Attribute value IDs 105
AddAttributeValueSets.
PlentySoapObject_AddItemAttributeVariationList.
AttributeValueIDs.
PlentySoapObject_Integer.
intValue
Integer Optional Integer Value 105
CallItemsLimit Integer Optional Call items limit for own server 112
ItemID Integer Required Item ID 105

AddItemAttributeValueSets 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.

AddItemAttributeValueSets 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

AddItemAttributeValueSets 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
AttributeID;AttributeValueID dynamicValue
AttributeValueIDs 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 VariantID dynamicValue AttributeID; VaIueID activated Attribute value is activated for the item.

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

Error messages

Code Key Value Message Explanation
800 ItemID Missing parameter Required parameter was not entered
800 ValueID Missing parameter Required parameter was not entered
800 AttributeID Missing parameter Required parameter was not entered

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>ItemID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>ValueID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>AttributeID</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben