pixiGetOrder

API Call to get all information about an order

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: ####OrderNrXML parameter sample:

    	<OrderNrs>
    		<OrderNr>137892</OrderNr>
    		<OrderNrExternal>10003</OrderNrExternal>
    	</OrderNrs>
    
    
    ----------
    
    ####**XML output samples**
    
    **Billing address**:
    
    	<row AddrKey="1109" AddrType="B">
    		<AddrNr>C431</AddrNr>
    		<CustomerNrExternal>sc....de</CustomerNrExternal>
    		<ShopID>LEO</ShopID>
    		<Name>Al..id</Name>
    		<FirstName>A..er</FirstName>
    		<LastName>S..d</LastName>
    		<Address>S...tr. 2</Address>
    		<Street>S...r.</Street>
    		<HouseNr>2</HouseNr>
    		<City>H...en</City>
    		<ZIP>8..67</ZIP>
    		<CountryCodePixi>D</CountryCodePixi>
    		<CountryName>Deutschland</CountryName>
    		<CountryNameEasylog>D</CountryNameEasylog>
    		<CountryCodeISO2>DE</CountryCodeISO2>
    		<CountryCodeISO3>DEU</CountryCodeISO3>
    		<CountryCodeAfterbuy>D  </CountryCodeAfterbuy>
    		<CountryCodePlenty>1</CountryCodePlenty>
    		<eMail>s....net.de</eMail>
    		<PaymentCode>B</PaymentCode>
    		<NoChargeVAT>0</NoChargeVAT>
    		<CreateDate>2011-07-18T10:02:59.910</CreateDate>
    		<CreateEmp>LEO</CreateEmp>
    		<Locked>N</Locked>
    	</row>
    
    
    **Shipping address**:
    
    	<row AddrKey="1110" AddrType="S">
    		<AddrNr>C431</AddrNr>
    		<CustomerNrExternal>sc....de</CustomerNrExternal>
    		<ShopID>LEO</ShopID>
    		<Name>Ale... Sch...</Name>
    		<FirstName>Ale...</FirstName>
    		<LastName>Sch...</LastName>
    		<Address>Sch... 2</Address>
    		<Street>Sch...</Street>
    		<HouseNr>2</HouseNr>
    		<City>Hoh...</City>
    		<ZIP>*83*</ZIP>
    		<CountryCodePixi>D</CountryCodePixi>
    		<CountryName>Deutschland</CountryName>
    		<CountryNameEasylog>D</CountryNameEasylog>
    		<CountryCodeISO2>DE</CountryCodeISO2>
    		<CountryCodeISO3>DEU</CountryCodeISO3>
    		<CountryCodeAfterbuy>D  </CountryCodeAfterbuy>
    		<CountryCodePlenty>1</CountryCodePlenty>
    		<eMail>sch..........@ma...ses.net</eMail>
    		<PaymentCode />
    		<NoChargeVAT>0</NoChargeVAT>
    		<CreateDate>2011-07-18T10:02:59.917</CreateDate>
    		<CreateEmp>LEO</CreateEmp>
    		<Locked>N</Locked>
    		<CardHolderName />
    		<BankName />
    	</row>
    
    
    **Customer**:
    
    	<row CustKey="431">
    		<LastBillingAddressKey>1109</LastBillingAddressKey>
    		<LastShippingAddressKey>1110</LastShippingAddressKey>
    		<Locked>N</Locked>
    		<PaymentCode>B</PaymentCode>
    		<ShopID>LEO</ShopID>
    		<CreateDate>2011-07-18T10:02:59.913</CreateDate>
    		<CreateEmp>LEO</CreateEmp>
    		<UpdateDate>2011-07-18T10:02:59.923</UpdateDate>
    		<CustomerNrExternal>sc...de</CustomerNrExternal>
    		<TaxOnInvoice>Y</TaxOnInvoice>
    		<POSCustomer>N</POSCustomer>
    		<ReminderAction>PRINT</ReminderAction>
    		<DatevAccountNr>102414</DatevAccountNr>
    	</row>
    
    
    **Orderlines**:
    
    	<row OrderlineKey="3202">
    		<OrderlineKey>3202</OrderlineKey>
    		<SupplInfo>Seit</SupplInfo>
    		<ArtNr>4032844900334</ArtNr>
    		<ArtName>Fix f�r Bolognese, Seitz</ArtName>
    		<Qty>1</Qty>
    		<Price>30.9900</Price>
    		<SupplPrice>0.4400</SupplPrice>
    		<Status>EIN</Status>
    		<OrderCurrency>EUR</OrderCurrency>
    		<OrderDate>2011-07-16T19:43:08</OrderDate>
    		<CreateDate>2011-07-18T10:02:59.923</CreateDate>
    		<CreateEmp>LEO</CreateEmp>
    		<UpdateDate>2017-11-06T09:52:13.420</UpdateDate>
    		<UpdateEmp>p...v</UpdateEmp>
    		<ItemRef>568</ItemRef>
    		<Price_OrderCurr>30.9900</Price_OrderCurr>
    		<ShipCost>3.9900</ShipCost>
    		<ShipCost_OrderCurr>3.9900</ShipCost_OrderCurr>
    		<LocationID>001</LocationID>
    		<DiscountValue>0.0000</DiscountValue>
    		<DiscountPerc>0.00</DiscountPerc>
    		<FullPrice>30.9900</FullPrice>
    		<DF_type>0</DF_type>
    		<VATPercent>0.0700</VATPercent>
    		<ItemNrInt>TA90_666111</ItemNrInt>
    	</row>
    	<row OrderlineKey="5650">
    		<OrderlineKey>5650</OrderlineKey>
    		<BundleOrderlineRef>390</BundleOrderlineRef>
    		<SupplInfo>MGS</SupplInfo>
    		<ArtNr>4027013172315</ArtNr>
    		<ArtName>Riedenburger Bier glutenfrei, Riedenburger</ArtName>
    		<Qty>1</Qty>
    		<Price>1.6598</Price>
    		<SupplPrice>0.8400</SupplPrice>
    		<Status>EIN</Status>
    		<OrderCurrency>EUR</OrderCurrency>
    		<OrderDate>2017-11-06T09:52:09</OrderDate>
    		<CreateDate>2017-11-06T09:52:09</CreateDate>
    		<CreateEmp>pgodnov</CreateEmp>
    		<UpdateDate>2017-11-06T09:52:13.420</UpdateDate>
    		<UpdateEmp>p....v</UpdateEmp>
    		<ItemRef>414</ItemRef>
    		<Price_OrderCurr>1.6598</Price_OrderCurr>
    		<ShipCost>3.9900</ShipCost>
    		<ShipCost_OrderCurr>3.9900</ShipCost_OrderCurr>
    		<LineItemIDShop>N</LineItemIDShop>
    		<LocationID>001</LocationID>
    		<DiscountValue>0.0000</DiscountValue>
    		<DiscountPerc>0.00</DiscountPerc>
    		<FullPrice>1.6598</FullPrice>
    		<VATPercent>0.0700</VATPercent>
    		<ItemNrInt>TA90_666111</ItemNrInt>
    	</row>
    
    
    **BundleOrderlines**:
    
    	<row BundleOrderlineKey="390">
    		<BundleOrderlineKey>390</BundleOrderlineKey>
    		<OriginalOrderlineKey>1</OriginalOrderlineKey>
    		<SupplInfo>MGS</SupplInfo>
    		<ArtNr>2000060000000</ArtNr>
    		<ArtName>Bier Testpaket</ArtName>
    		<Qty>1</Qty>
    		<Price>5.9900</Price>
    		<SupplPrice>3.6800</SupplPrice>
    		<Status>ANG</Status>
    		<OrderCurrency>EUR</OrderCurrency>
    		<OrderDate>2017-11-06T09:52:09</OrderDate>
    		<CreateDate>2017-11-06T09:52:09</CreateDate>
    		<CreateEmp>p....v</CreateEmp>
    		<UpdateDate>2017-11-06T09:52:09</UpdateDate>
    		<UpdateEmp>p....v</UpdateEmp>
    		<ItemRef>928</ItemRef>
    		<Price_OrderCurr>5.9900</Price_OrderCurr>
    		<ShipCost>3.9900</ShipCost>
    		<ShipCost_OrderCurr>3.9900</ShipCost_OrderCurr>
    		<LineItemIDShop>N</LineItemIDShop>
    		<LocationID>001</LocationID>
    		<DiscountValue>0.0000</DiscountValue>
    		<DiscountPerc>0.00</DiscountPerc>
    		<FullPrice>5.9900</FullPrice>
    		<VATPercent>0.0700</VATPercent>
    		<ItemNrInt>TA90_666111</ItemNrInt>
    	</row>
    
    
    **Invoices**:
    
    	<row>
    		<InvoiceNr>LEO0000014</InvoiceNr>
    		<InvoiceKey>541</InvoiceKey>
    		<InvDate>2017-11-06T09:52:01.463</InvDate>
    		<VATBaseHigh>5.5981</VATBaseHigh>
    		<VATBaseLow>30.2341</VATBaseLow>
    		<Total>40.9700</Total>
    		<PaymentCode>B</PaymentCode>
    		<PaidDate>2017-11-06T09:52:01.463</PaidDate>
    		<PaidAmount>0.0000</PaidAmount>
    		<CreateDate>2017-11-06T09:52:12.040</CreateDate>
    		<CreateEmp>p....v</CreateEmp>
    		<Total_OrderCurr>40.9700</Total_OrderCurr>
    		<Total_ShipCost>3.9900</Total_ShipCost>
    		<Total_ShipCost_OrderCurr>3.9900</Total_ShipCost_OrderCurr>
    		<OrderCurrency>EUR</OrderCurrency>
    		<VATBaseHigh_OrderCurr>5.5981</VATBaseHigh_OrderCurr>
    		<VATBaseLow_OrderCurr>30.2341</VATBaseLow_OrderCurr>
    		<VATBaseHigh_ShipCost>0.6039</VATBaseHigh_ShipCost>
    		<VATBaseLow_ShipCost>3.2813</VATBaseLow_ShipCost>
    		<VATBaseHigh_ShipCost_OrderCurr>0.6039</VATBaseHigh_ShipCost_OrderCurr>
    		<VATBaseLow_ShipCost_OrderCurr>3.2813</VATBaseLow_ShipCost_OrderCurr>
    		<VATHigh>0.3919</VATHigh>
    		<VATHighPerc>7.0000</VATHighPerc>
    		<VATLow>0.7559</VATLow>
    		<VATLowPerc>1.9000</VATLowPerc>
    		<VATHText>7.00</VATHText>
    		<VATLText>1.90</VATLText>
    		<AddrRef>1109</AddrRef>
    		<ShipAdrRef>1110</ShipAdrRef>
    		<InvLocationID>001</InvLocationID>
    		<PackageGrossWeight>1.360000000000000e+000</PackageGrossWeight>
    		<Locked>N</Locked>
    		<VoucherSum_OrderCurr>0.0000</VoucherSum_OrderCurr>
    		<VATinShipCost>Y</VATinShipCost>
    		<DueDate>2017-11-20T09:52:01.463</DueDate>
    		<Is1SS>0</Is1SS>
    		<InvoiceLines>
    			<row InvoiceLineKey="2605">
    				<InvoiceLineKey>2605</InvoiceLineKey>
    				<OrderLineRef>5652</OrderLineRef>
    				<ItemNr>4012852001698</ItemNr>
    				<ItemQty>1</ItemQty>
    				<OrderQty>1</OrderQty>
    				<ItemText>Lammsbr�u Glutenfrei, Neumarkter Lammsbr�u</ItemText>
    				<ItemPrice>1.1034</ItemPrice>
    				<ItemPrice_OrderCurr>1.1034</ItemPrice_OrderCurr>
    				<ItemDiscount>0</ItemDiscount>
    				<ItemVAT>H</ItemVAT>
    				<CreateDate>2017-11-06T09:52:12.700</CreateDate>
    				<CreateEmp>E...19</CreateEmp>
    				<ShipCost>3.9900</ShipCost>
    				<ShipCost_OrderCurr>3.9900</ShipCost_OrderCurr>
    				<ItemRef>927</ItemRef>
    				<FullPrice>1.1034</FullPrice>
    				<DiscountValue>0.0000</DiscountValue>
    				<DiscountPerc>0.00</DiscountPerc>
    			</row>
    			<row InvoiceLineKey="2606">
    				<InvoiceLineKey>2606</InvoiceLineKey>
    				<OrderLineRef>5653</OrderLineRef>
    				<ItemNr>4260108510085</ItemNr>
    				<ItemQty>1</ItemQty>
    				<OrderQty>1</OrderQty>
    				<ItemText>Schnitzer Br�u Hirse Lemon, Schnitzer Br�u</ItemText>
    				<ItemPrice>1.5670</ItemPrice>
    				<ItemPrice_OrderCurr>1.5670</ItemPrice_OrderCurr>
    				<ItemDiscount>0</ItemDiscount>
    				<ItemVAT>H</ItemVAT>
    				<CreateDate>2017-11-06T09:52:12.700</CreateDate>
    				<CreateEmp>E....19</CreateEmp>
    				<ShipCost>3.9900</ShipCost>
    				<ShipCost_OrderCurr>3.9900</ShipCost_OrderCurr>
    				<ItemRef>469</ItemRef>
    				<FullPrice>1.5670</FullPrice>
    				<DiscountValue>0.0000</DiscountValue>
    				<DiscountPerc>0.00</DiscountPerc>
    			</row>
    		</InvoiceLines>
    	</row>
    
    
    **Customer account**:
    
    	<row>
    		<CustomerAccountKey>848</CustomerAccountKey>
    		<EventID>INV</EventID>
    		<EventDate>2017-11-06T09:52:01.463</EventDate>
    		<Reference>138288</Reference>
    		<InvoiceRef>541</InvoiceRef>
    		<Amount>-40.9700</Amount>
    		<Matched>0.0000</Matched>
    		<DoNotRefund>0</DoNotRefund>
    		<CreateEmp>p....v</CreateEmp>
    		<CreateDate>2017-11-06T09:52:13.997</CreateDate>
    		<UpdateEmp>p....v</UpdateEmp>
    		<UpdateDate>2017-11-06T09:52:13.997</UpdateDate>
    	</row>

