pixi Developer & Integration Documentation

pixiReadOrderHeader

Description

API Call to retrieve all relevant orders


Request Parameters

#

Name

Type

Required

Example

Description

1

OrderHeaderKey

integer

0

123

pixi* Orderheader Key

2

OrderNr

integer

0

123

pixi* OrderNr

3

CreateDateFrom

string

0

YYYY-MM-DD hh:mm:ss

Create Date from (including)

4

CreateDateTo

string

0

YYYY-MM-DD hh:mm:ss

Create Date to (excluding)

5

UpdateDateFrom

string

0

YYYY-MM-DD hh:mm:ss

Update Date from (including)

6

UpdateDateTo

string

0

YYYY-MM-DD hh:mm:ss

Update Date To (excluding)

7

CreateAndUpdateDateFrom

string

0

YYYY-MM-DD hh:mm:ss

Create or Update Date from (including)

8

CreateAndUpdateDateTo

string

0

YYYY-MM-DD hh:mm:ss

Create or Update Date to (excluding)

9

RowCount

integer

0

123

Number of rows returned. Defaults to 1000 if omitted. (The maximum allowed value is set to 100 000)


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:pixiReadOrderHeader>
         <dem:OrderHeaderKey>123</dem:OrderHeaderKey>
         <dem:OrderNr>123</dem:OrderNr>
         <dem:CreateDateFrom>YYYY-MM-DD hh:mm:ss</dem:CreateDateFrom>
         <dem:CreateDateTo>YYYY-MM-DD hh:mm:ss</dem:CreateDateTo>
         <dem:UpdateDateFrom>YYYY-MM-DD hh:mm:ss</dem:UpdateDateFrom>
         <dem:UpdateDateTo>YYYY-MM-DD hh:mm:ss</dem:UpdateDateTo>
         <dem:CreateAndUpdateDateFrom>YYYY-MM-DD hh:mm:ss</dem:CreateAndUpdateDateFrom>
         <dem:CreateAndUpdateDateTo>YYYY-MM-DD hh:mm:ss</dem:CreateAndUpdateDateTo>
         <dem:RowCount>123</dem:RowCount>
      </dem:pixiReadOrderHeader>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Result set

#

Name

Type

Description

1

OrderHeaderKey

integer

OrderHeaderKey

2

OrderNr

integer

OrderNr

3

ShipVendorCode

string

ShipVendorCode

4

GiftMessage

string

GiftMessage

5

ShipInstruct

string

ShipInstruct

6

Discount

string

Discount

7

IPAddress

string

IPAddress

8

CCPPaymentInfoOK

string

CCPPaymentInfoOK

9

CCPLastAuthCode

string

CCPLastAuthCode

10

CCPNumOfTries

integer

CCPNumOfTries

11

CCPReauthorizeYN

string

CCPReauthorizeYN

12

CreateEmp

string

CreateEmp

13

CreateDate

string

CreateDate

14

UpdateEmp

string

UpdateEmp

15

UpdateDate

string

UpdateDate

16

CustRef

integer

CustRef

17

AddrRef

integer

AddrRef

18

ShipAdrRef

integer

ShipAdrRef

19

rowguid

integer

rowguid

20

OhSCostCharged

string

OhSCostCharged

21

OhShippingNote

string

OhShippingNote

22

OhChargeShipCost

string

OhChargeShipCost

23

OhWrapType

string

OhWrapType

24

OhWrapMessage

string

OhWrapMessage

25

OhSCostChargeType

integer

OhSCostChargeType

26

OhSCostFirstItemCharged

string

OhSCostFirstItemCharged

27

OhShipImmed

string

OhShipImmed

28

OhSLocked

string

OhSLocked

29

OhGosF1

string

OhGosF1

30

OhGosF2

string

OhGosF2

31

OhWaitDays

integer

OhWaitDays

32

OhShipID

string

OhShipID

33

Address_Remarks

string

Address_Remarks

34

Verfahren

string

Verfahren

35

Product

string

Product

36

Extras

string

Extras

37

ShipDate

string

ShipDate

38

ChangeDate

string

ChangeDate

39

ChangeSequence

integer

ChangeSequence

40

ChangeReported

string

ChangeReported

41

ExtraShippingCharged

string

ExtraShippingCharged

42

ccpPayID

string

ccpPayID

43

ccpSetFailTries

integer

ccpSetFailTries

44

ccpSetFailLastTime

string

ccpSetFailLastTime

45

PaidBySwiftRef

string

PaidBySwiftRef

46

ShopNote

string

ShopNote

47

PaidByCustomer

string

PaidByCustomer

48

OhCCPmerchantID

string

OhCCPmerchantID

49

ShipCost

string

ShipCost

50

AutoReservationDone

boolean

AutoReservationDone

51

ForceToPicklistIfNotFULL

boolean

ForceToPicklistIfNotFULL

52

DFType

integer

DFType

53

ManualResDate

string

ManualResDate

54

OHMultiForceToPicklist

boolean

OHMultiForceToPicklist

55

OHCancelAfterForcedShipOut

boolean

OHCancelAfterForcedShipOut

56

SubShopLogo

string

SubShopLogo

57

SubShopName

string

SubShopName

58

Referrer

string

Referrer

59

AutoPaymentCreated

boolean

AutoPaymentCreated

60

ResOnLocDate

string

ResOnLocDate

61

ChannelRef

integer

ChannelRef

62

OrderNrExternal

string

OrderNrExternal

63

OrderStatus

string

OrderStatus

64

OrderLinesTotal

string

OrderLinesTotal

65

OrderLinesDiscount

string

OrderLinesDiscount

66

OrderTotal

string

OrderTotal

67

CurrencyId

integer

CurrencyId

68

ExchRateId

integer

ExchRateId — only populated when system setting MultiCurrencyEnabled = 1; otherwise NULL


Additional Notes

This call supports several mutually exclusive query modes, evaluated in this priority order:

  1. Combined create/update date rangeCreateAndUpdateDateFrom / CreateAndUpdateDateTo

  2. Create date rangeCreateDateFrom / CreateDateTo

  3. Update date rangeUpdateDateFrom / UpdateDateTo

  4. Key-based paginationOrderHeaderKey + RowCount

  5. Single order lookupOrderHeaderKey or OrderNr

Pagination is key-based: results always have OrderHeaderKey greater than the supplied OrderHeaderKey (the supplied key is excluded), ordered ascending. If RowCount is omitted it defaults to 1000; the maximum is capped at 100,000.