Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetOrderNrExternalByBoxNr

Pixi-Docs
Old Pixi-Docs

API Call returns the OrderNr, OrderNrExternal by BoxNr

Since pixi version: AVA Official - Update 23 (8.4.23.27873) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
BoxNr integer true

Box number

Type: int

Default value:

Example: 123

Available from: AVA Official - Update 23 (8.4.23.27873)
LocId string true

Location id

Type: varchar(3)

Default value: NULL

Example: 001

Available from: 24.08 (24.8.0.50600)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrderNrExternalByBoxNr>
      <BoxNr>0</BoxNr>
      <LocId>string</LocId>
    </pixiGetOrderNrExternalByBoxNr>
  </Body>
</Envelope>

Response

1. Result return

Name Type Description
OrderNrExternal string

OrderNrExternal

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetOrderNrExternalByBoxNrPost200TextXmlResponse>
  <OrderNrExternal>string</OrderNrExternal>
</PixiGetOrderNrExternalByBoxNrPost200TextXmlResponse>

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:pixiGetOrderNrExternalByBoxNr>
            <BoxNr xsi:type="xsd:integer">123</BoxNr> <!-- required -->
            <LocId xsi:type="xsd:string">001</LocId> <!-- required -->
        </ns1:pixiGetOrderNrExternalByBoxNr>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrderNrExternalByBoxNr', [
    'BoxNr' => '123', // integer (required)
    'LocId' => '001', // 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);
}