Orderlines Orders

Request

POST https://apigateway.descartes.com/tms/pixi/pixiGetOrder

Request body

Name	Type	Required	Description
OrderNr	integer	false	pixi* order number (to retrieve a single order) Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNrXML	string	false	XML of OrderNr and/or OrderNrExternal values Type: varchar(-1) Default value: NULL Example: see aditional notes Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNrExternal	string	false	Order number external (to retrieve a single order) Type: varchar(50) Default value: NULL Example: Ext_1234 Available from: AVA 17.12 (8.4.36.32642)

Name

Type

Required

Description

OrderNr

integer

false

pixi* order number (to retrieve a single order)

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNrXML

string

false

XML of OrderNr and/or OrderNrExternal values

Type: varchar(-1)

Default value: NULL

Example: see aditional notes

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNrExternal

string

false

Order number external (to retrieve a single order)

Type: varchar(50)

Default value: NULL

Example: Ext_1234

Available from: AVA 17.12 (8.4.36.32642)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrder>
      <OrderNr>0</OrderNr>
      <OrderNrXML>string</OrderNrXML>
      <OrderNrExternal>string</OrderNrExternal>
    </pixiGetOrder>
  </Body>
</Envelope>

Response

1. Complette order information

Name	Type	Description
DFType	integer	Direct fullfilment type Type: int Available from: / (25.7.0.59144)
Extras	string	Tools Type: varchar Available from: / (25.7.0.59144)
AddrRef	integer	Billing address ID Type: int Available from: / (25.7.0.59144)
CustRef	integer	ID of customer Type: int Available from: / (25.7.0.59144)
OrderNr	integer	Order number in pixi* Type: int Available from: / (25.7.0.59144)
Product	string	Product Type: varchar Available from: / (25.7.0.59144)
Customer	string	Customer details Type: xml Available from: / (25.7.0.59144)
Discount	number	Order discount/voucher amount Type: money Available from: / (25.7.0.59144)
Invoices	string	Invoices details Type: xml Available from: / (25.7.0.59144)
Referrer	string	Referrer Type: varchar Available from: / (25.7.0.59144)
ShipCost	number	Order ship costs Type: money Available from: / (25.7.0.59144)
Shipdate	string	Ship this order at this date only! not before Type: datetime Available from: / (25.7.0.59144)
CreateEmp	string	Creator of the recodr (pixi* user) Type: varchar Available from: / (25.7.0.59144)
OhSLocked	string	Order shipping lock flag Type: varchar Available from: / (25.7.0.59144)
OrderType	string	Order type (B2B, B2C) Type: varchar Available from: / (25.7.0.59144)
Shop_Note	string	Shop note Type: varchar Available from: / (25.7.0.59144)
UpdateEmp	string	User who last updated the record Type: varchar Available from: / (25.7.0.59144)
Verfahren	string	Method Type: varchar Available from: / (25.7.0.59144)
VoucherID	string	Voucher ID Type: varchar Available from: / (25.7.0.59144)
ChannelRef	integer	Shop channel ID Type: int Available from: / (25.7.0.59144)
CreateDate	string	Create date Type: datetime Available from: / (25.7.0.59144)
OnPicklist	string	On picklist order status Type: varchar Available from: / (25.7.0.59144)
OrderTotal	number	Order total Type: money Available from: / (25.7.0.59144)
Orderlines	string	Orderline details Type: xml Available from: / (25.7.0.59144)
ShipAdrRef	integer	Shipping address ID Type: int Available from: / (25.7.0.59144)
UpdateDate	string	Last update date of the record Type: datetime Available from: / (25.7.0.59144)
GiftMessage	string	Gift Message Type: varchar Available from: / (25.7.0.59144)
OrderStatus	string	Order status Type: varchar Available from: / (25.7.0.59144)
SubShopLogo	string	Shop logo Type: varchar Available from: / (25.7.0.59144)
SubShopName	string	Shop name Type: varchar Available from: / (25.7.0.59144)
ShipInstruct	string	Transport remark Type: varchar Available from: / (25.7.0.59144)
BillingAddress	string	Billing address details Type: xml Available from: / (25.7.0.59144)
Address_Remarks	string	Address remark Type: varchar Available from: / (25.7.0.59144)
CustomerAccount	string	Customer account details Type: xml Available from: / (25.7.0.59144)
OrderLinesTotal	number	Sum of orderline totals Type: money Available from: / (25.7.0.59144)
OrderNrExternal	string	External order number Type: varchar Available from: / (25.7.0.59144)
ShippingAddress	string	Shipping address details Type: xml Available from: / (25.7.0.59144)
BundleOrderlines	string	Bundleorderlines details Type: xml Available from: / (25.7.0.59144)
OrderLinesDiscount	number	Sum of orderline discounts Type: money Available from: / (25.7.0.59144)
OrderShippingVendor	string	Shipping vendo used for the order Type: varchar Available from: / (25.7.0.59144)
OHMultiForceToPicklist	boolean	Ship remaining items after partial delivery shipout partially Type: bit Available from: / (25.7.0.59144)
ForceToPicklistIfNotFULL	boolean	Partial delivery is enabled Type: bit Available from: / (25.7.0.59144)
OHCancelAfterForcedShipOut	boolean	Cancel not avaliable items after partial delivery shipout Type: bit Available from: / (25.7.0.59144)

