Description

Returns shipped order counts for four time periods: a configurable date range, the previous day, the current month, and the previous month. All counts are based on invoice scan-out dates. Useful for dashboard displays and shipping volume reporting. An optional shop filter can narrow results to a specific shop.

Request Parameters

#	Name	Type	Required	Example	Description
1	StartDate	datetime	0	2021-12-03 10:00:00	Start of the date range for ShipoutOnGivenDay. If NULL, defaults to start of previous month. Format: YYYY-MM-DD hh:mm:ss
2	EndDate	datetime	0	2021-12-03 15:00:00	End of the date range. All four time period calculations are anchored to this date. If NULL, defaults to the current timestamp. Format: YYYY-MM-DD hh:mm:ss
3	ShopID	string	0	WEB	Shop ID to filter results by. If empty or omitted, all shops are included.

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:pixiReportShippedOrders>
         <dem:StartDate>2021-12-03 10:00:00</dem:StartDate>
         <dem:EndDate>2021-12-03 15:00:00</dem:EndDate>
         <dem:ShopID>WEB</dem:ShopID>
      </dem:pixiReportShippedOrders>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Shipped Out Values

Always returns exactly one row.

#	Name	Type	Description
1	ShipoutOnGivenDay	string	Number of orders shipped in the specified date range. Defaults to 0 if no orders. See Additional Notes for multi-day behavior.
2	ShipoutOnPreviousDay	string	Number of orders shipped on the full day before EndDate (00:00:00 to 23:59:59). NULL if no orders.
3	ShipoutInGivenMonth	string	Number of orders shipped from the 1st of EndDate's month up to EndDate. NULL if no orders.
4	ShipoutInPreviousMonth	string	Number of orders shipped during the entire calendar month before EndDate. NULL if no orders.

Additional Notes

All parameters are optional. When called without parameters, EndDate defaults to now and
the period covers from start of previous month to now.

ShipoutOnGivenDay behaviour:
  - If StartDate and EndDate are on the same calendar day:
      counts orders shipped between StartDate and EndDate.
  - If StartDate and EndDate are on different calendar days:
      counts orders shipped from midnight of EndDate to EndDate (StartDate is ignored for this field).
  - If StartDate > EndDate: StartDate is automatically adjusted to EndDate.

Examples:
  StartDate = 2021-12-03 10:00:00, EndDate = 2021-12-03 15:00:00
    -> ShipoutOnGivenDay counts shipments between 10:00 and 15:00 on 2021-12-03.

  StartDate = 2021-12-01 00:00:00, EndDate = 2021-12-03 15:00:00
    -> ShipoutOnGivenDay counts shipments from 00:00 to 15:00 on 2021-12-03 only.

All four response fields are returned as string (VARCHAR) even though they contain numeric counts.