Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetCustomerOrderAccount

Pixi-Docs
Old Pixi-Docs

Returns orders for given customer.

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

General

Request

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

Request body

Name Type Required Description
CustKey integer true

Required Customer ID, references table customers.

Type: int

Default value:

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderDateTo string false

Additional filter by Order date to.

Type: datetime

Default value: NULL

Example: 2017-12-31 23:59:96

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderDateFrom string false

Additional filter by Order date from.

Type: datetime

Default value: NULL

Example: 2017-01-01 00:00:00

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetCustomerOrderAccount>
      <CustKey>0</CustKey>
      <OrderDateFrom>string</OrderDateFrom>
      <OrderDateTo>string</OrderDateTo>
    </pixiGetCustomerOrderAccount>
  </Body>
</Envelope>

Response

1. Customer information

Name Type Description
CeMail string

Customers eMail

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
AddrRef integer

Billing Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
CustomerLocked string

Information if a customer is locked or not. Returns char(1) - N - no, customer is not locked. Y - yes, customer is locked. (Reason for the lock can be found in the "Comment" Field returned by the same call)

Type: varchar

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)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

2. Detail customer information

Name Type Description
Fax string

Fax

Type: varchar

Available from: 25.06 (25.6.0.58802)
ZIP string

ZIP

Type: varchar

Available from: 25.06 (25.6.0.58802)
City string

City

Type: varchar

Available from: 25.06 (25.6.0.58802)
Fax2 string

Fax2

Type: varchar

Available from: 25.06 (25.6.0.58802)
Name string

Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
Note string

Note

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCCVC string

CC CVC

Type: varchar

Available from: 25.06 (25.6.0.58802)
Name2 string

Name 2

Type: varchar

Available from: 25.06 (25.6.0.58802)
Phone string

Phone

Type: varchar

Available from: 25.06 (25.6.0.58802)
State string

State

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATID string

VAT ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
ZIPMB string

ZIP MB

Type: varchar

Available from: 25.06 (25.6.0.58802)
eMail string

E-Mail address

Type: varchar

Available from: 25.06 (25.6.0.58802)
AddrNr string

Address Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
Anrede string

Salutation

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCName string

CC Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCType string

CC Type

Type: varchar

Available from: 25.06 (25.6.0.58802)
CareOf string

Customer of

Type: varchar

Available from: 25.06 (25.6.0.58802)
Phone2 string

Phone2

Type: varchar

Available from: 25.06 (25.6.0.58802)
Street string

Street

Type: varchar

Available from: 25.06 (25.6.0.58802)
eMail2 string

E-Mail address 2

Type: varchar

Available from: 25.06 (25.6.0.58802)
AddrKey integer

Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
Address string

Address

Type: varchar

Available from: 25.06 (25.6.0.58802)
BankBIC string

Bank BIC

Type: varchar

Available from: 25.06 (25.6.0.58802)
BankBLZ string

Bank BLZ

Type: varchar

Available from: 25.06 (25.6.0.58802)
Country string

Country

Type: varchar

Available from: 25.06 (25.6.0.58802)
HouseNr string

House Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
Mailbox string

Mailbox

Type: varchar

Available from: 25.06 (25.6.0.58802)
AddrType string

Address Type

Type: varchar

Available from: 25.06 (25.6.0.58802)
BankIBAN string

Bank IBAN

Type: varchar

Available from: 25.06 (25.6.0.58802)
BankName string

Name of the Bank

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCExpiry string

CC Expiry

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCNumber string

CC Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
LastName string

Last Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
BirthDate string

Birth Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
FirstName string

First Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
CntCodeISO2 string

Country Code ISO2

Type: char

Available from: 25.06 (25.6.0.58802)
CntCodeISO3 string

Country Code ISO3

Type: char

Available from: 25.06 (25.6.0.58802)
PaymentType string

Payment type code

Type: varchar

Available from: 25.06 (25.6.0.58802)
AddressLocked string

Address Locked

Type: varchar

Available from: 25.06 (25.6.0.58802)
BankAccountName string

Bank Account Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
BankAccountNumber string

Bank Account Number

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

3. Customer orders information filtered by date range

Name Type Description
DFType integer

DF Type

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)
CCAuthID string

CC Authorization ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
Referrer string

Referrer

Type: varchar

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)
DHLExtras string

DHL Extras

Type: varchar

Available from: 25.06 (25.6.0.58802)
DHLProdukt string

DHL Produkt

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderTotal number

Order Total

Type: money

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)
OrderStatus string

Order Status

Type: varchar

Available from: 25.06 (25.6.0.58802)
SubShopLogo string

Sub Shop Logo

Type: varchar

Available from: 25.06 (25.6.0.58802)
SubShopName string

Sub Shop Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
DHLVerfahren string

DHL Verfahren

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShipInstruct string

