Description
Retrieve Orderlines based on several filters.
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
OrderlineKey |
integer |
0 |
123 |
Order line ID, references table Orderlines |
| 2 |
OrderNR |
integer |
0 |
123 |
pixi order number |
| 3 |
OrderNRExternal |
string |
0 |
abcdefg |
Shop order number |
| 4 |
Status |
string |
0 |
abcdefg |
Orderline status |
| 5 |
ShopID |
string |
0 |
abcdefg |
Shop ID |
| 6 |
PaymentType |
string |
0 |
Single character : "g" |
Payment TYPE, references table payments |
| 7 |
OrderDateFrom |
string |
0 |
YYYY-MM-DD hh:mm:ss |
Beginning of the order date range |
| 8 |
OrderDateTo |
string |
0 |
YYYY-MM-DD hh:mm:ss |
End of order date range |
| 9 |
UpdateDateFrom |
string |
0 |
YYYY-MM-DD hh:mm:ss |
Beginning of the date range when order line was updated |
| 10 |
UpdateDateTo |
string |
0 |
YYYY-MM-DD hh:mm:ss |
End of the date range when order line was updated |
| 11 |
RowCount |
integer |
0 |
123 |
Maximum number of rows returned |
| 12 |
InvoiceNr |
string |
0 |
abcdefg |
Invoice number |
| 13 |
ShowOrderlines |
boolean |
0 |
0 or 1 |
Force to return Orderlinekey in case of bundle |
| 14 |
IsStartKey |
boolean |
0 |
0 or 1 |
Start parameter for OrderlineKey |
| 15 |
ItemXML |
string |
0 |
See additional information for XML structure |
See additional information for XML structure |
| 16 |
IsReplacementOnly |
boolean |
0 |
0 |
Show only replacement Orderlines |
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:pixiGetOrderlineExtended>
<dem:OrderlineKey>123</dem:OrderlineKey>
<dem:OrderNR>123</dem:OrderNR>
<dem:OrderNRExternal>abcdefg</dem:OrderNRExternal>
<dem:Status>abcdefg</dem:Status>
<dem:ShopID>abcdefg</dem:ShopID>
<dem:PaymentType>Single character : "g"</dem:PaymentType>
<dem:OrderDateFrom>YYYY-MM-DD hh:mm:ss</dem:OrderDateFrom>
<dem:OrderDateTo>YYYY-MM-DD hh:mm:ss</dem:OrderDateTo>
<dem:UpdateDateFrom>YYYY-MM-DD hh:mm:ss</dem:UpdateDateFrom>
<dem:UpdateDateTo>YYYY-MM-DD hh:mm:ss</dem:UpdateDateTo>
<dem:RowCount>123</dem:RowCount>
<dem:InvoiceNr>abcdefg</dem:InvoiceNr>
<dem:ShowOrderlines>0 or 1</dem:ShowOrderlines>
<dem:IsStartKey>0 or 1</dem:IsStartKey>
<dem:ItemXML>See additional information for XML structure</dem:ItemXML>
<dem:IsReplacementOnly>0</dem:IsReplacementOnly>
</dem:pixiGetOrderlineExtended>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: Get Orderline Overview
| # |
Name |
Type |
Description |
| 1 |
OrderlineKey |
integer |
ID for the orderline record |
| 2 |
ArtName |
string |
Name of the item |
| 3 |
Qty |
integer |
Qty |
| 4 |
Price |
number |
Price |
| 5 |
Status |
string |
Status |
| 6 |
StatusText |
string |
Status text |
| 7 |
ItemNrExternal |
string |
Item number external (Imported from shop) |
| 8 |
OrderNR |
integer |
Order number in pixi* |
| 9 |
OrderNrExternal |
string |
External order number |
| 10 |
OrderCurrency |
string |
Order currency |
| 11 |
OrderDate |
string |
Order date |
| 12 |
UpdateDate |
string |
Last update date of the record |
| 13 |
ItemRef |
integer |
Item ID |
| 14 |
oItemSpecialNote |
string |
oItem special note |
| 15 |
DiscountValue |
number |
Discount value |
| 16 |
DiscountPerc |
number |
Discount percent |
| 17 |
FullPrice |
number |
Full price |
| 18 |
FullPriceForItem |
number |
Full price for item |
| 19 |
VATRate |
string |
Text representation of high/low/zero VAT |
| 20 |
PriceNoVAT |
number |
Price no VAT |
| 21 |
ItemNrInt |
string |
Shop item number |
| 22 |
ShipDate |
string |
Ship this order at this date only! not before |
| 23 |
DFShipDate |
string |
DF ship date |
| 24 |
DFShipmentTrackingID |
string |
Direct fullfilement shipment tracking ID |
| 25 |
AvailStockOrderLine |
integer |
Avail stock orderLine |
| 26 |
EstimatedDelivery |
string |
Estimated delivery |
| 27 |
EANUPC |
string |
Item barcode |
| 28 |
ReservedCount |
number |
Reserved count |
| 29 |
PicLinkLarge |
string |
Large picture URL |
| 30 |
LocationID |
string |
Location code of item |
| 31 |
TaxAmount |
number |
VAT amount |
| 32 |
VATPercentage |
number |
VAT percentage |
| 33 |
OrderStatus |
string |
Order status |
| 34 |
PicklistNr |
integer |
Item on picklist |
Additional Notes
**Select multiple items with one call:**
When using **ItemXML** parameter one can get the item info for **multiple items** with one call.
Sample XML structure:
<ITEMS>
<ITEM><ITEMKEY>365</ITEMKEY></ITEM>
<ITEM><EAN>2000000000091</EAN></ITEM>
<ITEM><ITEMNRSUPPL>mg316</ITEMNRSUPPL></ITEM>
<ITEM><ITEMNRINT>54e46dd1dc2c30a39.01766786</ITEMNRINT></ITEM>
</ITEMS>
ITEMNRSUPPL should be used only if it is unique on database.