GetCustomers

The GetCustomers call returns all of the customer information that was found with the parameters. If you use the parameter GetCustomerBankData, then the bank details will be returned as well.

This call is available since SOAP version 100.
You either have to specify the SearchString or one of the other parameters. If one or more of the other parameters are specified, then the SearchString will be ignored.
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.

GetCustomers Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
CountryID Integer Optional Country ID 105
CustomerClassID Integer Optional Customer class ID 105
CustomerID Integer Optional Customer ID 105
CustomerNumber String Optional Customer number 105
Email String Optional The customer's E-mail address 105
ExternalCustomerID String Optional External customer ID 105
GetCustomerBankData Boolean Optional Get customer bank data 105
IsBlocked Boolean Optional Blocked 109
Lang String Optional Language 105
LastOrderFrom Integer Optional Last order from 105
LastOrderTo Integer Optional Last order to 105
LastUpdateFrom Integer Optional Last update from 105
LastUpdateTill Integer Optional Last update till 105
Newsletter Integer Optional Newsletter 105
Page Integer Optional Page 105
Postident String Optional Post ident 109
ResponsibleID Integer Optional ID of the person responsible 105
SearchString String Optional Search string to find customers 105
StoreID Integer Optional Multishop ID 110
Type String Optional Customer type 105
ZIP String Optional The customer's ZIP code 105

GetCustomers 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_GetCustomers>
<CountryID>Integer</CountryID>
<Email>String</Email>
<IsBlocked>Boolean</IsBlocked>
<Lang>String</Lang>
<Page>Integer</Page>
<StoreID>Integer</StoreID>
<Type>String</Type>
<ZIP>String</ZIP>
</PlentySoapRequest_GetCustomers>

GetCustomers Output

