pixi Developer & Integration Documentation

pixiGetShippedOrdersPerLocation

Description

Get list of all shipped orders for time period, if ShowDetails=0 only number of orders, their total and currency will be returned.


Request Parameters

# Name Type Required Example Description
1 ShowDetails integer 0 0 Return details or summary of shipped orders.
2 FromDate string 1 2017-01-01 00:00:00 Filter: Start of invoice date range.
3 ToDate string 1 2017-12-31 23:59:96 Filter: End of invoice date range.
4 CustomerNrExternal string 0 abc Filter: Customer number external.
5 IncludeOrdersWithTotalZero boolean 0 0 or 1 Filter: Include orders with total = 0 in returned result set.
6 SearchByScanOutDate boolean 0 0 or 1 Filter: Select if @FromDate and @ToDate filter records by InvoiceDate (default) or by ScanOutDate.
7 LocId string 0 abc Filter: All locations = empty string |one specific location = 001.

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:pixiGetShippedOrdersPerLocation>
         <dem:ShowDetails>0</dem:ShowDetails>
         <dem:FromDate>2017-01-01 00:00:00</dem:FromDate>
         <dem:ToDate>2017-12-31 23:59:96</dem:ToDate>
         <dem:CustomerNrExternal>abc</dem:CustomerNrExternal>
         <dem:IncludeOrdersWithTotalZero>0 or 1</dem:IncludeOrdersWithTotalZero>
         <dem:SearchByScanOutDate>0 or 1</dem:SearchByScanOutDate>
         <dem:LocId>abc</dem:LocId>
      </dem:pixiGetShippedOrdersPerLocation>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Shipped orders (details).

# Name Type Description
1 InvoiceNR string Invoice number.
2 InvDate string Date of invoice creation.
3 ScanOutDate string Invoice ship out date.
4 total number Invoice total.
5 ShipMentTrackingID string Invoice tracking ID.
6 SName string Customer name from shipping address.
7 SAddress string Street from shipping address.
8 SCity string City from shipping address.
9 SZip string Postal code from shipping address.
10 SCountry string Country from shipping address.
11 OrderNrExternal string Order number external (shop order number).
12 CurrencyCode string Currency code.
13 ShipVendor string Shipping vendor code.
14 CustomerNrExternal string External customer number.
15 LocationID string Location of shipped orders.

Body 2: Shipped orders (summary).

# Name Type Description
1 NrOfOrders integer Total number of orders in selected period.
2 LocationID string Location of shipped orders.
3 Total number Invoice SUM(total) in selected period.
4 CurrencyCode string Currency code.

Additional Notes