GetCustomersNewsletterSubscriptions

The GetCustomersNewsletterSubscriptions call returns the CustomerID and CustomerNumber and all found NewsletterSubscriptions that where found.

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

GetCustomersNewsletterSubscriptions Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
CustomerID Integer Optional Customer ID 111
Email String Optional The customer's E-mail address 111
Page Integer Optional Page 111

GetCustomersNewsletterSubscriptions 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_GetCustomersNewsletterSubscriptions>
<Email>String</Email>
<Page>Integer</Page>
</PlentySoapRequest_GetCustomersNewsletterSubscriptions>

GetCustomersNewsletterSubscriptions Output

Field Type Occurrence Meaning Available since
Customers ObjectOptional Customer data 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
CustomerID
Integer Optional Customer ID 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
CustomerNumber
String Optional Customer number 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
NewsletterSubscriptions
ObjectOptional Newsletter subscriptions 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
NewsletterSubscriptions.
PlentySoapObject_NewsletterSubscription.
Directory
Integer Optional Directory 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
NewsletterSubscriptions.
PlentySoapObject_NewsletterSubscription.
NewsletterSubscriptionID
Integer Optional Newsletter ID 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
NewsletterSubscriptions.
PlentySoapObject_NewsletterSubscription.
SubscriptionConfirmedTimestamp
Integer Optional Subscription confirmed timestamp 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
NewsletterSubscriptions.
PlentySoapObject_NewsletterSubscription.
SubscriptionTimestamp
Integer Optional Subscription timestamp 111
Customers.
PlentySoapObject_CustomersNewsletterSubscriptions.
NewsletterSubscriptions.
PlentySoapObject_NewsletterSubscription.
TemplateLang
String Optional Template lang 111
Pages Integer Optional Pages 111
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

GetCustomersNewsletterSubscriptions 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 - - - The customer was successfully retrieved. The customer ID is returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 CustomerID Invalid parameter The value of entered parameter is not allowed
800 Email 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>CustomerID</Key>
</item>
<item>
<Value>Invalid parameter</Value>
</item>
</ErrorMessages>

Warnings

Code Key Value Message Explanation
110 No data Unknown Customers No entries were found.
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> </item>
<item>
<Value>Unused parameter</Value>
</item>
</Warnings>
Nach oben