Description
Returns a list of all items contained in a specified box. Both the box number and the warehouse location must be provided. If the box is not found at the given location, or if either parameter is missing, an error result is returned instead of item data.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
BoxNr |
int |
1 |
101 |
Box number to retrieve items for. |
2 |
LocId |
string |
1 |
W01 |
Warehouse location ID where the box is located. |
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:pixiGetBoxItems>
<dem:BoxNr>101</dem:BoxNr>
<dem:LocId>W01</dem:LocId>
</dem:pixiGetBoxItems>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Box Items
Returned on success. One row per item scanned into the box.
# |
Name |
Type |
Description |
1 |
BoxNumber |
int |
Box number. |
2 |
PixiOrderNumber |
int |
Internal pixi order number. |
3 |
ExternalOrderNumber |
string |
External order number. |
4 |
OrderlineId |
int |
Orderline identifier. |
5 |
Barcode |
string |
EAN/UPC barcode of the item. |
6 |
ItemName |
string |
Name of the item. |
7 |
Quantity |
int |
Quantity of the item scanned into the box. |
8 |
MeasuredWeight |
numeric |
Item weight multiplied by quantity. |
9 |
ScannedOn |
datetime |
Date and time when the item was scanned into the box. |
10 |
User |
string |
Username of the person who scanned the item into the box. |
11 |
PicklistNumber |
int |
Picklist number used when the item was scanned. |
Body 2: Error Information
Returned instead of Body 1 when parameter validation fails.
# |
Name |
Type |
Description |
1 |
Status |
string |
Always "Error" on validation failure. |
2 |
Message |
string |
Description of the error. See Additional Notes for possible values. |
Additional Notes
Body 1 and Body 2 are mutually exclusive — only one is returned per call.
Possible error responses (Body 2):
- "Both parameters must be specified." — BoxNr or LocId is null.
- "Box could not be found." — No box with the given BoxNr exists at the specified LocId.
On success (Body 1):
- Returns an empty result set if the box exists but contains no items.
- One row is returned per item-orderline combination scanned into the box.