SetItemsFreeTextFields

This call can be used to edit the free text fields for a list of items. Only the changes will be saved. Existing values will remain as they were. However, you can also choose to explicitly delete all of the existing values before saving new ones.

This call is available since SOAP version 108.
A maximum of 100 item data records can be edited per call.
important

SetItemsFreeTextFields Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
ItemsFreeTextsList ObjectOptional 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
DeleteAllExistingEntries
Boolean Optional Do you really want to delete all of the existing data? (default=false) 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free1
String Optional free text field 1 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free10
String Optional free text field 10 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free11
String Optional free text field 11 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free12
String Optional free text field 12 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free13
String Optional free text field 13 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free14
String Optional free text field 14 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free15
String Optional free text field 15 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free16
String Optional free text field 16 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free17
String Optional free text field 17 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free18
String Optional free text field 18 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free19
String Optional free text field 19 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free2
String Optional free text field 2 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free20
String Optional free text field 20 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free3
String Optional free text field 3 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free4
String Optional free text field 4 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free5
String Optional free text field 5 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free6
String Optional free text field 6 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free7
String Optional free text field 7 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free8
String Optional free text field 8 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
Free9
String Optional free text field 9 108
ItemsFreeTextsList.
PlentySoapObject_SetItemsFreeTextFields.
ItemID
Integer Optional ItemID 108

SetItemsFreeTextFields 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_SetItemsFreeTextFields>
<ItemsFreeTextsList>
<PlentySoapObject_SetItemsFreeTextFields>
<Free1>String</Free1>
<Free10>String</Free10>
<Free11>String</Free11>
<Free12>String</Free12>
<Free13>String</Free13>
<Free14>String</Free14>
<Free15>String</Free15>
<Free16>String</Free16>
<Free17>String</Free17>
<Free18>String</Free18>
<Free19>String</Free19>
<Free2>String</Free2>
<Free20>String</Free20>
<Free3>String</Free3>
<Free4>String</Free4>
<Free5>String</Free5>
<Free6>String</Free6>
<Free7>String</Free7>
<Free8>String</Free8>
<Free9>String</Free9>
<ItemID>Integer</ItemID>
</PlentySoapObject_SetItemsFreeTextFields>
</ItemsFreeTextsList>
</PlentySoapRequest_SetItemsFreeTextFields>

SetItemsFreeTextFields 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

SetItemsFreeTextFields 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 - - - The free text fields of item "ID" were successfully saved.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 100 max. 100 Items reached A maximum of 100 item data records can be edited.
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 ItemID The free text fields of item "ID" could not be saved.

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