GetItemsImages

The GetItemsImages call returns the URLs for the item images.

This call is available since SOAP version 100.
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.
ImageURL and FilaData are mutually exclusive. Enter either an url for the image or the file data.

GetItemsImages Input

Field Type Occurrence Meaning Available since
Availability Integer Optional Availability of the item image 105
CallItemsLimit Integer Optional Call items limit for own server 112
CouchCommerce Integer Required Market is active 111
Gimahhot Integer Required Market is active 105
GoogleProducts Integer Required Market is active 105
Grosshandel Integer Required Market is active 111
Hitmeister Integer Required Market is active 105
Laary Integer Required Market is active 106
LastUpdate Integer Required Last update - timestamp 105
Marking1ID Integer Required Marking 1 of the item 105
Marking2ID Integer Required Marking 2 of the item 105
Otto Integer Required Market is active 112
Page Integer Optional Page 105
PlusDe Integer Required Market is active 112
SKU String Required Items SKU 105
ShopShare Integer Required Market is active 105
Shopgate Integer Required Market is active 105
Shopperella Integer Required Market is active 105
SumoScout Integer Required Market is active 107
Tradoria Integer Required Market is active 105
Twenga Integer Required Market is active 111
WebAPI Integer Required Market is active 105
Webshop Integer Required Market is active 105
Yatego Integer Required Market is active 105

GetItemsImages 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_GetItemsImages>
<Gimahhot>Integer</Gimahhot>
<Laary>Integer</Laary>
<Otto>Integer</Otto>
<Page>Integer</Page>
<PlusDe>Integer</PlusDe>
<SKU>String</SKU>
<ShopShare>Integer</ShopShare>
<Shopgate>Integer</Shopgate>
<SumoScout>Integer</SumoScout>
<Tradoria>Integer</Tradoria>
<Twenga>Integer</Twenga>
<WebAPI>Integer</WebAPI>
<Webshop>Integer</Webshop>
<Yatego>Integer</Yatego>
</PlentySoapRequest_GetItemsImages>

GetItemsImages Output

Field Type Occurrence Meaning Available since
ItemsImages ObjectOptional List with item images 109
ItemsImages.
PlentySoapObject_GetItemsImages.
Images
ObjectOptional List with images 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
Availability
Integer Optional The image's availability 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
ImageData
ObjectRequired Image data 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
ImageData.
PlentySoapObject_FileBase64Encoded.
FileData
base64Binary Required base64 encoded document data 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
ImageData.
PlentySoapObject_FileBase64Encoded.
FileEnding
String Optional The ending of the file (currently, this is always .pdf for invoice documents) 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
ImageData.
PlentySoapObject_FileBase64Encoded.
FileName
String Required The name of the document (should be unique) 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
ImageID
Integer Optional Image ID 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
ImageURL
String Optional Image URL 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
Position
Integer Optional The image's position 105
ItemsImages.
PlentySoapObject_GetItemsImages.
Images.
PlentySoapObject_ItemImage.
Watermark
Boolean Optional Watermark 109
ItemsImages.
PlentySoapObject_GetItemsImages.
ItemID
Integer Optional Item ID 105
Pages Integer Optional Pages 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

GetItemsImages 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

For this call no identification keys and values exist.

Identification Output schema

For this call no identification output schema exists.

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
800 Too few parameter are given. Enter at least on of the request paramerets.

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

Code Key Value Message Explanation
110 No data No Item available No items were found for the search request
110 Page Unused parameter Parameter was not entered. A default value was used for the call.

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.

<Warnings>
<item> </item>
<item>
<Value>Unused parameter</Value>
</item>
</Warnings>
Nach oben