pixiGetChangedItemStockSince
Get changed item stock (LastCalculateStockDate) since/after x time
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: 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.
- The data is ordered by last calculated stock date followed by item ID.
- This means if stock was recalculated 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.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
Since | string | true | Date since/after quantity was calculated Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
Start | integer | false | Number of row from which we get data (example: start from row 50 and return 25 rows (returns rows from 51 to 75) Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
Rowcount | integer | false | Number of return rows Type: int Default value: 1000 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetChangedItemStockSince>
<Since>string</Since>
<Rowcount>0</Rowcount>
<Start>0</Start>
</pixiGetChangedItemStockSince>
</Body>
</Envelope>
Response
1. Items with changed stock
Name | Type | Description |
---|---|---|
RowNr | integer | Data set row number ID Type: int Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode Type: varchar (13) Available from: 25.06 (25.6.0.58802) |
Enabled | boolean | Indicates if the item is enabled Type: bit Available from: 25.06 (25.6.0.58802) |
ItemKey | integer | pixi* item ID Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
BundleItem | boolean | Indicates if item is a bundle item Type: bit Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | Last update date of the record Type: datetime Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
MinStockQty | integer | Minimum stock quantity for the item Type: int Available from: 25.06 (25.6.0.58802) |
PhysicalStock | integer | Physical item stock quantity on all locations Type: int Available from: 25.06 (25.6.0.58802) |
AvailableStock | integer | Current available stock considering settings: "Enable reservations", "Export Physical Stock for items (not bundles)" and "Export available stock - reservations are enabled" Type: int Available from: 25.06 (25.6.0.58802) |
EstimatedDelivery | string | Estimated item delivery date Type: datetime Available from: 25.06 (25.6.0.58802) |
OpenSupplOrdersQty | integer | Sum of items on open supplier order lines Type: int Available from: 25.06 (25.6.0.58802) |
OpenSupplierOrderQTY | integer | Quantity of open supplier order lines (obsolete; always returns 0) Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetChangedItemStockSincePost200TextXmlResponse>
<RowNr>0</RowNr>
<ItemKey>0</ItemKey>
<ItemNrInt>string</ItemNrInt>
<EANUPC>string</EANUPC>
<ItemNrSuppl>string</ItemNrSuppl>
<PhysicalStock>0</PhysicalStock>
<AvailableStock>0</AvailableStock>
<EstimatedDelivery>string</EstimatedDelivery>
<MinStockQty>0</MinStockQty>
<Enabled>true</Enabled>
<OpenSupplierOrderQTY>0</OpenSupplierOrderQTY>
<UpdateDate>string</UpdateDate>
<BundleItem>true</BundleItem>
<OpenSupplOrdersQty>0</OpenSupplOrdersQty>
</PixiGetChangedItemStockSincePost200TextXmlResponse>
HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiGetChangedItemStockSince>
<Since xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</Since> <!-- required -->
<Start xsi:type="xsd:integer">123</Start>
<Rowcount xsi:type="xsd:integer">123</Rowcount>
</ns1:pixiGetChangedItemStockSince>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetChangedItemStockSince', [
'Since' => 'YYYY-MM-DD hh:mm:ss', // string (required)
'Start' => '123', // integer
'Rowcount' => '123', // integer
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}