Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetOrderHeaderList

Pixi-Docs
Old Pixi-Docs

Get list of data for orders specified in XML

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

OrderNrExternal1 OrderNrExternal2
General

Request

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

Request body

Name Type Required Description
OrderNrExternalXml string true

Simple XML input parameter with list of OrderNrExternal.

Type: xml

Default value:

Example: See Additional Notes

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrderHeaderList>
      <OrderNrExternalXml>string</OrderNrExternalXml>
    </pixiGetOrderHeaderList>
  </Body>
</Envelope>

Response

1. Get list of data for orders specified in XML

Name Type Description
Blz string

Bank Code

Type: varchar

Available from: / (25.8.0.59841)
ZIP string

ZIP

Type: varchar

Available from: / (25.8.0.59841)
City string

City

Type: varchar

Available from: / (25.8.0.59841)
Paid boolean

Paid

Type: bit

Available from: / (25.8.0.59841)
Gender integer

Gender

Type: int

Available from: / (25.8.0.59841)
ShopID string

Shop ID

Type: varchar

Available from: / (25.8.0.59841)
Street string

Street

Type: varchar

Available from: / (25.8.0.59841)
Account string

Account

Type: varchar

Available from: / (25.8.0.59841)
CustKey integer

Customer ID

Type: int

Available from: / (25.8.0.59841)
OrderNr integer

pixi Order Number

Type: int

Available from: / (25.8.0.59841)
BankName string

Name of the Bank

Type: varchar

Available from: / (25.8.0.59841)
CcCardNr string

Number of the credit card used for payment

Type: varchar

Available from: / (25.8.0.59841)
LastName string

Last Name

Type: varchar

Available from: / (25.8.0.59841)
PayedSum number

Payed Sum

Type: money

Available from: / (25.8.0.59841)
Referrer string

Referrer

Type: varchar

Available from: / (25.8.0.59841)
ShipCost number

The total shipping costs of the whole order

Type: money

Available from: / (25.8.0.59841)
Shipdate string

Ship this order at this date only! not before

Type: datetime

Available from: / (25.8.0.59841)
ShopNote string

Note received with this order from the shop

Type: varchar

Available from: / (25.8.0.59841)
BirthDate string

Birth Date

Type: datetime

Available from: / (25.8.0.59841)
CcCardExp string

Expiry date of the creditcard

Type: varchar

Available from: / (25.8.0.59841)
FirstName string

First Name

Type: varchar

Available from: / (25.8.0.59841)
OrderDate string

Order Date

Type: datetime

Available from: / (25.8.0.59841)
VoucherID string

ID of the voucher

Type: varchar

Available from: / (25.8.0.59841)
CcCardName string

Name of the credit institute

Type: varchar

Available from: / (25.8.0.59841)
CcCardType string

Type of creditcard

Type: varchar

Available from: / (25.8.0.59841)
CreateDate string

Create date

Type: datetime

Available from: / (25.8.0.59841)
CustomerNr string

Customer Number

Type: varchar

Available from: / (25.8.0.59841)
OrderTotal number

Order Total

Type: money

Available from: / (25.8.0.59841)
ShipVendor string

Shipping vendor code

Type: varchar

Available from: / (25.8.0.59841)
TrackingID string

Tracking ID of the shipment. Applies to the orders that have been shipped

Type: varchar

Available from: / (25.8.0.59841)
AccountName string

Name of the owner of this bank account

Type: varchar

Available from: / (25.8.0.59841)
GiftMessage string

Gift Message

Type: varchar

Available from: / (25.8.0.59841)
OrderLocked string

Y/N flag indicating whether the order is locked

Type: varchar

Available from: / (25.8.0.59841)
PaymentType string

Payment type code

Type: varchar

Available from: / (25.8.0.59841)
SubShopLogo string

Sub Shop Logo

Type: varchar

Available from: / (25.8.0.59841)
SubShopName string

Sub Shop Name

Type: varchar

Available from: / (25.8.0.59841)
LastShipdate string

Last Ship date

Type: datetime

Available from: / (25.8.0.59841)
CustomerEmail string

Customer Email

Type: varchar

Available from: / (25.8.0.59841)
LastInvoiceNr string

Last Invoice Number

Type: varchar

Available from: / (25.8.0.59841)
OrderCurrency string

Order Currency

Type: varchar

Available from: / (25.8.0.59841)
VoucherAmount number

Amount covered with the associated voucher

Type: money

Available from: / (25.8.0.59841)
AddressRemarks string

Address Remarks

Type: varchar

Available from: / (25.8.0.59841)
OrderHeaderKey integer

ID of the order header record

Type: int

Available from: / (25.8.0.59841)
SalutationText string

SalutationText

Type: varchar

Available from: / (25.8.0.59841)
OrderNrExternal string

External order number

Type: varchar

Available from: / (25.8.0.59841)
OrderlinesTotal number

Orderlines Total

Type: money

Available from: / (25.8.0.59841)
ShippingCountry string

Shipping Country

Type: varchar

Available from: / (25.8.0.59841)
WholeOrderState string

Status of the order

Type: varchar

Available from: / (25.8.0.59841)
PaymentAddressId integer

Payment Address Id

Type: int

Available from: / (25.8.0.59841)
EstimatedDelivery string

Estimated Delivery

Type: datetime

Available from: / (25.8.0.59841)
ShipmentAddressId integer

Shipment Address Id

Type: int

Available from: / (25.8.0.59841)
CustomerNrExternal string

External Reference to the Customer (imported from Shop)

Type: varchar

Available from: / (25.8.0.59841)
OrderTotal_OrderCurr number

Order Total Order Currency

Type: money

Available from: / (25.8.0.59841)

Response Example

<PixiGetOrderHeaderListPost200TextXmlResponse>
  <OrderHeaderKey>0</OrderHeaderKey>
  <OrderNr>0</OrderNr>
  <CreateDate>string</CreateDate>
  <OrderNrExternal>string</OrderNrExternal>
  <OrderTotal>0</OrderTotal>
  <OrderlinesTotal>0</OrderlinesTotal>
  <WholeOrderState>string</WholeOrderState>
  <Shipdate>string</Shipdate>
  <LastShipdate>string</LastShipdate>
  <TrackingID>string</TrackingID>
  <ShipVendor>string</ShipVendor>
  <ShopID>string</ShopID>
  <OrderDate>string</OrderDate>
  <ShipCost>0</ShipCost>
  <PaymentAddressId>0</PaymentAddressId>
  <ShipmentAddressId>0</ShipmentAddressId>
  <ShopNote>string</ShopNote>
  <PaymentType>string</PaymentType>
  <VoucherID>string</VoucherID>
  <VoucherAmount>0</VoucherAmount>
  <CcCardType>string</CcCardType>
  <CcCardNr>string</CcCardNr>
  <CcCardName>string</CcCardName>
  <CcCardExp>string</CcCardExp>
  <Account>string</Account>
  <Blz>string</Blz>
  <BankName>string</BankName>
  <AccountName>string</AccountName>
  <AddressRemarks>string</AddressRemarks>
  <CustKey>0</CustKey>
  <SalutationText>string</SalutationText>
  <Gender>0</Gender>
  <LastName>string</LastName>
  <FirstName>string</FirstName>
  <ShippingCountry>string</ShippingCountry>
  <ZIP>string</ZIP>
  <City>string</City>
  <Street>string</Street>
  <BirthDate>string</BirthDate>
  <CustomerNr>string</CustomerNr>
  <SubShopName>string</SubShopName>
  <SubShopLogo>string</SubShopLogo>
  <Referrer>string</Referrer>
  <GiftMessage>string</GiftMessage>
  <OrderCurrency>string</OrderCurrency>
  <OrderTotal_OrderCurr>0</OrderTotal_OrderCurr>
  <Paid>true</Paid>
  <PayedSum>0</PayedSum>
  <CustomerEmail>string</CustomerEmail>
  <CustomerNrExternal>string</CustomerNrExternal>
  <EstimatedDelivery>string</EstimatedDelivery>
  <OrderLocked>string</OrderLocked>
  <LastInvoiceNr>string</LastInvoiceNr>
</PixiGetOrderHeaderListPost200TextXmlResponse>

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:pixiGetOrderHeaderList>
            <OrderNrExternalXml xsi:type="xsd:string">See Additional Notes</OrderNrExternalXml> <!-- required -->
        </ns1:pixiGetOrderHeaderList>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrderHeaderList', [
    'OrderNrExternalXml' => 'See Additional Notes', // 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);
}