GetItemsSearchData

This call is available since SOAP version 110.

GetItemsSearchData Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
GetAttributeValueSets Boolean Optional Get attribute value sets 112
Lang String Optional language 110
Page Integer Optional Page 110
StoreID Integer Required multishop id 110

GetItemsSearchData 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_GetItemsSearchData>
<Lang>String</Lang>
<Page>Integer</Page>
<StoreID>Integer</StoreID>
</PlentySoapRequest_GetItemsSearchData>

GetItemsSearchData Output

Field Type Occurrence Meaning Available since
ItemsSearchData ObjectOptional List of item search data 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets
ObjectOptional list of attribute value sets 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
AttributeValueSetBackendName
String Optional Back end name of the item variant 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
AttributeValueSetFrontendName
String Optional Webshop name of the item variant 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
AttributeValueSetID
Integer Optional Attribute value set ID 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
AttributeValueSetName
String Optional Attribute value set name 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
Availability
Integer Optional Availability 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
EAN
String Optional EAN 1 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
EAN2
String Optional EAN 2 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
EAN3
String Optional EAN 3 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
EAN4
String Optional EAN 4 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
OverSale
Integer Optional Oversale 111
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
AttributeValueSets.
PlentySoapObject_ItemSearchAttributeValueSet.
PriceID
Integer Optional Price set ID 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Availability
Integer Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories
ObjectOptional Kategorien 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories.
PlentySoapObject_ItemCategory.
ItemCategoryID
Integer Optional Item category ID 105
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories.
PlentySoapObject_ItemCategory.
ItemCategoryLevel
Integer Optional Item category level 105
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories.
PlentySoapObject_ItemCategory.
ItemCategoryPath
String Optional Path of the category IDs separated by semicolons 105
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories.
PlentySoapObject_ItemCategory.
ItemCategoryPathNames
String Optional Path of the category names separated by semicolons 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories.
PlentySoapObject_ItemCategory.
ItemStandardCategory
ObjectOptional Shops in which this category is the standard category / 0 = main shop 105
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories.
PlentySoapObject_ItemCategory.
ItemStandardCategory.
PlentySoapObject_Integer.
intValue
Integer Optional Integer Value 105
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Categories.
PlentySoapObject_ItemCategory.
RemoveCategoryFromItem
Integer Optional Remove category from item 105
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
CustomerClass
Integer Optional Customer class 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
EAN
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
EAN2
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
EAN3
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
EAN4
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Images
ObjectOptional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Images.
PlentySoapObject_ItemSearchImage.
ImageID
Integer Optional Image ID 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Images.
PlentySoapObject_ItemSearchImage.
ImageURL
String Required Image URL 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Images.
PlentySoapObject_ItemSearchImage.
Position
Integer Optional The image's position 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Inserted
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemId
Integer Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemNo
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties
ObjectOptional list of item properties 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties.
PlentySoapObject_ItemSearchProperty.
PropertyGroupID
Integer Optional Property group ID 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties.
PlentySoapObject_ItemSearchProperty.
PropertyGroupName
String Optional Property group name 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties.
PlentySoapObject_ItemSearchProperty.
PropertyID
Integer Optional Property ID 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties.
PlentySoapObject_ItemSearchProperty.
PropertyName
String Optional Property name 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties.
PlentySoapObject_ItemSearchProperty.
PropertySelectionID
Integer Optional Property selection ID 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties.
PlentySoapObject_ItemSearchProperty.
PropertySelectionName
String Optional Property selection name 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemProperties.
PlentySoapObject_ItemSearchProperty.
PropertyValue
String Optional Property value 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ItemUrl
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Keywords
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Limitation
Integer Optional Limitation: 0 = "no limitation", 1 = "Limited to net stock", 2 = "Do not administer stock for this item" 112
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
LongDescription
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Lot
Double Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Model
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Name
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Position
Integer Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Price
Double Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
PriceId
Integer Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Producer
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
RRP
Double Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
SalesRank
String Optional Sales Rank 111
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
ShortDescription
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
StoreIDsList
ObjectOptional 111
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
StoreIDsList.
PlentySoapObject_Integer.
intValue
Integer Optional Integer Value 105
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
TechnicalData
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
Unit
String Optional 110
ItemsSearchData.
PlentySoapObject_GetItemSearchData.
VAT
Double Optional 110
Pages Integer Optional Pages 110
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

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

<PlentySoapResponse_GetItemsSearchData>
<ItemsSearchData>
<PlentySoapObject_GetItemSearchData>
<EAN>String</EAN>
<EAN2>String</EAN2>
<EAN3>String</EAN3>
<EAN4>String</EAN4>
<Inserted>String</Inserted>
<ItemId>Integer</ItemId>
<ItemNo>String</ItemNo>
<ItemUrl>String</ItemUrl>
<Keywords>String</Keywords>
<Lot>Double</Lot>
<Model>String</Model>
<Name>String</Name>
<Position>Integer</Position>
<Price>Double</Price>
<PriceId>Integer</PriceId>
<Producer>String</Producer>
<RRP>Double</RRP>
<Unit>String</Unit>
<VAT>Double</VAT>
</PlentySoapObject_GetItemSearchData>
</ItemsSearchData>
<Pages>Integer</Pages>
<Success>Boolean</Success>
</PlentySoapResponse_GetItemsSearchData>

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 - - - return item search data

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 StoreID Invalid parameter The value of entered parameter is not allowed

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

Warnings

Code Key Value Message Explanation
110 No data No data found No item search data found for the given store ID.

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