Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetOrderlinesInBoxToAUS

Pixi-Docs
Old Pixi-Docs

API call sets status of orderliness in the box to status "AUS". And empties the box.

Since pixi version: AVA Official - Update 23 (8.4.23.27873) Additional notes: The API call can only be used when "Centralized Ship-Out" or "Premium API" setting are enabled.

Shipping

Request

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

Request body

Name Type Required Description
OrderNr integer true

pixi* order number.

Type: int

Default value:

Example: 123

Available from: AVA Official - Update 23 (8.4.23.27873)
UserName string false

User-Name used for putting orderliness status to AUS.

Type: varchar(50)

Default value: API

Example: abcdefg

Available from: AVA Official - Update 23 (8.4.23.27873)

Request Example

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

Response

Name Type Description
Info string

Description of the status

Type: varchar

Available from: 25.06 (25.6.0.58802)
Status string

Execution status (OK/ERROR)

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetOrderlinesInBoxToAUSPost200TextXmlResponse>
  <Status>string</Status>
  <Info>string</Info>
</PixiSetOrderlinesInBoxToAUSPost200TextXmlResponse>

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:pixiSetOrderlinesInBoxToAUS>
            <OrderNr xsi:type="xsd:integer">123</OrderNr> <!-- required -->
            <UserName xsi:type="xsd:string">abcdefg</UserName>
        </ns1:pixiSetOrderlinesInBoxToAUS>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetOrderlinesInBoxToAUS', [
    'OrderNr' => '123', // integer (required)
    'UserName' => 'abcdefg', // 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);
}