GetTermsAndCancellation

The GetTermsAndCancellation call returns the terms and conditions as well as the cancellation rights for the specified shop or multishop and language.

This call is available since SOAP version 103.

GetTermsAndCancellation Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
TermsAndCancellation ObjectRequired List of the terms and conditions as well as the cancellation rights 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
CancellationRightsHtml
String Optional Cancellation rights, HTML code 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
CancellationRightsText
String Optional Cancellation rights, text 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
Lang
String Required Language 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
StoreID
Integer Required Multishop ID 110
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
TermsAndConditionsHtml
String Optional Terms and conditions, HTML code 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
TermsAndConditionsText
String Optional Terms and conditions, text 105

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

GetTermsAndCancellation 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
TermsAndCancellation ObjectOptional List of terms and conditions as well the cancellations rights 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
CancellationRightsHtml
String Optional Cancellation rights, HTML code 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
CancellationRightsText
String Optional Cancellation rights, text 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
Lang
String Required Language 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
StoreID
Integer Required Multishop ID 110
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
TermsAndConditionsHtml
String Optional Terms and conditions, HTML code 105
TermsAndCancellation.
PlentySoapObject_GetTermsAndCancellation.
TermsAndConditionsText
String Optional Terms and conditions, text 105

GetTermsAndCancellation 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 - - - List was successfully returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 StoreID Missing parameter Required parameter was not entered
800 Lang Missing parameter Required parameter was not entered
810 Limit 50 Max terms and cancellation limit The maximum terms and cancellation of 50 was reached

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

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben