Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetOrderlineHistory

Pixi-Docs
Old Pixi-Docs

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:

Orderlines Orders

Request

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

Request body

Name Type Required Description
OrderlineKey integer true

Orderline Id

Type: int

Default value:

Example: 123

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrderlineHistory>
      <OrderlineKey>0</OrderlineKey>
    </pixiGetOrderlineHistory>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Status string

The new status

Type: varchar

Available from: / (25.7.0.59144)
UpdateUser string

Username of the person who did this change

Type: varchar

Available from: / (25.7.0.59144)
ClientNotified string

ClientNotified

Type: char

Available from: / (25.7.0.59144)
OrderlineHistKey integer

Orderline History Id

Type: int

Available from: / (25.7.0.59144)
StatusChangeDate string

Date of the given status change

Type: datetime

Available from: / (25.7.0.59144)

Response Example

<PixiGetOrderlineHistoryPost200TextXmlResponse>
  <StatusChangeDate>string</StatusChangeDate>
  <Status>string</Status>
  <UpdateUser>string</UpdateUser>
  <ClientNotified>string</ClientNotified>
  <OrderlineHistKey>0</OrderlineHistKey>
</PixiGetOrderlineHistoryPost200TextXmlResponse>

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:pixiGetOrderlineHistory>
            <OrderlineKey xsi:type="xsd:integer">123</OrderlineKey> <!-- required -->
        </ns1:pixiGetOrderlineHistory>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrderlineHistory', [
    'OrderlineKey' => '123', // integer (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);
}