Unofficial Pixi-API-Documentation

by koempf24.de

pixiReleaseOrder

Pixi-Docs
Old Pixi-Docs

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

Orderlines Orders

Request

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

Request body

Name Type Required Description
ShopId string true

ShopId code identifier.

Type: char

Default value:

Example: ABC

Available from: LOU Official (6.3.0.4452)
OrderNrExternal string true

pixi* order number external / shop order number

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReleaseOrder>
      <OrderNrExternal>string</OrderNrExternal>
      <ShopId>string</ShopId>
    </pixiReleaseOrder>
  </Body>
</Envelope>

Response

Name Type Description
ReturnCode string

Message can be either "OK" or "ERROR"

Type: varchar (5)

Available from: 25.06 (25.6.0.58802)
AffectedRows integer

How many orderlines were released

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReleaseOrderPost200TextXmlResponse>
  <ReturnCode>string</ReturnCode>
  <AffectedRows>0</AffectedRows>
</PixiReleaseOrderPost200TextXmlResponse>

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:pixiReleaseOrder>
            <ShopId xsi:type="xsd:string">ABC</ShopId> <!-- required -->
            <OrderNrExternal xsi:type="xsd:string">abcdefg</OrderNrExternal> <!-- required -->
        </ns1:pixiReleaseOrder>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReleaseOrder', [
    'ShopId' => 'ABC', // string (required)
    'OrderNrExternal' => 'abcdefg', // 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);
}