pixiCustomerSearch

Recommended

API call returns customer data based on provided filter parameters.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: When filtering the result set by Datev user account/number (DatevUserAccount) take care that database setting SearchExactCustomerNr is set to 0 (OFF).


Request

POST https://apigateway.descartes.com/tms/pixi/pixiCustomerSearch

Request body

Name Type Required Description
Zip string false

Postal code

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

City string false

City

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Name string false

Name

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

eMail string false

E-mail

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

ShopID string false

Shop ID

Type: varchar(3)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Address string false

Address

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Country string false

Country

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNr integer false

pixi* internal order number

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

RowCount integer false

Number of records to return

Type: int

Default value: 1500

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

InvoiceNr string false

Invoice number

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

CustNrExternal string false

External customer number or Datev user account/number

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNrExternal string false

External order number

Type: varchar(255)

Default value: %

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. Customer data

Name Type Description
ZIP string

Postal code

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)

CFax string

Fax number

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

City string

City

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

Name string

Name

Type: varchar (121)

Available from: 25.06 (25.6.0.58802)

Rabat number

Customer discount

Type: numeric

Available from: 25.06 (25.6.0.58802)

AddrNr string

Address number

Type: varchar (13)

Available from: 25.06 (25.6.0.58802)

CPhone string

Phone number

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

CareOf string

Company name

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)

CeMail string

Customers eMail

Type: varchar (256)

Available from: 25.06 (25.6.0.58802)

AddrKey integer

Billing Address ID

Type: int

Available from: 25.06 (25.6.0.58802)

Address string

Address

Type: varchar (110)

Available from: 25.06 (25.6.0.58802)

CntName string

Country Name

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)

Country string

Country

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

CustKey integer

Customer ID

Type: int

Available from: 25.06 (25.6.0.58802)

ShipRef integer

Shipping Address ID

Type: int

Available from: 25.06 (25.6.0.58802)

AddrType string

Address type (B-Billing, S-Shipping)

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)

CHisNote string

Note

Type: varchar (1000)

Available from: 25.06 (25.6.0.58802)

CustLock string

Indicator if customer is locked. (No shipping allowed)

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)

MaskDate string

Date of when the masking of customer did/will take place (GDPR)

Type: date

Available from: 25.06 (25.6.0.58802)

BirthDate string

Birth date

Type: datetime

Available from: 25.06 (25.6.0.58802)

NoInvoice string

Do not create invoice for customer

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)

CustomerOf string

Shop ID

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

MaskStatus string

Status of masking the customer (GDPR)

Type: smallint

Available from: 25.06 (25.6.0.58802)

NoShipCosts string

Do not charge ship costs

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)

Discountable string

customer has discount

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)

LastShipDate string

Date of last shipment

Type: datetime

Available from: 25.06 (25.6.0.58802)

TaxOnInvoice string

Add taxes to invoice total

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)

LastOrderDate string

Date of last order

Type: datetime

Available from: 25.06 (25.6.0.58802)

NrOfAllOrders integer

Number of all orders for customer

Type: int

Available from: 25.06 (25.6.0.58802)

ShipVendorName string

Shipping vendor name

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

DatevUserAccount string

Datev user account/number

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)

LastOrderComment string

Commnet from last order

Type: varchar (255)

Available from: 25.06 (25.6.0.58802)

NrOfOpenedOrders integer

Number of open orders for customer

Type: int

Available from: 25.06 (25.6.0.58802)

CustomerNrExternal string

External Reference to the Customer (imported from Shop)

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)

OpenReturnCasesExist boolean

Customer has open return cases

Type: bit

Available from: 25.06 (25.6.0.58802)

DisableAutoEmailCreation boolean

Disable auto email creation flag

Type: bit

Available from: 25.06 (25.6.0.58802)