pixiGetHistoricalSupplierPrices
Deprecated
API call returns historical supplier prices for items.
Since pixi version: AVA 17.04 (8.4.28.29614) Additional notes: The date range period is limited to 31 days. Population of price data happens over night. This means that it is not possible to get data for current day.
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| DateTo | string | true | Filter: End of the date range peroid Type: datetime Default value: NULL Example: YYYY-MM-DD Available from: AVA 17.04 (8.4.28.29614) |
| ItemKey | integer | false | Filter: ItemID Type: int Default value: NULL Example: 12345 Available from: AVA 17.04 (8.4.28.29614) |
| DateFrom | string | true | Filter: Begining of the date range peroid. Type: datetime Default value: NULL Example: YYYY-MM-DD Available from: AVA 17.04 (8.4.28.29614) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetHistoricalSupplierPrices>
<ItemKey>0</ItemKey>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
</pixiGetHistoricalSupplierPrices>
</Body>
</Envelope>Response
1. Historical supplier prices of items.
| Name | Type | Description |
|---|---|---|
| ItemID | integer | Item Id. Type: int Available from: 25.06 (25.6.0.58802) |
| RefType | string | Supplier price matching reference description. Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
| Quantity | integer | Quantity that was put to stock. Type: int Available from: 25.06 (25.6.0.58802) |
| SupplierId | integer | Supplier ID. Type: int Available from: 25.06 (25.6.0.58802) |
| SupplierPrice | number | Corresponding item supplier price at the time. Type: money Available from: 25.06 (25.6.0.58802) |
| DatePutToStock | string | Time stamp of put to stock operation. Type: datetime Available from: 25.06 (25.6.0.58802) |
| InvBinItemLogId | integer | Uinque ID of put to stock operation. Type: int Available from: 25.06 (25.6.0.58802) |
| RefDocumentNumber | integer | Delivery number for found match. Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetHistoricalSupplierPricesPost200TextXmlResponse>
<InvBinItemLogId>0</InvBinItemLogId>
<ItemID>0</ItemID>
<DatePutToStock>string</DatePutToStock>
<Quantity>0</Quantity>
<SupplierPrice>0</SupplierPrice>
<SupplierId>0</SupplierId>
<RefType>string</RefType>
<RefDocumentNumber>0</RefDocumentNumber>
</PixiGetHistoricalSupplierPricesPost200TextXmlResponse>2. Error/Warning response.
| Name | Type | Description |
|---|---|---|
| Staus | string | Status of response. Type: varchar(10) Available from: 25.06 (25.6.0.58802) |
| Message | string | Description of error/warning response. Type: varchar(250) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetHistoricalSupplierPricesPost400TextXmlResponse>
<Staus>string</Staus>
<Message>string</Message>
</PixiGetHistoricalSupplierPricesPost400TextXmlResponse>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:pixiGetHistoricalSupplierPrices>
<DateTo xsi:type="xsd:string">YYYY-MM-DD</DateTo> <!-- required -->
<ItemKey xsi:type="xsd:integer">12345</ItemKey>
<DateFrom xsi:type="xsd:string">YYYY-MM-DD</DateFrom> <!-- required -->
</ns1:pixiGetHistoricalSupplierPrices>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiGetHistoricalSupplierPrices', [
'DateTo' => 'YYYY-MM-DD', // string (required)
'ItemKey' => '12345', // integer
'DateFrom' => 'YYYY-MM-DD', // string (required)
]);
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);
}