Description
Retrieves items with stock quantity changes within a specified date range, including current stock levels and availability calculations.
API call returns all items that have changed their stock quantity since the date passed as a parameter.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
Since |
string |
1 |
2024-01-01 00:00:00 |
Returns items with changed stock quantity later than this date (format: YYYY-MM-DD hh:mm:ss). |
2 |
Rowcount |
integer |
0 |
1000 |
Maximum number of returned rows. Default: 1000. |
3 |
LocID |
string |
0 |
001 |
Location ID. When empty or omitted, all locations are included. |
4 |
DateTo |
string |
0 |
2024-12-31 23:59:59 |
Upper date filter (format: YYYY-MM-DD hh:mm:ss). Returns only items with stock changes before this date. Defaults to current date and time when not provided. |
5 |
Start |
integer |
0 |
0 |
Starting row offset for pagination. Used together with Rowcount to retrieve chunks of results. Default: 0. |
6 |
ExcludeBinGroups |
string |
0 |
Bin-A, Bin-B, Bin-C |
Comma-separated list of bin groups to exclude. When specified, stock quantities from those bin groups are subtracted from the returned values. |
7 |
IncludeOrderLineChanges |
integer |
0 |
0 |
When set to 1, also includes items that appear in order lines updated within the date range, even if their bin stock did not change. Use 0 (default) for bin stock changes only. |
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>
<dem:Since>2024-01-01 00:00:00</dem:Since>
<dem:Rowcount>1000</dem:Rowcount>
<dem:LocID>001</dem:LocID>
<dem:DateTo>2024-12-31 23:59:59</dem:DateTo>
<dem:Start>0</dem:Start>
<dem:ExcludeBinGroups>Bin-A, Bin-B</dem:ExcludeBinGroups>
<dem:IncludeOrderLineChanges>0</dem:IncludeOrderLineChanges>
</dem:pixiGetChangedItemStock>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Items with Changed Stock
# |
Name |
Type |
Description |
1 |
ItemKey |
int |
pixi* item ID. |
2 |
ItemNrInt |
varchar(50) |
Shop item number. |
3 |
EANUPC |
varchar(13) |
Item barcode (EAN/UPC). |
4 |
ItemNrSuppl |
varchar(50) |
Supplier item number. |
5 |
PhysicalStock |
int |
Physical item stock quantity. |
6 |
AvailableStock |
int |
Current available stock. Calculation depends on settings: "Enable reservations", "Export Physical Stock for items (not bundles)", and "Export available stock - reservations are enabled". |
7 |
StockChange |
int |
Quantity of item stock change in the requested period. |
8 |
EstimatedDelivery |
datetime |
Estimated item delivery date. |
9 |
MinStockQty |
int |
Minimum stock quantity (reorder level) for the item at the specified location. |
10 |
Enabled |
bit |
Indicates whether the item is enabled. |
11 |
OpenSupplierOrderQTY |
int |
Total quantity on open supplier order lines for this item. |
12 |
UpdateDate |
datetime |
Date of the most recent stock log change. Used as the ordering basis for pagination. |
13 |
OriginalUpdateDate |
datetime |
Date of the last stock calculation for this item. |
14 |
BundleItem |
bit |
Indicates whether the item is a bundle. |
15 |
RowNr |
int |
Row number for use with Start and Rowcount pagination parameters. |
16 |
PhysicalStockLoc |
int |
Physical item stock quantity at the specified location. |
Additional Notes
General info:
- This call provides all item-specific information: EAN, ItemNRInt (Shop item number), physical quantity, available quantity, and changed stock quantity.
- This call does NOT cover bundle articles — only real stock movements are reported. For proper stock levels to display in your shop, refer to the pixiShopLink API calls.
ExcludeBinGroups:
- When using the ExcludeBinGroups parameter, the overall stock of the returned items is reduced by the stock held in the excluded bin groups.
Pagination:
- For large data sets, use the Rowcount and Start parameters together to retrieve predefined chunks of results.
- Note that results are ordered by update date. If stock changes while retrieving paginated data, updated items are pushed to the end of the list and may appear more than once across multiple pages.