Unofficial Pixi-API-Documentation

by koempf24.de

pixiMergeOrders

Pixi-Docs
Old Pixi-Docs

Merge customer orders

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

Orderlines Orders

Request

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

Request body

Name Type Required Description
Employee string false

User who does the merge

Type: varchar(50)

Default value: NULL

Example: abcdef

Available from: LOU Official (6.3.0.4452)
ResultMessage string false

Result Message - output

Type: varchar(128)

Default value: NULL

Example: abcdef

Available from: LOU Official (6.3.0.4452)
SourceOrderNr integer true

Source Order number

Type: int

Default value:

Example: 123456

Available from: LOU Official (6.3.0.4452)
TargetOrderNr integer true

Target Order number

Type: int

Default value:

Example: 123456

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiMergeOrders>
      <TargetOrderNr>0</TargetOrderNr>
      <SourceOrderNr>0</SourceOrderNr>
      <Employee>string</Employee>
      <ResultMessage>string</ResultMessage>
    </pixiMergeOrders>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
ResultMessage string

See pixiCanMergeOrders for the list of possible outputs. If pixiCanMergeOrders returns a positive answer, but the operation still fails, the result is: 500 Unexpected error

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiMergeOrdersPost200TextXmlResponse>
  <ResultMessage>string</ResultMessage>
</PixiMergeOrdersPost200TextXmlResponse>

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:pixiMergeOrders>
            <Employee xsi:type="xsd:string">abcdef</Employee>
            <ResultMessage xsi:type="xsd:string">abcdef</ResultMessage>
            <SourceOrderNr xsi:type="xsd:integer">123456</SourceOrderNr> <!-- required -->
            <TargetOrderNr xsi:type="xsd:integer">123456</TargetOrderNr> <!-- required -->
        </ns1:pixiMergeOrders>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiMergeOrders', [
    'Employee' => 'abcdef', // string
    'ResultMessage' => 'abcdef', // string
    'SourceOrderNr' => '123456', // integer (required)
    'TargetOrderNr' => '123456', // 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);
}