pixiGetOrderTotals
Recommended
Get totals equal to what the invoice would produce from the order in order currency.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
CustKey | integer | false | Customer ID. References CustKey in table Customers. Type: int Default value: NULL Example: 123 Available from: LOU Official (6.3.0.4452) |
OrderNr | integer | false | pixi* order number Type: int Default value: 0 Example: 123 Available from: LOU Official (6.3.0.4452) |
OrderNrExternal | string | false | Shop order number Type: varchar(50) Default value: Example: abcdefg Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetOrderTotals>
<OrderNr>0</OrderNr>
<OrderNrExternal>string</OrderNrExternal>
<CustKey>0</CustKey>
</pixiGetOrderTotals>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Qty | integer | Quantity of items in this order Type: int Available from: 25.06 (25.6.0.58802) |
Price | integer | Price of one item Type: int Available from: 25.06 (25.6.0.58802) |
EanUpc | string | EAN of the item in this order Type: varchar Available from: 25.06 (25.6.0.58802) |
VATLow | number | The total VAT amount of the whole order, if it has VAT rate low Type: numeric Available from: 25.06 (25.6.0.58802) |
ArtName | string | Itemname Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | The ordernumber for the given OrderNrExternal Type: int Available from: 25.06 (25.6.0.58802) |
VATHigh | number | The total VAT amount of the whole order, if it has VAT rate high Type: numeric Available from: 25.06 (25.6.0.58802) |
Discount | number | Discount of the order Type: numeric Available from: 25.06 (25.6.0.58802) |
ItemNote | string | ItemNote Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCost | number | The total shipping costs of the whole order Type: numeric Available from: 25.06 (25.6.0.58802) |
Subtotal | integer | Totalprice these items in this order Type: int Available from: 25.06 (25.6.0.58802) |
VATTotal | number | The total VAT amount of the whole order Type: numeric Available from: 25.06 (25.6.0.58802) |
NettoTotal | number | The total sales amount of the whole order excluding VAT Type: numeric Available from: 25.06 (25.6.0.58802) |
OrderTotal | number | The total sales amount of the whole order Type: numeric Available from: 25.06 (25.6.0.58802) |
TaxRateLow | number | TaxRateLow Type: numeric Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number of the item in this order Type: varchar Available from: 25.06 (25.6.0.58802) |
TaxRateHigh | number | TaxRateHigh Type: numeric Available from: 25.06 (25.6.0.58802) |
ShipCostNoVAT | number | The total shipping costs of the whole order excluding VAT Type: numeric Available from: 25.06 (25.6.0.58802) |
ItemPriceNoVat | number | Item price excluding VAT Type: numeric Available from: 25.06 (25.6.0.58802) |
ItemAmountNoVat | number | Total item price of items excluding VAT Type: numeric Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | The external ordernumber for the given OrderNr Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderCurrencyCode | string | OrderCurrencyCode Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetOrderTotalsPost200TextXmlResponse>
<OrderNr>0</OrderNr>
<EanUpc>string</EanUpc>
<ItemNrSuppl>string</ItemNrSuppl>
<ArtName>string</ArtName>
<Qty>0</Qty>
<Price>0</Price>
<Subtotal>0</Subtotal>
<OrderNrExternal>string</OrderNrExternal>
<ItemNote>string</ItemNote>
<ItemPriceNoVat>0</ItemPriceNoVat>
<ItemAmountNoVat>0</ItemAmountNoVat>
<OrderTotal>0</OrderTotal>
<Discount>0</Discount>
<VATTotal>0</VATTotal>
<VATHigh>0</VATHigh>
<VATLow>0</VATLow>
<NettoTotal>0</NettoTotal>
<ShipCost>0</ShipCost>
<ShipCostNoVAT>0</ShipCostNoVAT>
<TaxRateHigh>0</TaxRateHigh>
<TaxRateLow>0</TaxRateLow>
<OrderCurrencyCode>string</OrderCurrencyCode>
</PixiGetOrderTotalsPost200TextXmlResponse>
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:pixiGetOrderTotals>
<CustKey xsi:type="xsd:integer">123</CustKey>
<OrderNr xsi:type="xsd:integer">123</OrderNr>
<OrderNrExternal xsi:type="xsd:string">abcdefg</OrderNrExternal>
</ns1:pixiGetOrderTotals>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetOrderTotals', [
'CustKey' => '123', // integer
'OrderNr' => '123', // integer
'OrderNrExternal' => 'abcdefg', // string
]);
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);
}