Field Type Occurrence Meaning Available since
Customers ObjectOptional Customer data 105
Customers.
PlentySoapObject_Customer.
AdditionalName
String Optional Additional name 105
Customers.
PlentySoapObject_Customer.
ArchiveNumber
Integer Optional Archive number 105
Customers.
PlentySoapObject_Customer.
BankData
ObjectOptional Bank data 105
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
Accountnumber
String Optional Account number 105
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
BIC
String Optional BIC 111
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
BankName
String Optional Bank name 105
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
Blz
String Optional Bank code 105
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
Date
Integer Optional Date 105
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
IBAN
String Optional IBAN 111
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
OwnerFirstname
String Optional Owner first name 105
Customers.
PlentySoapObject_Customer.
BankData.
PlentySoapObject_CustomerBankData.
OwnerName
String Optional Owner surname 105
Customers.
PlentySoapObject_Customer.
City
String Optional City 105
Customers.
PlentySoapObject_Customer.
Company
String Optional Company 105
Customers.
PlentySoapObject_Customer.
ContactPerson
String Optional Contact person 105
Customers.
PlentySoapObject_Customer.
CountryID
Integer Optional Country ID 105
Customers.
PlentySoapObject_Customer.
CountryISO2
String Optional Country code 105
Customers.
PlentySoapObject_Customer.
CustomerClass
Integer Optional Customer class 105
Customers.
PlentySoapObject_Customer.
CustomerID
Integer Optional Customer ID 105
Customers.
PlentySoapObject_Customer.
CustomerNumber
String Optional Customer number 105
Customers.
PlentySoapObject_Customer.
CustomerRating
Integer Optional Customer evaluation 105
Customers.
PlentySoapObject_Customer.
CustomerSince
Integer Optional Customer since 105
Customers.
PlentySoapObject_Customer.
DateOfBirth
Integer Optional Birthday 105
Customers.
PlentySoapObject_Customer.
DebitorAccount
String Optional Debtor account 105
Customers.
PlentySoapObject_Customer.
EbayName
String Optional eBay name 105
Customers.
PlentySoapObject_Customer.
Email
String Optional E-mail address 105
Customers.
PlentySoapObject_Customer.
Evaluation
String Optional Evaluation 105
Customers.
PlentySoapObject_Customer.
ExternalCustomerID
String Optional External customer ID 105
Customers.
PlentySoapObject_Customer.
FSK
Integer Optional Motion picture rating 105
Customers.
PlentySoapObject_Customer.
Fax
String Optional Fax number 105
Customers.
PlentySoapObject_Customer.
FirstName
String Optional First name 105
Customers.
PlentySoapObject_Customer.
FormOfAddress
Integer Optional Form of address 105
Customers.
PlentySoapObject_Customer.
FreeTextFields
ObjectOptional Free text fields 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free1
String Optional free text field 1 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free2
String Optional free text field 2 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free3
String Optional free text field 3 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free4
String Optional free text field 4 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free5
String Optional free text field 5 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free6
String Optional free text field 6 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free7
String Optional free text field 7 105
Customers.
PlentySoapObject_Customer.
FreeTextFields.
PlentySoapObject_CustomerFreeTestFields.
Free8
String Optional free text field 8 105
Customers.
PlentySoapObject_Customer.
HouseNo
String Optional House number 105
Customers.
PlentySoapObject_Customer.
IsBlocked
Boolean Optional Is the customer blocked 109
Customers.
PlentySoapObject_Customer.
Language
String Optional Language 105
Customers.
PlentySoapObject_Customer.
LastLogin
Integer Optional Last login 105
Customers.
PlentySoapObject_Customer.
LastSalesOrder
Integer Optional Last sales order 105
Customers.
PlentySoapObject_Customer.
LastSalesOrderCount
Integer Optional Last sales order count 105
Customers.
PlentySoapObject_Customer.
LastSalesOrderID
Integer Optional Last sales order ID 105
Customers.
PlentySoapObject_Customer.
Mobile
String Optional Cell phone number 105
Customers.
PlentySoapObject_Customer.
Newsletter
Integer Optional Newsletter 105
Customers.
PlentySoapObject_Customer.
PasswordMD5
String Optional PasswordMD5 110
Customers.
PlentySoapObject_Customer.
PasswordPlain
String Optional PasswordPlain 110
Customers.
PlentySoapObject_Customer.
PayDebitnode
Boolean Optional Pay debitnode 105
Customers.
PlentySoapObject_Customer.
PayInvoice
Boolean Optional Pay invoice 105
Customers.
PlentySoapObject_Customer.
PaymentDueWithin
Integer Optional Payment due within xxx days 105
Customers.
PlentySoapObject_Customer.
Postident
String Optional Post ident 109
Customers.
PlentySoapObject_Customer.
ResponsibleID
String Optional ID of the person responsible 105
Customers.
PlentySoapObject_Customer.
StoreID
Integer Optional Multishop ID 110
Customers.
PlentySoapObject_Customer.
Street
String Optional Street 105
Customers.
PlentySoapObject_Customer.
Surname
String Optional Surname 105
Customers.
PlentySoapObject_Customer.
Telephone
String Optional Telephone number 105
Customers.
PlentySoapObject_Customer.
Title
String Optional Title 105
Customers.
PlentySoapObject_Customer.
Type
Integer Optional Customer type 105
Customers.
PlentySoapObject_Customer.
Updated
Integer Optional Last update 105
Customers.
PlentySoapObject_Customer.
VAT_ID
String Optional VAT number 105
Customers.
PlentySoapObject_Customer.
ZIP
String Optional ZIP code 105
Pages Integer Optional Pages 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

GetCustomers 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_GetCustomers>
<Customers>
<PlentySoapObject_Customer>
<City>String</City>
<Company>String</Company>
<CountryID>Integer</CountryID>
<EbayName>String</EbayName>
<Email>String</Email>
<FSK>Integer</FSK>
<Fax>String</Fax>
<HouseNo>String</HouseNo>
<IsBlocked>Boolean</IsBlocked>
<Language>String</Language>
<LastLogin>Integer</LastLogin>
<Mobile>String</Mobile>
<StoreID>Integer</StoreID>
<Street>String</Street>
<Surname>String</Surname>
<Title>String</Title>
<Type>Integer</Type>
<Updated>Integer</Updated>
<VAT_ID>String</VAT_ID>
<ZIP>String</ZIP>
</PlentySoapObject_Customer>
</Customers>
<Pages>Integer</Pages>
<Success>Boolean</Success>
</PlentySoapResponse_GetCustomers>

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 Too few parameters were entered Please enter at least one of the required request parameters.
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>
</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