pixiGetInvoiceLines
Recommended
API call returns invoice lines for a specific invoice number.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
InvoiceNr | string | true | Filter: Invoice number Type: varchar(50) Default value: Example: ABC000001 Available from: LOU Official (6.3.0.4452) |
IncludeSpecialInvLines | boolean | false | Switch: When set to 1, also aditional lines are shown. (example: ZZZ Versandkosten) Type: bit Default value: 0 Example: 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetInvoiceLines>
<InvoiceNr>string</InvoiceNr>
<IncludeSpecialInvLines>true</IncludeSpecialInvLines>
</pixiGetInvoiceLines>
</Body>
</Envelope>
Response
1. Invoice lines connected to specified invoice number.
Name | Type | Description |
---|---|---|
ArtNr | string | Item barcode used for the order line/invoice line Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
BoxNr | integer | Box number connected to the invoice 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) |
ItemNr | string | Item barcode Type: varchar(13) Available from: 25.06 (25.6.0.58802) |
Status | string | Order line / invoice line status Type: varchar(3) Available from: 25.06 (25.6.0.58802) |
ArtName | string | Item name Type: varchar(120) Available from: 25.06 (25.6.0.58802) |
DF_Type | string | Direct fullfilement type Type: varchar(1) Available from: 25.06 (25.6.0.58802) |
ItemQty | integer | Item order quantity Type: int Available from: 25.06 (25.6.0.58802) |
ItemVAT | string | Item VAT Type: varchar(1) Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | pixi* order number Type: int Available from: 25.06 (25.6.0.58802) |
ItemText | string | Item name Type: varchar(120) Available from: 25.06 (25.6.0.58802) |
OrderQty | integer | Item order quantity Type: int Available from: 25.06 (25.6.0.58802) |
SerialNr | string | Item serial number Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
ShipCost | number | Shipping costs Type: money Available from: 25.06 (25.6.0.58802) |
FullPrice | number | Full price Type: money Available from: 25.06 (25.6.0.58802) |
InvoiceNr | string | Invoice number Type: varchar(20) Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
ItemPrice | number | Item price Type: money Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Order date Type: datetime Available from: 25.06 (25.6.0.58802) |
VATAmount | number | VAT amount on Orderline Type: numeric Available from: 25.06 (25.6.0.58802) |
DFShipDate | string | Shipment date of direct fullfilement order Type: datetime Available from: 25.06 (25.6.0.58802) |
VATPercent | number | VAT percentage on Orderline Type: numeric Available from: 25.06 (25.6.0.58802) |
BatchNumber | string | Batch number of the item on the invoice Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
SpecialNote | string | Special note Type: varchar(8000) Available from: 25.06 (25.6.0.58802) |
DiscountPerc | number | Discount percentage Type: numeric Available from: 25.06 (25.6.0.58802) |
OrderLineKey | integer | Order line ID Type: int Available from: 25.06 (25.6.0.58802) |
PicLinkLarge | string | URL link to large item image Type: varchar(512) Available from: 25.06 (25.6.0.58802) |
DiscountValue | number | Discount value Type: money Available from: 25.06 (25.6.0.58802) |
BestBeforeDate | string | Best before date of the item on the invoice Type: datetime Available from: 25.06 (25.6.0.58802) |
InvoiceLineKey | integer | Invoice line ID Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrExternal | string | Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
ItemPriceNoVAT | number | Item price without VAT Type: numeric Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | Order number external Type: varchar(50) Available from: 25.06 (25.6.0.58802) |
DFShipmentTrackingID | string | Direct fullfilement shipment tracking ID Type: varchar(100) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetInvoiceLinesPost200TextXmlResponse>
<InvoiceLineKey>0</InvoiceLineKey>
<InvoiceNr>string</InvoiceNr>
<OrderLineKey>0</OrderLineKey>
<ArtNr>string</ArtNr>
<ArtName>string</ArtName>
<SpecialNote>string</SpecialNote>
<ItemText>string</ItemText>
<OrderDate>string</OrderDate>
<OrderQty>0</OrderQty>
<ItemQty>0</ItemQty>
<ItemPrice>0</ItemPrice>
<ShipCost>0</ShipCost>
<ItemVAT>string</ItemVAT>
<ItemNr>string</ItemNr>
<ItemNrSuppl>string</ItemNrSuppl>
<ItemNrInt>string</ItemNrInt>
<EanUpc>string</EanUpc>
<SerialNr>string</SerialNr>
<OrderNr>0</OrderNr>
<OrderNrExternal>string</OrderNrExternal>
<Status>string</Status>
<ItemPriceNoVAT>0</ItemPriceNoVAT>
<FullPrice>0</FullPrice>
<DiscountValue>0</DiscountValue>
<DiscountPerc>0</DiscountPerc>
<ItemNrExternal>string</ItemNrExternal>
<DF_Type>string</DF_Type>
<DFShipDate>string</DFShipDate>
<DFShipmentTrackingID>string</DFShipmentTrackingID>
<BoxNr>0</BoxNr>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
<VATPercent>0</VATPercent>
<VATAmount>0</VATAmount>
<PicLinkLarge>string</PicLinkLarge>
</PixiGetInvoiceLinesPost200TextXmlResponse>
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:pixiGetInvoiceLines>
<InvoiceNr xsi:type="xsd:string">ABC000001</InvoiceNr> <!-- required -->
<IncludeSpecialInvLines xsi:type="xsd:boolean">1</IncludeSpecialInvLines>
</ns1:pixiGetInvoiceLines>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetInvoiceLines', [
'InvoiceNr' => 'ABC000001', // string (required)
'IncludeSpecialInvLines' => '1', // boolean
]);
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);
}