GetProperties

The GetProperties call returns a list of properties. If you use the Lang parameter, only properties for the specified language will be returned. You can use the parameter PropertyGroupID to limit the properties that are returned to a specific property group.

If you are dealing with the property type "selection", then all of the possibilities that can be selected will also be returned.

This call is available since SOAP version 104.
A maximum of 100 properties can be returned.
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.

GetProperties Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
Lang String Optional Language 105
LastUpdateFrom Integer Optional Last update timestamp. Last edit from… 110
LastUpdateTill Integer Optional Last update timestamp. Last edit until… 110
Page Integer Optional Page 105
PropertyGroupID Integer Optional Property group ID 105

GetProperties 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_GetProperties>
<Lang>String</Lang>
<Page>Integer</Page>
</PlentySoapRequest_GetProperties>

GetProperties Output

Field Type Occurrence Meaning Available since
Pages Integer Optional Pages 105
Properties ObjectOptional List of properties 105
Properties.
PlentySoapObject_Property.
AmazonList
ObjectOptional List of property amazon 105
Properties.
PlentySoapObject_Property.
AmazonList.
PlentySoapObject_PropertyAmazone.
AmazonCorrelation
String Optional Amazon link 105
Properties.
PlentySoapObject_Property.
AmazonList.
PlentySoapObject_PropertyAmazone.
AmazonGenre
String Optional Amazon link 105
Properties.
PlentySoapObject_Property.
BeezUP
Integer Optional BeezUP 111
Properties.
PlentySoapObject_Property.
Description
String Optional Description 105
Properties.
PlentySoapObject_Property.
EbayLayout
Integer Optional Wildcard character in layout template (eBay) 105
Properties.
PlentySoapObject_Property.
EbayProperty
Integer Optional Displayed as eBay property 105
Properties.
PlentySoapObject_Property.
Home24Property
String Optional Home24 property 105
Properties.
PlentySoapObject_Property.
Idealo
Integer Optional Idealo 111
Properties.
PlentySoapObject_Property.
Kauflux
Integer Optional Kauflux market 105
Properties.
PlentySoapObject_Property.
Lang
String Optional Language 105
Properties.
PlentySoapObject_Property.
Markup
Double Optional Surcharge 105
Properties.
PlentySoapObject_Property.
NeckermannComponent
Integer Optional Neckermann component 105
Properties.
PlentySoapObject_Property.
NeckermannExternalComponent
Integer Optional Neckermann external component 105
Properties.
PlentySoapObject_Property.
NeckermannLogoId
Integer Optional Neckermann logo ID 105
Properties.
PlentySoapObject_Property.
Notice
String Optional Note 105
Properties.
PlentySoapObject_Property.
OrderProperty
Integer Optional Sales order proberty 105
Properties.
PlentySoapObject_Property.
Position
Integer Optional Position 105
Properties.
PlentySoapObject_Property.
PropertyBackendName
String Optional The name used in the system 105
Properties.
PlentySoapObject_Property.
PropertyChoice
ObjectOptional List of property choice 105
Properties.
PlentySoapObject_Property.
PropertyChoice.
PlentySoapObject_PropertyChoice.
Description
String Optional Descripiton of the selected property 105
Properties.
PlentySoapObject_Property.
PropertyChoice.
PlentySoapObject_PropertyChoice.
Lang
String Optional Language of the selected property 105
Properties.
PlentySoapObject_Property.
PropertyChoice.
PlentySoapObject_PropertyChoice.
Name
String Optional Name of the selected property 105
Properties.
PlentySoapObject_Property.
PropertyChoice.
PlentySoapObject_PropertyChoice.
SelectionID
Integer Optional Selection ID 107
Properties.
PlentySoapObject_Property.
PropertyFrontendName
String Optional The name used in the webshop 105
Properties.
PlentySoapObject_Property.
PropertyGroupID
Integer Optional Property group ID 105
Properties.
PlentySoapObject_Property.
PropertyID
Integer Optional Property ID 105
Properties.
PlentySoapObject_Property.
PropertyType
String Optional Property type 105
Properties.
PlentySoapObject_Property.
PropertyUnit
String Optional Unit 105
Properties.
PlentySoapObject_Property.
RicardoLayout
Integer Optional Wildcard character in layout template (ricardo) 105
Properties.
PlentySoapObject_Property.
Searchable
Integer Optional Searchable 105
Properties.
PlentySoapObject_Property.
ShopShare
Integer Optional ShopShare market 105
Properties.
PlentySoapObject_Property.
ShowInItemList
Integer Optional Show in the item list in the webshop 105
Properties.
PlentySoapObject_Property.
ShowInPDF
Integer Optional Show in PDF documents 105
Properties.
PlentySoapObject_Property.
ShowOnItemPage
Integer Optional Show on items page in the webshop 105
Properties.
PlentySoapObject_Property.
Yatego
Integer Optional Yatego market 105
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

GetProperties 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_GetProperties>
<Pages>Integer</Pages>
<Success>Boolean</Success>
</PlentySoapResponse_GetProperties>

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

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

For this call no error messages exist

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 result matching the given search parameters No search result is available for the parameters that were entered.
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>
<Value>Unused parameter</Value>
</item>
</Warnings>
Nach oben