pixiSetHistoricalSupplierPrice
Deprecated
API call updates historical supplier price for uniquely identified record.
Since pixi version: AVA 17.04 (8.4.28.29614) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| UserName | string | true | Input: pixi* user name. Type: varchar(30) Default value: NULL Example: api Available from: AVA 17.04 (8.4.28.29614) |
| SupplierId | integer | true | Input: ID of the supplier. Type: int Default value: NULL Example: 55 Available from: AVA 17.04 (8.4.28.29614) |
| SupplierPrice | number | true | Input: The new supplier price. Type: money Default value: NULL Example: 9.99 Available from: AVA 17.04 (8.4.28.29614) |
| InvBinItemLogId | integer | true | Filter: Row ID of the supplier price to update. Type: int Default value: NULL Example: 12345 Available from: AVA 17.04 (8.4.28.29614) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiSetHistoricalSupplierPrice>
<InvBinItemLogId>0</InvBinItemLogId>
<SupplierPrice>0</SupplierPrice>
<SupplierId>0</SupplierId>
<UserName>string</UserName>
</pixiSetHistoricalSupplierPrice>
</Body>
</Envelope>Response
1. Success/Error response.
| Name | Type | Description |
|---|---|---|
| Staus | string | Status of response. Type: varchar(10) Available from: 25.06 (25.6.0.58802) |
| Message | string | Description of success/error response. Type: varchar(250) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiSetHistoricalSupplierPricePost400TextXmlResponse>
<Staus>string</Staus>
<Message>string</Message>
</PixiSetHistoricalSupplierPricePost400TextXmlResponse>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:pixiSetHistoricalSupplierPrice>
<UserName xsi:type="xsd:string">api</UserName> <!-- required -->
<SupplierId xsi:type="xsd:integer">55</SupplierId> <!-- required -->
<SupplierPrice xsi:type="xsd:number">9.99</SupplierPrice> <!-- required -->
<InvBinItemLogId xsi:type="xsd:integer">12345</InvBinItemLogId> <!-- required -->
</ns1:pixiSetHistoricalSupplierPrice>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiSetHistoricalSupplierPrice', [
'UserName' => 'api', // string (required)
'SupplierId' => '55', // integer (required)
'SupplierPrice' => '9.99', // number (required)
'InvBinItemLogId' => '12345', // integer (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);
}