Description
API call returns customer data based on provided filter parameters.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
RowCount |
integer |
0 |
123 |
Number of records to return |
2 |
CustNrExternal |
string |
0 |
abcdefg |
External customer number or Datev user account/number |
3 |
string |
0 |
abcdefg |
||
4 |
Name |
string |
0 |
abcdefg |
Name |
5 |
Address |
string |
0 |
abcdefg |
Address |
6 |
City |
string |
0 |
abcdefg |
City |
7 |
Zip |
string |
0 |
abcdefg |
Postal code |
8 |
Country |
string |
0 |
abcdefg |
Country |
9 |
ShopID |
string |
0 |
abcdefg |
Shop ID |
10 |
OrderNr |
integer |
0 |
123 |
pixi* internal order number |
11 |
OrderNrExternal |
string |
0 |
abcdefg |
External order number |
12 |
InvoiceNr |
string |
0 |
abcdefg |
Invoice number |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiCustomerSearch>
<dem:RowCount>123</dem:RowCount>
<dem:CustNrExternal>abcdefg</dem:CustNrExternal>
<dem:eMail>abcdefg</dem:eMail>
<dem:Name>abcdefg</dem:Name>
<dem:Address>abcdefg</dem:Address>
<dem:City>abcdefg</dem:City>
<dem:Zip>abcdefg</dem:Zip>
<dem:Country>abcdefg</dem:Country>
<dem:ShopID>abcdefg</dem:ShopID>
<dem:OrderNr>123</dem:OrderNr>
<dem:OrderNrExternal>abcdefg</dem:OrderNrExternal>
<dem:InvoiceNr>abcdefg</dem:InvoiceNr>
</dem:pixiCustomerSearch>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Customer data
# |
Name |
Type |
Description |
1 |
AddrKey |
integer |
Billing Address ID |
2 |
AddrNr |
string |
Address number |
3 |
Name |
string |
Name |
4 |
City |
string |
City |
5 |
ZIP |
string |
Postal code |
6 |
AddrType |
string |
Address type (B-Billing, S-Shipping) |
7 |
Address |
string |
Address |
8 |
Country |
string |
Country |
9 |
BirthDate |
string |
Birth date |
10 |
CareOf |
string |
Company name |
11 |
CntName |
string |
Country Name |
12 |
CustKey |
integer |
Customer ID |
13 |
CustomerOf |
string |
Shop ID |
14 |
CustomerNrExternal |
string |
External Reference to the Customer (imported from Shop) |
15 |
CPhone |
string |
Phone number |
16 |
CFax |
string |
Fax number |
17 |
NoInvoice |
string |
Do not create invoice for customer |
18 |
TaxOnInvoice |
string |
Add taxes to invoice total |
19 |
NoShipCosts |
string |
Do not charge ship costs |
20 |
Discountable |
string |
customer has discount |
21 |
ShipRef |
integer |
Shipping Address ID |
22 |
CustLock |
string |
Indicator if customer is locked. (No shipping allowed) |
23 |
CeMail |
string |
Customers eMail |
24 |
CHisNote |
string |
Note |
25 |
Rabat |
number |
Customer discount |
26 |
LastOrderDate |
string |
Date of last order |
27 |
LastShipDate |
string |
Date of last shipment |
28 |
NrOfAllOrders |
integer |
Number of all orders for customer |
29 |
NrOfOpenedOrders |
integer |
Number of open orders for customer |
30 |
ShipVendorName |
string |
Shipping vendor name |
31 |
LastOrderComment |
string |
Commnet from last order |
32 |
DatevUserAccount |
string |
Datev user account/number |
33 |
OpenReturnCasesExist |
boolean |
Customer has open return cases |
34 |
DisableAutoEmailCreation |
boolean |
Disable auto email creation flag |
35 |
MaskStatus |
string |
Status of masking the customer (GDPR) |
36 |
MaskDate |
string |
Date of when the masking of customer did/will take place (GDPR) |
Additional Notes
When filtering the result set by Datev user account/number (DatevUserAccount) take care that database setting *SearchExactCustomerNr* is set to 0 (OFF).