Unofficial Pixi-API-Documentation

by koempf24.de

pixiCanChangeAddress

Pixi-Docs
Old Pixi-Docs

This function is used to check, whether a given order is at a stage when billing and shipping addresses can still be changed. Function can accept either pixi* order number or the shop order number. In case both parameters are supplied and denote two different orders, the returned infomation might not be correct, which is why it is recommended to use only one of the parameters.

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
OrderNr integer false

[ optional] pixi* order number

Type: int

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
OrderNrExternal string false

[ optional] Shop order number

Type: varchar (50)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

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

Response

Name Type Description
return integer

1 if the address information still can be updated 0 if the address information can not be updated

Type: int

Available from: LOU Official (6.3.0.4452)

Response Example

<PixiCanChangeAddressPost200TextXmlResponse>
  <return>0</return>
</PixiCanChangeAddressPost200TextXmlResponse>

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:pixiCanChangeAddress>
            <OrderNr xsi:type="xsd:integer"></OrderNr>
            <OrderNrExternal xsi:type="xsd:string"></OrderNrExternal>
        </ns1:pixiCanChangeAddress>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCanChangeAddress', [
    'OrderNr' => '', // integer
    'OrderNrExternal' => '', // 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);
}