pixi Developer & Integration Documentation

pixiGetOrderHeader

Description

Retrieve Orderheaders based on several filters.


Request Parameters

#

Name

Type

Required

Example

Description

1

OrderNr

integer

0

123

pixi* order number

2

OrderNrExternal

string

0

abcdefg

Shop order number

3

CustKey

integer

0

123

Customer ID, references table customers.

4

FromTime

string

0

YYYY-MM-DD hh:mm:ss

Beginning of the order date range

5

UntilTime

string

0

YYYY-MM-DD hh:mm:ss

End of order date range

6

ShopID

string

0

ABC

Shop ID

7

PaymentType

string

0

Single character : "g"

Payment TYPE, references table payments

8

ShippingCountry

string

0

abcdefg

Shipping country reference

9

RowCount

integer

0

123

Maximum number of rows returned

10

FromUpdateTime

string

0

YYYY-MM-DD hh:mm:ss

Beginning of the order update date range


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:pixiGetOrderHeader>
         <dem:OrderNr>123</dem:OrderNr>
         <dem:OrderNrExternal>abcdefg</dem:OrderNrExternal>
         <dem:CustKey>123</dem:CustKey>
         <dem:FromTime>YYYY-MM-DD hh:mm:ss</dem:FromTime>
         <dem:UntilTime>YYYY-MM-DD hh:mm:ss</dem:UntilTime>
         <dem:ShopID>ABC</dem:ShopID>
         <dem:PaymentType>Single character : "g"</dem:PaymentType>
         <dem:ShippingCountry>abcdefg</dem:ShippingCountry>
         <dem:RowCount>123</dem:RowCount>
         <dem:FromUpdateTime>YYYY-MM-DD hh:mm:ss</dem:FromUpdateTime>
      </dem:pixiGetOrderHeader>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Order details

#

Name

Type

Description

1

OrderHeaderKey

integer

ID of the order header record

2

OrderNr

integer

Order number in pixi*

3

CreateDate

string

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

string

Ship this order at this date only! not before

9

LastShipdate

string

Date of last (partial) shipment

10

TrackingID

string

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

11

ShipVendor

string

Shipping vendor used for shipout

12

ShopID

string

Shop ID

13

OrderDate

string

Shop order date (imported)

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

Bank account number

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

Notes related to the address

30

CustKey

integer

Customer ID

31

SalutationText

string

Salutation text

32

Gender

integer

Gender

33

LastName

string

Last Name

34

FirstName

string

First Name

35

ShippingCountry

string

Shipping country

36

ZIP

string

Postal code

37

City

string

City

38

Street

string

Street

39

HouseNr

string

House number

40

BirthDate

string

Birth date

41

CustomerNr

string

Customer name

42

SubShopName

string

Shop name

43

SubShopLogo

string

Shop logo

44

Referrer

string

Referrer link or text

45

GiftMessage

string

Gift Message

46

OrderCurrency

string

Order currency

47

OrderTotal_OrderCurr

number

Order total

48

CustomerEmail

string

Customer e-mail

49

CustomerNrExternal

string

External Reference to the Customer (imported from Shop)

50

EstimatedDelivery

string

Estimated delivery of items on the order

51

OrderLocked

string

Y/N flag indicating whether the order is locked

52

ShipInstruct

string

Shipping instruction notes

53

OrderShipVendor

string

Shipping vendor imported with the order

54

DeliveryDate

string

Delivery date

55

LastInvoiceNr

string

Last invoice number connected to the order

56

TotalDiscount

number

Total discount

57

OrderType

string

Order type - B2B or B2C

58

Tags

string

Tag Names of an order separated by pipe symbol


Additional Notes