pixi Developer & Integration Documentation

pixiGetDeliveryItemEvaluation

Description

Evaluates a delivered item and returns how many of the delivered units are needed for single-item shipment (1SS) orders and how many are needed for normal (on demand) picklists. Use this call during goods-in / put-away to decide how a delivered quantity should be split across the 1SS lane, the normal-order lane, and put-to-stock.

The call resolves the item from the supplied barcode, then walks all open reservations for that item in reservation date order (oldest first) and allocates the delivered quantity to them one by one:

• Quantity that is already physically present in bins for this item is settled first, so only the genuinely missing quantity is allocated.
• A reservation is counted as 1SS when its order contains a total quantity of exactly one unit; otherwise it is counted as OnDemand.
• Both regular order lines and bundle order lines are taken into account.
• Allocation stops as soon as the delivered quantity is fully consumed.

If the barcode does not match any item, or if the item has no open reservations, the call still succeeds and returns 1SS = 0 and OnDemand = 0. Any delivered quantity that is not required by 1SS or OnDemand is surplus and can be put to stock.


Request Parameters

#

Name

Type

Required

Example

Description

1

EANUPC

string

1

4250372234930

Barcode (EAN/UPC) of the delivered item. Matched against the item barcode and against additional item barcodes.

2

Quantity

integer

1

5

Number of units that have been delivered and are to be evaluated.

3

1SSBin

string

0

1SS-IN

Bin intended for 1SS items. Reserved for future use — it does not currently influence the returned values.

4

NormalOrdersBin

string

0

ORDERS-IN

Bin intended for normal-order items. Reserved for future use — it does not currently influence the returned values.

5

PutToStockBin

string

0

STOCK-IN

Bin intended for put-to-stock items. Reserved for future use — it does not currently influence the returned values.


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:pixiGetDeliveryItemEvaluation>
<dem:EANUPC>4250372234930</dem:EANUPC>
<dem:Quantity>5</dem:Quantity>
<dem:1SSBin>1SS-IN</dem:1SSBin>
<dem:NormalOrdersBin>ORDERS-IN</dem:NormalOrdersBin>
<dem:PutToStockBin>STOCK-IN</dem:PutToStockBin>
</dem:pixiGetDeliveryItemEvaluation>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Result set

#

Name

Type

Description

1

EANUPC

string

The barcode that was submitted in the request, echoed back for reference.

2

1SS

integer

Number of the delivered units that are required for single-item shipment orders (orders with a total quantity of exactly one unit).

3

OnDemand

integer

Number of the delivered units that are required for normal picklists (orders containing more than one unit in total).


Additional Notes

Allocation order
- Reservations are processed in ascending reservation date, so the oldest demand is served first.
- Allocation stops once the submitted Quantity has been fully allocated. Reservations that come
after that point are not evaluated.

Which orders are considered
- Only orders in a non-final state are considered.
- The states EIN, FUT and FUS are always excluded.
- Order lines belonging to an order that has at least one line in status HAL are skipped and are
counted neither as 1SS nor as OnDemand.
- Bundle order lines are evaluated in addition to regular order lines.

Stock already on hand
- Quantity already booked into bins for this item is settled against the open reservations before
the delivered quantity is allocated. This prevents demand that is already covered by stock on
hand from being counted again.

Interpreting the result
- 1SS + OnDemand is never greater than the submitted Quantity.
- If 1SS + OnDemand is lower than the submitted Quantity, the difference is surplus that is not
needed for any open order and can be put to stock.
- 1SS = 0 and OnDemand = 0 means the barcode is unknown or the item has no open demand.

Bin parameters
- 1SSBin, NormalOrdersBin and PutToStockBin are accepted for forward compatibility but have no
effect on the returned values in the current version. Do not rely on them to scope the
evaluation to specific bins.