Description
Multi Currency: Return database currency code in field dbCurrency depend on if Multi Currency is Enabled then we: - calculate and return data in database currency else - calculate and return data in order / original currency (with value NULL for currency code).
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
ViewDetails |
boolean |
0 |
0 or 1 |
Return summarized output or return detailed output. |
2 |
IncludePartDelivery |
boolean |
0 |
0 or 1 |
Include also orderlines which were partially delivered. |
3 |
OnlyPartDelivery |
boolean |
0 |
0 or 1 |
Show only orderlines which were partially delivered |
4 |
ShopId |
string |
0 |
abcdef |
Shop Code |
5 |
IncludeOrdersWithAnyShipDate |
boolean |
0 |
0 or 1 |
By default, return all orders without ship date and orders where shipdate =< today. Exclude order where ship date is in the future. If parameter @IncludeOrdersWithAnyShipDate = 1 then return all orders (ship date is ignored) |
6 |
PerLocation |
boolean |
0 |
0 or 1 |
Return summary of shippable orders per location. |
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:pixiReportGetShippableOrders>
<dem:ViewDetails>0 or 1</dem:ViewDetails>
<dem:IncludePartDelivery>0 or 1</dem:IncludePartDelivery>
<dem:OnlyPartDelivery>0 or 1</dem:OnlyPartDelivery>
<dem:ShopId>abcdef</dem:ShopId>
<dem:IncludeOrdersWithAnyShipDate>0 or 1</dem:IncludeOrdersWithAnyShipDate>
<dem:PerLocation>0 or 1</dem:PerLocation>
</dem:pixiReportGetShippableOrders>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Detailed output for @PerLocation = 0
# |
Name |
Type |
Description |
1 |
OrderlineRef |
integer |
Orderline id |
2 |
OrderNr |
integer |
pixi Order Number |
3 |
Qty |
integer |
Orderline Quantity |
4 |
ItemRef |
integer |
Item ID |
5 |
Status |
string |
Orderline Status |
6 |
ShipCost |
number |
The total shipping costs of the whole order |
7 |
Price |
number |
Orderline Price |
8 |
Shippable |
integer |
Marks if there is enough stock to ship orderline |
9 |
dbCurrency |
string |
Database Currency |
Body 2: Summarized output for @PerLocation = 0
# |
Name |
Type |
Description |
1 |
Orders |
integer |
Order count |
2 |
OrderTotal |
number |
Summarized order total |
3 |
ShipCost |
number |
Summarized shipping costs |
4 |
Picks |
integer |
Summarized quantity which is available to be shipped |
5 |
dbCurrency |
string |
Database Currency |
Additional Notes