pixiGetOrderHeadersForCustomer

Returns orders for given customer

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Provides detailed information on customers orders. Customer may be specified by either Customer ID (CustKey parameter) or shop customer Nr (CustomerNrExternal parameter either in combination with a filter by shop or not). Either CustKey or CustomerNrExternal should be provided, otherwise no results are produced


Request

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

Request body

Name Type Required Description
ShopID string false

Shop ID

Type: varchar(3)

Default value: NULL

Example: SHP

Available from: LOU Official (6.3.0.4452)

CustKey integer false

Customer ID, references table customers

Type: int

Default value: 0

Example: 123

Available from: LOU Official (6.3.0.4452)

OrderStatus string false

Order Status

Type: varchar(10)

Default value: NULL

Example: OPEN, HOLD, CLOSED

Available from: 24.06 (24.6.0.49012)

OrderDateFrom string false

Order Date From

Type: datetime

Default value: NULL

Example: 2024-05-31

Available from: 24.06 (24.6.0.49012)

CustomerNrExternal string false

Shop customer number

Type: varchar(60)

Default value:

Example: 1234ABC

Available from: LOU Official (6.3.0.4452)


Response

1. Customer's orders

Name Type Description
Blz string

Bank identification related to LS payment type

Type: varchar

Available from: 25.06 (25.6.0.58802)

ZIP string

ZIP code from the customer's address

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShopID string

ID of the shop through which the order has been made

Type: varchar

Available from: 25.06 (25.6.0.58802)

Account string

Account information related to LS payment type

Type: varchar

Available from: 25.06 (25.6.0.58802)

AddrRef integer

ID of the customer address record

Type: int

Available from: 25.06 (25.6.0.58802)

CustKey integer

ID of the customer record

Type: int

Available from: 25.06 (25.6.0.58802)

OrderNr integer

pixi* Order Number

Type: int

Available from: 25.06 (25.6.0.58802)

BankName string

Bank name related to LS payment type

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardNr string

Number of the credit card used for payment

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipCost number

Cost of the shipment

Type: money

Available from: 25.06 (25.6.0.58802)

ShipDate string

Oldest scan-out date of all ordered items

Type: datetime

Available from: 25.06 (25.6.0.58802)

ShopNote string

Note received with this order from the shop

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardExp string

Expiration date on the credit card used for payment

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderDate string

Date of the order

Type: datetime

Available from: 25.06 (25.6.0.58802)

VoucherID string

Voucher associated with the order (if any)

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardName string

Name on the credit card used for payment

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardType string

Type of the credit card used for payment

Type: varchar

Available from: 25.06 (25.6.0.58802)

CreateDate string

Date of creation of the order header record

Type: datetime

Available from: 25.06 (25.6.0.58802)

OrderTotal number

Total due amount on this order (including discounts, shipping, rounding etc)

Type: money

Available from: 25.06 (25.6.0.58802)

ShipVendor string

Code of the ship vendor chosen for the order

Type: varchar

Available from: 25.06 (25.6.0.58802)

TrackingID string

Tracking ID of the order

Type: varchar

Available from: 25.06 (25.6.0.58802)

AccountName string

Name on the account related to LS payment type

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderLocked string

Y/N flag indicating whether the order is locked

Type: varchar

Available from: 25.06 (25.6.0.58802)

PaymentType string

Code of payment type

Type: char

Available from: 25.06 (25.6.0.58802)

LastShipDate string

Newest scan-out date of all ordered items

Type: datetime

Available from: 25.06 (25.6.0.58802)

VoucherAmount number

Amount covered with the associated voucher

Type: money

Available from: 25.06 (25.6.0.58802)

AddressRemarks string

Address-related comments

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderHeaderKey integer

ID of the order header record

Type: int

Available from: 25.06 (25.6.0.58802)

OrderNrExternal string

Shop order number

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderlinesTotal number

Price of all the ordered items

Type: money

Available from: 25.06 (25.6.0.58802)

WholeOrderState string

Status of the order

Type: varchar

Available from: 25.06 (25.6.0.58802)

PaymentAddressId integer

ID of the Address record associated with payment address for this order

Type: int

Available from: 25.06 (25.6.0.58802)

OrderCurrencyCode string

Currency code used on the order

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipmentAddressId integer

ID of the Address record associated with shipment address for this order

Type: int

Available from: 25.06 (25.6.0.58802)