pixi Developer & Integration Documentation

pixiReportShippingEfficiency

Description

Calculates key shipping efficiency metrics for a configurable lookback period: average order throughput time (from accepted to shipped) and the percentage of orders fulfilled within 24 hours. Only orders where all order lines have been fully shipped are included. Returns 0.00 for both metrics if no qualifying orders exist in the period.


Request Parameters

#

Name

Type

Required

Example

Description

1

SamplingPeriod

int

0

7

Number of days to look back for shipped orders, counting from today. Default: 7.

2

AVGThroughputTimeInDays

float

0


Output parameter. Do not pass a value — the calculated result is returned in Body 1.

3

PercThroughputTimeIn24h

float

0


Output parameter. Do not pass a value — the calculated result is returned in Body 1.


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:pixiReportShippingEfficiency>
<dem:SamplingPeriod>7</dem:SamplingPeriod>
</dem:pixiReportShippingEfficiency>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Shipping Efficiency Metrics

Always returns exactly one row.

#

Name

Type

Description

1

AVGThroughputTimeInDays

float

Average throughput time in days from order accepted (ANG) to shipped (AUS), rounded to 2 decimal places. Returns 0.00 if no qualifying orders exist.

2

PercThroughputTimeIn24h

float

Percentage of orders shipped within 24 hours of being accepted, rounded to 2 decimal places. Returns 0.00 if no qualifying orders exist.


Additional Notes

Only fully shipped orders are included: an order is included only if ALL its order lines
have AUS (shipped) status. Orders with any non-AUS lines are excluded.

Throughput time is calculated as the time from the earliest ANG (accepted) status change
to the latest AUS (shipped) status change across all lines of an order.

SamplingPeriod applies to the ship date of order lines, counting back from the start of
the current day. For example, SamplingPeriod = 7 covers the last 7 full days.

AVGThroughputTimeInDays and PercThroughputTimeIn24h are SQL OUTPUT parameters.
When calling via SOAP, omit them from the request — results are returned in Body 1.