pixiGetCustomerList

Get customers invoice and billing data.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

    Return currency code in field BaseCurrency depend on if Multi Currency is Enabled then we:
    - calculate and return data in base currency per customer 
    else 
    - calculate and return data in order / original currency (with value NULL for currency code)

Request

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

Request body

Name Type Required Description
StartCustKey integer false

Start Customer Id

Type: int

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. Result set

Name Type Description
ZIP string

ZIP

Type: varchar

Available from: 25.06 (25.6.0.58802)

Name string

Name

Type: varchar

Available from: 25.06 (25.6.0.58802)

EMail string

EMail

Type: varchar

Available from: 25.06 (25.6.0.58802)

CareOf string

CareOf

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShopID string

ShopID

Type: varchar

Available from: 25.06 (25.6.0.58802)

Address string

Address

Type: varchar

Available from: 25.06 (25.6.0.58802)

Country string

Country

Type: varchar

Available from: 25.06 (25.6.0.58802)

CustKey integer

Reference to the customer to use in other API Calls

Type: int

Available from: 25.06 (25.6.0.58802)

Lastname string

Lastname

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipLock string

Is the customer locked?

Type: varchar

Available from: 25.06 (25.6.0.58802)

Firstname string

Firstname

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderCount integer

Number of orders. Note: not invoices! An order can be canceled, but will still count at an order.

Type: int

Available from: 25.06 (25.6.0.58802)

Salutation string

Salutation

Type: varchar

Available from: 25.06 (25.6.0.58802)

ReturnCount integer

Number of returns

Type: int

Available from: 25.06 (25.6.0.58802)

ReturnValue integer

complete value of all returns.

Type: int

Available from: 25.06 (25.6.0.58802)

BaseCurrency string

BaseCurrency

Type: varchar

Available from: 25.06 (25.6.0.58802)

Turnover_all integer

All positive turnover, that is, all items shipped to the customer.

Type: int

Available from: 25.06 (25.6.0.58802)

ItemCount_all integer

Number of all items shipped to the customer.

Type: int

Available from: 25.06 (25.6.0.58802)

ReminderLevel integer

Highest reminderlevel of an invoice of the customer

Type: int

Available from: 25.06 (25.6.0.58802)

CustomerNrExternal string

External CustomerNR, Linking the customer to the shop

Type: varchar

Available from: 25.06 (25.6.0.58802)

DaysSinceLastOrder integer

Days since the customer place last time an order.

Type: int

Available from: 25.06 (25.6.0.58802)

DaysSinceFirstOrder integer

Days since the first order of the customer.

Type: int

Available from: 25.06 (25.6.0.58802)

Turnover_avgPerOrder integer

Average turnover per shipment to the customer.

Type: int

Available from: 25.06 (25.6.0.58802)