Ship Instruct

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderDiscount number

Order Discount

Type: money

Available from: 25.06 (25.6.0.58802)
AddressRemarks string

Address Remarks

Type: varchar

Available from: 25.06 (25.6.0.58802)
BillingAddrRef integer

Billing Address ID

Type: int

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)
ShipVendorCode string

Shipping vendor code

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)
OrderlinesTotal number

Orderlines Total

Type: money

Available from: 25.06 (25.6.0.58802)
ShippingAddrRef integer

Shipping Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
OrderCurrencyCode string

Order Currency Code

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderlinesDiscount number

Orderlines Discount

Type: money

Available from: 25.06 (25.6.0.58802)
PartialDeliveryActive boolean

Partial Delivery Active

Type: bit

Available from: 25.06 (25.6.0.58802)
CancelUnavailableItems boolean

Cancel Unavailable Items

Type: bit

Available from: 25.06 (25.6.0.58802)
PartialDeliveryForRemaining boolean

Partial Delivery For Remaining

Type: bit

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

4. Customer orderlines information (including reservations)

Name Type Description
Qty integer

Quantity

Type: int

Available from: 25.06 (25.6.0.58802)
BoxNr integer

Box Number

Type: int

Available from: 25.06 (25.6.0.58802)
Price number

Price

Type: money

Available from: 25.06 (25.6.0.58802)
DFType string

DF Type

Type: varchar

Available from: 25.06 (25.6.0.58802)
EANUPC string

Item barcode

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvRef integer

Invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
ResQty string

Reserved Quantity

Type: bigint

Available from: 25.06 (25.6.0.58802)
Status string

Status

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderNr integer

pixi Order Number

Type: int

Available from: 25.06 (25.6.0.58802)
SupplNr string

Supplier number (code)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Discount string

Discount (Net value in case of B2B Invoice)

Type: smallint

Available from: 25.06 (25.6.0.58802)
ItemNote string

Item Note

Type: varchar

Available from: 25.06 (25.6.0.58802)
SerialNr string

Item serial number

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)
FullPrice number

Full Price

Type: money

Available from: 25.06 (25.6.0.58802)
ItemNrInt string

Shop item number

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrdShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderDate string

Order Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
DFShipDate string

DF Ship Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
LineItemID string

Line Item ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
LocationID string

Location ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
SupplPrice number

Supplier price of the item

Type: money

Available from: 25.06 (25.6.0.58802)
VATPercent number

VAT Percent

Type: numeric

Available from: 25.06 (25.6.0.58802)
ArticleName string

Article Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemNrSuppl string

Supplier item number

Type: varchar

Available from: 25.06 (25.6.0.58802)
DiscountPerc number

Discount Percent

Type: numeric

Available from: 25.06 (25.6.0.58802)
OrderlineKey integer

ID for the Orderline record

Type: int

Available from: 25.06 (25.6.0.58802)
DiscountValue number

Discount Value

Type: money

Available from: 25.06 (25.6.0.58802)
OrderCurrency string

Order Currency

Type: varchar

Available from: 25.06 (25.6.0.58802)
SOrderlineRef integer

Supplier Orderline ID

Type: int

Available from: 25.06 (25.6.0.58802)
BillingAddrRef integer

Billing Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
PickListNrUsed integer

Pick List Number Used

Type: int

Available from: 25.06 (25.6.0.58802)
ShippingAddrRef integer

Shipping Addrress ID

Type: int

Available from: 25.06 (25.6.0.58802)
EstimatedDelivery string

Estimated Delivery

Type: datetime

Available from: 25.06 (25.6.0.58802)
InvoiceNrExternal string

Invoice Number External

Type: varchar

Available from: 25.06 (25.6.0.58802)
LastOrdLocationID string

Last Order Location ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
RealSOrderlineRef integer

Real Supplier Orderline ID

Type: int

Available from: 25.06 (25.6.0.58802)
BundleOrderlineRef integer

Bundle Orderline ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShipCost_OrderCurr number

Ship Cost Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
DFShipmentTrackingID string

Direct fullfilement shipment tracking ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
OriginalOrderlineRef integer

Original Orderline ID

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

5. Customer bundle orderlines information

Name Type Description
Qty integer

Quantity

Type: int

Available from: 25.06 (25.6.0.58802)
BoxNr integer

Box Number

Type: int

Available from: 25.06 (25.6.0.58802)
Price number

Price

Type: money

Available from: 25.06 (25.6.0.58802)
DFType string

DF Type

Type: varchar

Available from: 25.06 (25.6.0.58802)
EANUPC string

Item barcode

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvRef integer

Invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
Status string

Status

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderNr integer

pixi Order Number

Type: int

Available from: 25.06 (25.6.0.58802)
SupplNr string

Supplier number (code)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Discount string

Discount

