GetEmailTemplate

The GetEmailTemplate call returns an E-mail template.

This call is available since SOAP version 100.

GetEmailTemplate Input

Field Type Occurrence Meaning Available since
EmailTemplateID Integer Required E-mail template ID 105
Lang String Optional anguage code 105
OrderID Integer Required Order ID 105

GetEmailTemplate 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_GetEmailTemplate>
<Lang>String</Lang>
<OrderID>Integer</OrderID>
</PlentySoapRequest_GetEmailTemplate>

GetEmailTemplate Output

Field Type Occurrence Meaning Available since
EmailBody String Optional E-mail content 105
EmailTitle String Optional E-mail title 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
UseHTML Boolean Optional HTML E-mail 105

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

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 OrderID Missing parameter Required parameter was not entered
800 EmailTemplateID Missing parameter Required parameter was not entered
800 Email template could not be loaded An error occured while loading the email template

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

Warnings

Code Key Value Message Explanation
110 Lang 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