Description
Returns orders for given customer
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
CustKey |
integer |
0 |
123 |
Customer ID, references table customers |
| 2 |
CustomerNrExternal |
string |
0 |
1234ABC |
Shop customer number |
| 3 |
ShopID |
string |
0 |
SHP |
Shop ID |
| 4 |
OrderStatus |
string |
0 |
OPEN, HOLD, CLOSED |
Order Status |
| 5 |
OrderDateFrom |
string |
0 |
2024-05-31 |
Order Date From |
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:pixiGetOrderHeadersForCustomer>
<dem:CustKey>123</dem:CustKey>
<dem:CustomerNrExternal>1234ABC</dem:CustomerNrExternal>
<dem:ShopID>SHP</dem:ShopID>
<dem:OrderStatus>OPEN, HOLD, CLOSED</dem:OrderStatus>
<dem:OrderDateFrom>2024-05-31</dem:OrderDateFrom>
</dem:pixiGetOrderHeadersForCustomer>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: Customer's orders
| # |
Name |
Type |
Description |
| 1 |
OrderHeaderKey |
integer |
ID of the order header record |
| 2 |
OrderNr |
integer |
pixi* Order Number |
| 3 |
CreateDate |
string |
Date of creation of the order header record |
| 4 |
OrderNrExternal |
string |
Shop order number |
| 5 |
OrderTotal |
number |
Total due amount on this order (including discounts, shipping, rounding etc) |
| 6 |
OrderlinesTotal |
number |
Price of all the ordered items |
| 7 |
WholeOrderState |
string |
Status of the order |
| 8 |
ShipDate |
string |
Oldest scan-out date of all ordered items |
| 9 |
LastShipDate |
string |
Newest scan-out date of all ordered items |
| 10 |
TrackingID |
string |
Tracking ID of the order |
| 11 |
ShipVendor |
string |
Code of the ship vendor chosen for the order |
| 12 |
ShopID |
string |
ID of the shop through which the order has been made |
| 13 |
OrderDate |
string |
Date of the order |
| 14 |
ShipCost |
number |
Cost of the shipment |
| 15 |
PaymentAddressId |
integer |
ID of the Address record associated with payment address for this order |
| 16 |
ShipmentAddressId |
integer |
ID of the Address record associated with shipment address for this order |
| 17 |
ShopNote |
string |
Note received with this order from the shop |
| 18 |
PaymentType |
string |
Code of payment type |
| 19 |
VoucherID |
string |
Voucher associated with the order (if any) |
| 20 |
VoucherAmount |
number |
Amount covered with the associated voucher |
| 21 |
CcCardType |
string |
Type of the credit card used for payment |
| 22 |
CcCardNr |
string |
Number of the credit card used for payment |
| 23 |
CcCardName |
string |
Name on the credit card used for payment |
| 24 |
CcCardExp |
string |
Expiration date on the credit card used for payment |
| 25 |
Account |
string |
Account information related to LS payment type |
| 26 |
Blz |
string |
Bank identification related to LS payment type |
| 27 |
BankName |
string |
Bank name related to LS payment type |
| 28 |
AccountName |
string |
Name on the account related to LS payment type |
| 29 |
AddressRemarks |
string |
Address-related comments |
| 30 |
AddrRef |
integer |
ID of the customer address record |
| 31 |
ZIP |
string |
ZIP code from the customer's address |
| 32 |
CustKey |
integer |
ID of the customer record |
| 33 |
OrderLocked |
string |
Y/N flag indicating whether the order is locked |
| 34 |
OrderCurrencyCode |
string |
Currency code used on the order |
Additional Notes
Provides detailed information on customers orders. Customer may be specified by either Customer ID (CustKey parameter) or shop customer Nr (CustomerNrExternal parameter either in combination with a filter by shop or not). Either CustKey or CustomerNrExternal should be provided, otherwise no results are produced