Type: smallint

Available from: 25.06 (25.6.0.58802)
ItemNote string

Item Note

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)
FullPrice number

Full Price

Type: money

Available from: 25.06 (25.6.0.58802)
ItemNrInt string

Shop item number

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrdShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderDate string

Order Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
LineItemID string

Line Item ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
LocationID string

Location ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
SupplPrice number

Supplier price of the item

Type: money

Available from: 25.06 (25.6.0.58802)
VATPercent number

VAT Percent

Type: numeric

Available from: 25.06 (25.6.0.58802)
ArticleName string

Article Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemNrSuppl string

Supplier item number

Type: varchar

Available from: 25.06 (25.6.0.58802)
DiscountPerc number

Discount Perc

Type: numeric

Available from: 25.06 (25.6.0.58802)
OrderlineKey integer

ID for the Orderline record

Type: int

Available from: 25.06 (25.6.0.58802)
DiscountValue number

Discount Value

Type: money

Available from: 25.06 (25.6.0.58802)
OrderCurrency string

Order Currency

Type: varchar

Available from: 25.06 (25.6.0.58802)
BillingAddrRef integer

Billing Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShippingAddrRef integer

Shipping Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
LastOrdLocationID string

Last Order Location ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShipCost_OrderCurr number

Ship Cost Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
OriginalOrderlineRef integer

Original Orderline ID

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

6. Customer invoices information

Name Type Description
BoxNr integer

Box Number

Type: int

Available from: 25.06 (25.6.0.58802)
Payed string

Payed

Type: datetime

Available from: 25.06 (25.6.0.58802)
Total number

Total

Type: money

Available from: 25.06 (25.6.0.58802)
VATNo string

VAT Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
PayDay string

Pay Day

Type: datetime

Available from: 25.06 (25.6.0.58802)
VATLow number

VAT Low Amount

Type: money

Available from: 25.06 (25.6.0.58802)
BankBLZ string

Bank BLZ

Type: varchar

Available from: 25.06 (25.6.0.58802)
DueDate string

Due Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
InvDate string

Invoice Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
VATHigh number

VAT High Amount

Type: money

Available from: 25.06 (25.6.0.58802)
CCPPayID string

ID of credit card payment

Type: varchar

Available from: 25.06 (25.6.0.58802)
Discount number

Discount

Type: money

Available from: 25.06 (25.6.0.58802)
PayedSum number

Payed Sum

Type: money

Available from: 25.06 (25.6.0.58802)
VATHText string

Text representation of high VAT

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATLText string

Text representation of low VAT

Type: varchar

Available from: 25.06 (25.6.0.58802)
ChargeVAT string

The flag that marks if the VAT should be charged

Type: char

Available from: 25.06 (25.6.0.58802)
InvShopID string

Invoice Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

pixi Invoice Number

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)
InvoiceKey integer

Invoice ID

Type: int

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)
VATBaseLow number

VAT BaseLow

Type: money

Available from: 25.06 (25.6.0.58802)
VATLowPerc number

The VAT percent of low VAT

Type: numeric

Available from: 25.06 (25.6.0.58802)
InvShipLock string

Invoice Ship Lock

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)
ScanOutDate string

Invoice ship out date

Type: datetime

Available from: 25.06 (25.6.0.58802)
VATBaseHigh number

VAT BaseHigh

Type: money

Available from: 25.06 (25.6.0.58802)
VATHighPerc number

The VAT percent of high VAT

Type: numeric

Available from: 25.06 (25.6.0.58802)
ReturnReason string

Return Reason

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvLocationID string

Invoice Location ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderCurrency string

Order Currency

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATinShipCost string

VAT in Ship Cost

Type: varchar

Available from: 25.06 (25.6.0.58802)
BillingAddrRef integer

Billing Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
RefToInvoiceNr string

Reference to the original invoice number in case of returns

Type: varchar

Available from: 25.06 (25.6.0.58802)
Total_ShipCost number

The total of ship costs

Type: money

Available from: 25.06 (25.6.0.58802)
BankAccountName string

Bank Account Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
RefToInvoiceKey integer

Reference to the original invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShippingAddrRef integer

Shipping Address ID

Type: int

Available from: 25.06 (25.6.0.58802)
Total_OrderCurr number

Total Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
PackageNetWeight number

Package Net Weight

Type: decimal

Available from: 25.06 (25.6.0.58802)
ReturnTrackingID string

Return Tracking ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATLow_OrderCurr number

VAT Low Amount Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
BankAccountNumber string

Bank Account Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATHigh_OrderCurr number

VAT High Amount Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
PackageGrossWeight number

Package Gross Weight

Type: decimal

Available from: 25.06 (25.6.0.58802)
VATBaseLow_ShipCost number

VAT Base Low Amount Ship Cost

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseHigh_ShipCost number

VAT Base High Amount Ship Cost

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseLow_OrderCurr number

VAT Base Low Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseHigh_OrderCurr number

VAT Base High Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
Total_ShipCost_OrderCurr number

Total Ship Cost Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

7. Customer invoice lines information

Name Type Description
EANUPC string

Item barcode

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemQty integer

Item Quantity

Type: int

Available from: 25.06 (25.6.0.58802)
ItemRef integer

Item ID

Type: int

Available from: 25.06 (25.6.0.58802)
ItemVAT string

Item VAT

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemText string

Item Text

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderQty integer

Order Quantity

Type: int

Available from: 25.06 (25.6.0.58802)
SerialNr string

Item serial number

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)
FullPrice number

Full Price

Type: money

Available from: 25.06 (25.6.0.58802)
ItemPrice number

Item Price

Type: money

Available from: 25.06 (25.6.0.58802)
InvlineKey integer

Invline ID

Type: int

Available from: 25.06 (25.6.0.58802)
InvoiceRef integer

Invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
DiscountPerc number

Discount Perc

Type: numeric

Available from: 25.06 (25.6.0.58802)
ItemDiscount string

Item Discount

Type: smallint

Available from: 25.06 (25.6.0.58802)
OrderlineRef integer

Orderline ID

Type: int

Available from: 25.06 (25.6.0.58802)
DiscountValue number

Discount Value

Type: money

Available from: 25.06 (25.6.0.58802)
OrderCurrencyCode string

Order Currency Code

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShipCost_OrderCurr number

Ship Cost Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)
ItemPrice_OrderCurr number

Item Price Order Currency

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

8. Customer account financial summary information

Name Type Description
IsMatched boolean

Is Matched

Type: bit

Available from: 25.06 (25.6.0.58802)
OpenOrders number

Open Orders

Type: money

Available from: 25.06 (25.6.0.58802)
OpenToMatch number

Open To Match

Type: money

Available from: 25.06 (25.6.0.58802)
CurrencyCode string

Currency code

Type: varchar

Available from: 25.06 (25.6.0.58802)
SuggestedRefund number

Suggested Refund

Type: money

Available from: 25.06 (25.6.0.58802)
FinancialBalance number

Financial Balance

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

9. Customer account information

Name Type Description
Amount number

Amount

Type: money

Available from: 25.06 (25.6.0.58802)
Comment string

Comment

Type: varchar

Available from: 25.06 (25.6.0.58802)
EventID string

Event ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
Matched number

Matched

Type: money

Available from: 25.06 (25.6.0.58802)
DTAUSRef integer

DTAUS ID

Type: int

Available from: 25.06 (25.6.0.58802)
EventDate string

Event Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
Reference string

Reference

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceRef integer

Invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
BanklineRef integer

Bankline ID

Type: int

Available from: 25.06 (25.6.0.58802)
DoNotRefund boolean

Do Not Refund

Type: bit

Available from: 25.06 (25.6.0.58802)
CurrencyCode string

Currency code

Type: varchar

Available from: 25.06 (25.6.0.58802)
ManualBookingRef integer

Manual Booking ID

Type: int

Available from: 25.06 (25.6.0.58802)
CustomerAccountKey integer

Customer Account ID

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetCustomerOrderAccountPost200TextXmlResponse>
  <CustomerNrExternal>string</CustomerNrExternal>
  <ShopID>string</ShopID>
  <CeMail>string</CeMail>
  <CustomerLocked>string</CustomerLocked>
  <AddrRef>0</AddrRef>
</PixiGetCustomerOrderAccountPost200TextXmlResponse>

HTTP Example

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:pixiGetCustomerOrderAccount>
            <CustKey xsi:type="xsd:integer">123</CustKey> <!-- required -->
            <OrderDateTo xsi:type="xsd:string">2017-12-31 23:59:96</OrderDateTo>
            <OrderDateFrom xsi:type="xsd:string">2017-01-01 00:00:00</OrderDateFrom>
        </ns1:pixiGetCustomerOrderAccount>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetCustomerOrderAccount', [
    'CustKey' => '123', // integer (required)
    'OrderDateTo' => '2017-12-31 23:59:96', // string
    'OrderDateFrom' => '2017-01-01 00:00:00', // string
]);

function getPixiSoapClientResponse(string $method, array $arguments = [])
{
    $soapArguments = [];
    foreach ($arguments as $key => $value) {
        $soapArguments[] = new SoapVar($value, null, '', '', $key);
    }

    $soapClient = new SoapClient(null, [
        'login' => '...',
        'password' => '...',
        'uri' => 'https://apigateway.descartes.com/tms/pixi/',
        'location' => 'https://apigateway.descartes.com/tms/pixi/',
    ]);

    return $soapClient->__call($method, $soapArguments);
}