pixi Developer & Integration Documentation

pixiGetChangedItemStock_LocID

Description

API call returns all items, that have changed the stock quantity on all or one location since the date passed as parameter.


Request Parameters

# Name Type Required Example Description
1 Since string 1 YYYY-MM-DD hh:mm:ss Function returns items with changed stock quantity later than this date
2 Rowcount integer 0 123 Maximum number of returned rows
3 LocID string 0 001 Location ID
4 DateTo string 0 YYYY-MM-DD hh:mm:ss This is an additional date, by which we can filter. Then the function returns only items which had changed before this date
5 Start integer 0 123 Used in combination with Rowcount parameter (pagination)
6 ExcludeBinGroups string 0 Bin-A, Bin-B, Bin-C Comma separated list of bin groups to exclude

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:pixiGetChangedItemStock_LocID>
         <dem:Since>YYYY-MM-DD hh:mm:ss</dem:Since>
         <dem:Rowcount>123</dem:Rowcount>
         <dem:LocID>001</dem:LocID>
         <dem:DateTo>YYYY-MM-DD hh:mm:ss</dem:DateTo>
         <dem:Start>123</dem:Start>
         <dem:ExcludeBinGroups>Bin-A, Bin-B, Bin-C</dem:ExcludeBinGroups>
      </dem:pixiGetChangedItemStock_LocID>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Items with changed stock for location

# Name Type Description
1 ItemKey integer pixi* item ID
2 ItemNrInt string Shop item number
3 EANUPC string Item barcode
4 ItemNrSuppl string Supplier item number
5 PhysicalStock integer Physical item stock quantity
6 AvailableStock integer Current available stock considering settings: "Enable reservations", "Export Physical Stock for items (not bundles)" and "Export available stock - reservations are enabled"
7 StockChange integer quantity of item stock change
8 EstimatedDelivery string Estimated item delivery date
9 MinStockQty integer Minimum stock quantity for the item.
10 Enabled boolean Indicates if the item is enabled
11 OpenSupplierOrderQTY integer Quantity of open supplier order lines
12 UpdateDate string Last update date of the record.
13 OriginalUpdateDate string Date of last stock calculation
14 BundleItem boolean Indicates if item is a bundle item
15 RowNr integer Row number

Additional Notes

**General info:**

 - It will provide all item specific information as EAN, ItemNRInt (Shop item number), physical quantity, available quantity and changed stock quantity.
 - Attention - this does NOT cover bundle articles. Only real stock movements. For proper stock levels to display in your shop, check the API Calls pixiShopLink.

**ExcludeBinGroups:**

 - When using parameter **ExcludeBinGroups** the overall stock of the
   items returned is reduced by the stock contained in excluded bin
   groups.

**Pagination:**

 - When retrieving large amount of data it is best to use the
   combination of parameters **Rowcount** and **Start**. This way it is
   possible to get predefined chunks of complete result.   
 - Keep in mind that the data is ordered by update date. This means if stock is changing while retrieving the data using parameters Rowcount and Start. The returned items will be pushed to the end of the list. This can lead that a single item is returned multiple times.