pixiGetOrderHeader

Retrieve Orderheaders based on several filters.

Since pixi version: LOU Official (6.3.0.4452) Additional notes:


Request

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

Request body

Name Type Required Description
ShopID string false

Shop ID

Type: char

Default value: NULL

Example: ABC

Available from: LOU Official (6.3.0.4452)

CustKey integer false

Customer ID, references table customers.

Type: int

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)

OrderNr integer false

pixi* order number

Type: int

Default value: 0

Example: 123

Available from: LOU Official (6.3.0.4452)

FromTime string false

Beginning of the order date range

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official (6.3.0.4452)

RowCount integer false

Maximum number of rows returned

Type: int

Default value: 1000

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

UntilTime string false

End of order date range

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official (6.3.0.4452)

PaymentType string false

Payment TYPE, references table payments

Type: char

Default value: NULL

Example: Single character : "g"

Available from: LOU Official (6.3.0.4452)

FromUpdateTime string false

Beginning of the order update date range

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: 18.07 (8.4.43.34931)

OrderNrExternal string false

Shop order number

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)

ShippingCountry string false

Shipping country reference

Type: varchar(3)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)


Response

1. Order details

Name Type Description
Blz string

Bank Code

Type: varchar

Available from: 25.06 (25.6.0.58802)

ZIP string

Postal code

Type: varchar

Available from: 25.06 (25.6.0.58802)

City string

City

Type: varchar

Available from: 25.06 (25.6.0.58802)

Tags string

Tag Names of an order separated by pipe symbol

Type: varchar

Available from: 25.06 (25.6.0.58802)

Gender integer

Gender

Type: int

Available from: 25.06 (25.6.0.58802)

ShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)

Street string

Street

Type: varchar

Available from: 25.06 (25.6.0.58802)

Account string

Bank account number

Type: varchar

Available from: 25.06 (25.6.0.58802)

CustKey integer

Customer ID

Type: int

Available from: 25.06 (25.6.0.58802)

HouseNr string

House number

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderNr integer

Order number in pixi*

Type: int

Available from: 25.06 (25.6.0.58802)

BankName string

Name of the Bank

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)

LastName string

Last Name

Type: varchar

Available from: 25.06 (25.6.0.58802)

Referrer string

Referrer link or text

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipCost number

The total shipping costs of the whole order

Type: money

Available from: 25.06 (25.6.0.58802)

Shipdate string

Ship this order at this date only! not before

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)

BirthDate string

Birth date

Type: datetime

Available from: 25.06 (25.6.0.58802)

CcCardExp string

Expiry date of the creditcard

Type: varchar

Available from: 25.06 (25.6.0.58802)

FirstName string

First Name

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderDate string

Shop order date (imported)

Type: datetime

Available from: 25.06 (25.6.0.58802)

OrderType string

Order type - B2B or B2C

Type: varchar

Available from: 25.06 (25.6.0.58802)

VoucherID string

ID of the voucher

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardName string

Name of the credit institute

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardType string

Type of creditcard

Type: varchar

Available from: 25.06 (25.6.0.58802)

CreateDate string

Create date

Type: datetime

Available from: 25.06 (25.6.0.58802)

CustomerNr string

Customer name

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderTotal number

Order total

Type: money

Available from: 25.06 (25.6.0.58802)

ShipVendor string

Shipping vendor code

Type: varchar

Available from: 25.06 (25.6.0.58802)

TrackingID string

Tracking ID of the shipment. Applies to the orders that have been shipped

Type: varchar

Available from: 25.06 (25.6.0.58802)

AccountName string

Name of the owner of this bank account

Type: varchar

Available from: 25.06 (25.6.0.58802)

GiftMessage string

Gift Message

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

Payment type code

Type: varchar

Available from: 25.06 (25.6.0.58802)

SubShopLogo string

Shop logo

Type: varchar

Available from: 25.06 (25.6.0.58802)

SubShopName string

Shop name

Type: varchar

Available from: 25.06 (25.6.0.58802)

DeliveryDate string

Delivery date

Type: datetime

Available from: 25.06 (25.6.0.58802)

LastShipdate string

Date of last (partial) shipment

Type: datetime

Available from: 25.06 (25.6.0.58802)

ShipInstruct string

Shipping instruction notes

Type: varchar

Available from: 25.06 (25.6.0.58802)

CustomerEmail string

Customer e-mail

Type: varchar

Available from: 25.06 (25.6.0.58802)

LastInvoiceNr string

Last invoice number connected to the order

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderCurrency string

Order currency

Type: varchar

Available from: 25.06 (25.6.0.58802)

TotalDiscount number

Total discount

Type: money

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

Notes related to the address

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)

SalutationText string

Salutation text

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderNrExternal string

External order number

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderShipVendor string

Shipping vendor for the order

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderlinesTotal number

Orderlines total

Type: money

Available from: 25.06 (25.6.0.58802)

ShippingCountry string

Shipping country

Type: varchar

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

Payment address ID

Type: int

Available from: 25.06 (25.6.0.58802)

EstimatedDelivery string

Estimated delivery of items on the order

Type: datetime

Available from: 25.06 (25.6.0.58802)

ShipmentAddressId integer

Shipment address ID

Type: int

Available from: 25.06 (25.6.0.58802)

CustomerNrExternal string

External Reference to the Customer (imported from Shop)

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderTotal_OrderCurr number

Order total

Type: money

Available from: 25.06 (25.6.0.58802)