Response Example

<PixiGetOrderPost200TextXmlResponse>
  <OrderNr>0</OrderNr>
  <BillingAddress>string</BillingAddress>
  <ShippingAddress>string</ShippingAddress>
  <Customer>string</Customer>
  <OrderShippingVendor>string</OrderShippingVendor>
  <GiftMessage>string</GiftMessage>
  <ShipInstruct>string</ShipInstruct>
  <Discount>0</Discount>
  <CreateDate>string</CreateDate>
  <CreateEmp>string</CreateEmp>
  <UpdateEmp>string</UpdateEmp>
  <UpdateDate>string</UpdateDate>
  <CustRef>0</CustRef>
  <AddrRef>0</AddrRef>
  <ShipAdrRef>0</ShipAdrRef>
  <OhSLocked>string</OhSLocked>
  <Address_Remarks>string</Address_Remarks>
  <Verfahren>string</Verfahren>
  <Product>string</Product>
  <Extras>string</Extras>
  <Shipdate>string</Shipdate>
  <Shop_Note>string</Shop_Note>
  <ForceToPicklistIfNotFULL>true</ForceToPicklistIfNotFULL>
  <DFType>0</DFType>
  <OHMultiForceToPicklist>true</OHMultiForceToPicklist>
  <OHCancelAfterForcedShipOut>true</OHCancelAfterForcedShipOut>
  <SubShopLogo>string</SubShopLogo>
  <SubShopName>string</SubShopName>
  <Referrer>string</Referrer>
  <ChannelRef>0</ChannelRef>
  <OrderNrExternal>string</OrderNrExternal>
  <OrderStatus>string</OrderStatus>
  <OrderLinesTotal>0</OrderLinesTotal>
  <OrderLinesDiscount>0</OrderLinesDiscount>
  <OrderTotal>0</OrderTotal>
  <Orderlines>string</Orderlines>
  <BundleOrderlines>string</BundleOrderlines>
  <Invoices>string</Invoices>
  <CustomerAccount>string</CustomerAccount>
  <OrderType>string</OrderType>
  <OnPicklist>string</OnPicklist>
  <ShipCost>0</ShipCost>
  <VoucherID>string</VoucherID>
</PixiGetOrderPost200TextXmlResponse>

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:pixiGetOrder>
            <OrderNr xsi:type="xsd:integer">123</OrderNr>
            <OrderNrXML xsi:type="xsd:string">see aditional notes</OrderNrXML>
            <OrderNrExternal xsi:type="xsd:string">Ext_1234</OrderNrExternal>
        </ns1:pixiGetOrder>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrder', [
    'OrderNr' => '123', // integer
    'OrderNrXML' => 'see aditional notes', // string
    'OrderNrExternal' => 'Ext_1234', // 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);
}

Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetOrder

Request

Request body

Request Example

Response

1. Complette order information

Response Example

HTTP Example

PHP Example