AddCustomers

Use the AddCustomers call to create one or more customers in your system.

If you do not specify a password, then an 8 character password will be randomly generated.

This call is available since SOAP version 100.
You have to specify a customer number (CustomerNumber). Otherwise the customer can not be created. Customer numbers are not generated by the system. Please note that other values are required (see below).
A maximum of 50 customers can be created per call.

AddCustomers Input

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

AddCustomers 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_AddCustomers>
<Customers>
<PlentySoapObject_AddCustomersCustomer>
<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_AddCustomersCustomer>
</Customers>
</PlentySoapRequest_AddCustomers>

AddCustomers 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

AddCustomers 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
CustomerNumber 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 CustomerID dynamicValue The customer was successfully saved. The customer ID is returned.

Success Messages Output schema

The box below lists all success messages 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.

<SuccessMessages>
<item>
<Value>dynamicValue</Value>
<Key>CustomerID</Key>
</item>
</Success>

Error messages

Code Key Value Message Explanation
810 Limit 50 Too many data records The request has to many data records. Attend the defined limit.
800 CustomerNumber Missing parameter Required parameter was not entered
800 FirstName Missing parameter Required parameter was not entered
800 Surname Missing parameter Required parameter was not entered
800 Street Missing parameter Required parameter was not entered
800 HouseNo Missing parameter Required parameter was not entered
800 ZIP Missing parameter Required parameter was not entered
800 City Missing parameter Required parameter was not entered
800 CountryID Missing parameter Required parameter was not entered
800 Email Missing parameter Required parameter was not entered
800 Email Invalid parameter The value of entered parameter is not allowed
800 Language Missing parameter Required parameter was not entered
800 PasswordMD5 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> </item>
<item>
<Value>Missing parameter</Value>
<Key>CustomerNumber</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>FirstName</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>Surname</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>Street</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>HouseNo</Key>
</item>
<item>
<Value>Missing parameter</Value>
</item>
<item>
<Value>Missing parameter</Value>
</item>
<item>
<Value>Missing parameter</Value>
<Key>CountryID</Key>
</item>
<item>
<Value>Missing parameter</Value>
</item>
<item>
<Value>Invalid parameter</Value>
</item>
<item>
<Value>Missing parameter</Value>
<Key>Language</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>PasswordMD5</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben