pixiGetOrderChanges

API call to get all changes to an order

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

Orderlines Orders

Request

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

Request body

Name	Type	Required	Description
DateTo	string	false	Date Filter To Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927)
ShopID	string	false	pixi Shop ID or empty, if all shops Type: varchar(3) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)
DateFrom	string	false	Date Filter From Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927)
ChangeType	string	false	Type of Change, or empty if all (available types: CORDER, CORDERL, UORDER, UORDERL, IORDER, SORDER, ALL) Type: varchar(10) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)
PaymentType	string	false	pixi payment code or empty, if all payment codes Type: char Default value: Example: Single character : "g" Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrderChanges>
      <ChangeType>string</ChangeType>
      <ShopID>string</ShopID>
      <PaymentType>string</PaymentType>
      <DateFrom>string</DateFrom>
      <DateTo>string</DateTo>
    </pixiGetOrderChanges>
  </Body>
</Envelope>

Response

1. Result output

Name	Type	Description
Param1	string	Param1 (Empty, OrderlineKey, InvoiceNr) Type: varchar (100) Available from: 25.06 (25.6.0.58802)
OrderNr	integer	pixi Order Number Type: int Available from: 25.06 (25.6.0.58802)
Timestamp	string	Timestamp Type: datetime Available from: 25.06 (25.6.0.58802)
ChangeType	string	Change Type (CORDER : Check for New Orders; UORDER : Check for updated order details; UORDERL : Check for updated orderline details; CORDERL : Check for updated orderline details; IORDER : Check for invoiced orderlines; SORDER : Check for invoiced orderlines; ) Type: varchar (10) Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetOrderChangesPost200TextXmlResponse>
  <OrderNr>0</OrderNr>
  <ChangeType>string</ChangeType>
  <Timestamp>string</Timestamp>
  <Param1>string</Param1>
</PixiGetOrderChangesPost200TextXmlResponse>

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:pixiGetOrderChanges>
            <DateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateTo>
            <ShopID xsi:type="xsd:string">abcdefg</ShopID>
            <DateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateFrom>
            <ChangeType xsi:type="xsd:string">abcdefg</ChangeType>
            <PaymentType xsi:type="xsd:string">Single character : "g"</PaymentType>
        </ns1:pixiGetOrderChanges>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrderChanges', [
    'DateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'ShopID' => 'abcdefg', // string
    'DateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
    'ChangeType' => 'abcdefg', // string
    'PaymentType' => 'Single character : "g"', // 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