Shipping Read

pixiGetBoxItems

Returns the items packed into a box, identified by box number and location, with order, orderline, item and scan data.

Lists the contents of a packing box.

Both BoxNr and LocId must be given. If one of them is NULL, a status row with Status = Error is returned.
The box is looked up in boxes by BoxNr and LocationID. If no box exists, a status row with Status = Error is returned.
All boxitems rows of boxes with this number and location are collected (quantity, scan date, scanning user).
Each box item is joined to its orderline (Orderlines) to get the Pixi order number, the external order number, the item and the picklist number used.
The item master (items) supplies barcode (EANUPC), item name and weight. MeasuredWeight is the item weight multiplied by the packed quantity.

One row is returned per box item. No sort order is defined.

Notes

All tables are read with NOLOCK, so uncommitted data can appear.
Box items whose orderline or item no longer exists are dropped silently because of inner joins.
If the box exists but contains no items, an empty result set is returned (no status row).
The existence check uses TOP(1), but the item query filters only by box number and location. If several boxes share the same number and location, items of all of them are returned.
MeasuredWeight is not a measured value; it is calculated from the item master weight.
The column oPicklistNumber keeps its internal name (no alias).
On errors the procedure returns code 1.

Parameters

Parameter	Type	Default	Description
`BoxNr` Required	int	–	Number of the box (`boxes.BoxNr`). Example: `100245`
`LocId` Required	varchar(3) string	–	Location (warehouse) ID of the box (`boxes.LocationID`). Example: `001`

Response

Result set 1 · If a parameter is NULL or the box is not found

Status row describing the error.

Column	Type	Description
`Status`	varchar(5) string	Always `Error`.
`Message`	varchar(34) string	Error text.

Result set 2 · On success (box found)

One row per item packed into the box.

Column	Type	Description
`BoxNumber`	int	Box number.
`PixiOrderNumber` Nullable	int	Pixi order number of the orderline.
`ExternalOrderNumber` Nullable	varchar(50) string	External order number (e.g. shop order number).
`OrderlineId`	int	Key of the orderline (`OrderlineKey`).
`Barcode` Nullable	string	EAN/UPC of the item.
`ItemName` Nullable	string	Item name.
`Quantity`	int	Quantity packed into the box.
`MeasuredWeight` Nullable	decimal	Item weight from the item master multiplied by the quantity.
`ScannedOn` Nullable	datetime dateTime	Creation date of the box item (scan time).
`User` Nullable	varchar(50) string	Employee who created the box item.
`oPicklistNumber` Nullable	int	Picklist number used for the orderline (`PickListNrUsed`).

Response example

<SqlRowSet1>
  <row>
    <BoxNumber>100245</BoxNumber>
    <PixiOrderNumber>584213</PixiOrderNumber>
    <ExternalOrderNumber>SHOP-2024-10077</ExternalOrderNumber>
    <OrderlineId>1923345</OrderlineId>
    <Barcode>4006381333931</Barcode>
    <ItemName>Kugelschreiber blau</ItemName>
    <Quantity>2</Quantity>
    <MeasuredWeight>0.0400</MeasuredWeight>
    <ScannedOn>2024-05-14T10:32:11</ScannedOn>
    <User>mmueller</User>
    <oPicklistNumber>77812</oPicklistNumber>
  </row>
</SqlRowSet1>

Error messages

Status	Message	Cause
Error	Both parameters must be specified.	`BoxNr` or `LocId` is NULL. Pass both values.
Error	Box could not be found.	No box with this number exists in the given location. Check box number and location ID.

Examples

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetBoxItems>
      <BoxNr>100245</BoxNr>
      <LocId>001</LocId>
    </ns1:pixiGetBoxItems>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetBoxItems>
      <BoxNr>100245</BoxNr>
      <LocId>001</LocId>
    </ns1:pixiGetBoxItems>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'BoxNr' => '100245',
    'LocId' => '001',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetBoxItems', $soapArguments);

Tables used

boxes · Read boxitems · Read Orderlines · Read items · Read

SQL object:: dbo.pipiGetBoxItems