GetItemsVariantImages

The GetItemsVariantImages call returns the URLs for the item images.

This call is available since SOAP version 109.
At least one of the request parameters has to be set. Up to 50 items can be returned per call.
You can use the parameter Page to specify which page you want to retrieve. In the response object, the value Pages indicates how many pages can be retrieved in total. If you want to retrieve the first page, then you have to use the value 0 as the Page parameter (this is the default numbering scheme for retrieving pages). The last page has the value Pages minus 1.
The call returns the item image URLs for up to 50 items.

GetItemsVariantImages Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
Items ObjectOptional Items 109
Items.
PlentySoapRequestObject_GetItemsVariantImages.
AttributeID
Integer Optional Attribute ID 109
Items.
PlentySoapRequestObject_GetItemsVariantImages.
AttributeValueID
Integer Optional Attribute value ID 109
Items.
PlentySoapRequestObject_GetItemsVariantImages.
ItemID
Integer Required Item ID 109

GetItemsVariantImages 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_GetItemsVariantImages> </PlentySoapRequest_GetItemsVariantImages>

GetItemsVariantImages Output

Field Type Occurrence Meaning Available since
Images ObjectOptional List with item images 109
Images.
PlentySoapObject_GetItemsVariantImagesImage.
AttributeID
Integer Optional Attribute ID 109
Images.
PlentySoapObject_GetItemsVariantImagesImage.
AttributeValueID
Integer Optional Attribute value ID 109
Images.
PlentySoapObject_GetItemsVariantImagesImage.
ImageID
Integer Optional Image ID 109
Images.
PlentySoapObject_GetItemsVariantImagesImage.
ItemID
Integer Optional Item ID 109
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

GetItemsVariantImages 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 - - - Item images were successfully returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 50 Too many items given For this call is a maximum number of 50 items allowed
800 ItemID 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> </item>
<item>
<Value>Missing parameter</Value>
<Key>ItemID</Key>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data No data found for entered paramters

Warnings Output schema

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

Nach oben