AddItemsImage

The AddItemsImage call allows you to add an image to an item. You can enter the parameters ImageID, ItemAttributeID and ItemAttributeValueID to set a new linkage between images and attributes.

This call is available since SOAP version 100.

AddItemsImage Input

Field Type Occurrence Meaning Available since
Image ObjectRequired Image data 105
Image.
PlentySoapObject_ItemImage.
Availability
Integer Optional The image's availability 105
Image.
PlentySoapObject_ItemImage.
ImageData
ObjectRequired Image data 105
Image.
PlentySoapObject_ItemImage.
ImageData.
PlentySoapObject_FileBase64Encoded.
FileData
base64Binary Required base64 encoded document data 105
Image.
PlentySoapObject_ItemImage.
ImageData.
PlentySoapObject_FileBase64Encoded.
FileEnding
String Optional The ending of the file (currently, this is always .pdf for invoice documents) 105
Image.
PlentySoapObject_ItemImage.
ImageData.
PlentySoapObject_FileBase64Encoded.
FileName
String Required The name of the document (should be unique) 105
Image.
PlentySoapObject_ItemImage.
ImageID
Integer Optional Image ID 105
Image.
PlentySoapObject_ItemImage.
ImageURL
String Optional Image URL 105
Image.
PlentySoapObject_ItemImage.
Position
Integer Optional The image's position 105
Image.
PlentySoapObject_ItemImage.
Watermark
Boolean Optional Watermark 109
ImageID Integer Required Image ID 105
ItemAttributeID Integer Required Attribute ID 105
ItemAttributeValueID Integer Required Attribute value ID 105
ItemID Integer Required Item ID 105

AddItemsImage 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_AddItemsImage>
<ImageID>Integer</ImageID>
<ItemID>Integer</ItemID>
</PlentySoapRequest_AddItemsImage>

AddItemsImage 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

AddItemsImage 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
ItemID 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 ImageID dynamicValue Image successfully saved -

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

Error messages

Code Key Value Message Explanation
800 ItemID Missing parameter Required parameter was not entered
800 FileData Invalid parameter The value of entered parameter is not allowed
800 ImageURL Invalid parameter The image URL contains an error
800 Unable to save Variant Unable to save Variant
800 Image could not be saved If ImageID is given, then ItemID, ItemAttributeID and ItemAttributeValueID has to be entered, too.

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>Invalid parameter</Value>
<Key>FileData</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>ImageURL</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben