pixi Developer & Integration Documentation

pixiGetOrderHeaderList

Description

Retrieves comprehensive order header data for multiple orders specified via XML. Supports batch lookups by external order number.


Request Parameters

#

Name

Type

Required

Example

Description

1

OrderNrExternalXml

string

1

See XML structure below

Simple XML input parameter with list of OrderNrExternal.


XML Structure

<OrderNrExternal>
<i>ORD-2025-00417</i>
<i>ORD-2025-00823</i>
<i>ORD-2025-01205</i>
</OrderNrExternal>


Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiGetOrderHeaderList>
<dem:OrderNrExternalXml>
<OrderNrExternal>
<i>ORD-2025-00417</i>
<i>ORD-2025-00823</i>
<i>ORD-2025-01205</i>
</OrderNrExternal>
</dem:OrderNrExternalXml>
</dem:pixiGetOrderHeaderList>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Order header data for each matching order

#

Name

Type

Description

1

OrderHeaderKey

integer

ID of the order header record

2

OrderNr

integer

pixi Order Number

3

CreateDate

datetime

Create date

4

OrderNrExternal

string

External order number

5

OrderTotal

number

Order Total

6

OrderlinesTotal

number

Orderlines Total

7

WholeOrderState

string

Status of the order

8

Shipdate

datetime

Earliest ship date of the order

9

LastShipdate

datetime

Latest ship date

10

TrackingID

string

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

11

ShipVendor

string

Shipping vendor code

12

ShopID

string

Shop ID

13

OrderDate

datetime

Order Date

14

ShipCost

number

The total shipping costs of the whole order

15

PaymentAddressId

integer

Payment Address Id

16

ShipmentAddressId

integer

Shipment Address Id

17

ShopNote

string

Note received with this order from the shop

18

PaymentType

string

Payment type code

19

VoucherID

string

ID of the voucher

20

VoucherAmount

number

Amount covered with the associated voucher

21

CcCardType

string

Type of creditcard

22

CcCardNr

string

Number of the credit card used for payment

23

CcCardName

string

Name of the credit institute

24

CcCardExp

string

Expiry date of the creditcard

25

Account

string

Account

26

Blz

string

Bank Code

27

BankName

string

Name of the Bank

28

AccountName

string

Name of the owner of this bank account

29

AddressRemarks

string

Address Remarks

30

CustKey

integer

Customer ID

31

SalutationText

string

Salutation text (e.g. Herr, Frau, Mr., Mrs.)

32

Gender

integer

Gender (0=Unknown, 1=Male, 2=Female)

33

LastName

string

Last Name

34

FirstName

string

First Name

35

ShippingCountry

string

Shipping Country

36

ZIP

string

ZIP

37

City

string

City

38

Street

string

Street

39

BirthDate

datetime

Birth Date

40

CustomerNr

string

Customer Number

41

SubShopName

string

Sub Shop Name

42

SubShopLogo

string

Sub Shop Logo

43

Referrer

string

Referrer

44

GiftMessage

string

Gift Message

45

OrderCurrency

string

Order Currency

46

OrderTotal_OrderCurr

number

Order Total in Order Currency

47

Paid

boolean

Paid

48

PayedSum

number

Payed Sum

49

CustomerEmail

string

Customer Email

50

CustomerNrExternal

string

External Reference to the Customer (imported from Shop)

51

EstimatedDelivery

datetime

Estimated Delivery

52

OrderLocked

string

Y/N flag indicating whether the order is locked

53

LastInvoiceNr

string

Last Invoice Number


Additional Notes

The OrderNrExternalXml parameter expects XML wrapped in an outer element. Each order is specified in an <i> tag. See the XML Structure section above for the exact format.

When passing XML inside a SOAP envelope, wrap the XML content in a CDATA section instead of entity-encoding it (for example: <dem:OrderNrExternalXml><![CDATA[<OrderNrExternal>...</OrderNrExternal>]]></dem:OrderNrExternalXml>).

The procedure returns one row per matching order. Orders not found in the database are silently skipped — no error is returned for non-matching external order numbers.

Results are ordered by CreateDate ascending (oldest first).