Unofficial Pixi-API-Documentation

by koempf24.de

pixiTagMatchAddForOrders

Pixi-Docs
Old Pixi-Docs

Set Tags for Orders. Example of XML: ' <Tags><Order><OrderId>12345</OrderId><TagList><Tag><TagId>303</TagId></Tag></TagList></Order><Order><OrderNrExternal>P_133353</OrderNrExternal><TagList><Tag><TagId>-33</TagId></Tag></TagList></Order></Tags>'

Since pixi version: 19.06 (9.0.4.39859) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
TagsXML string true

XML for Orders.

Type: varchar(-1)

Default value: NULL

Example:

Available from: 19.06 (9.0.4.39859)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiTagMatchAddForOrders>
      <TagsXML>string</TagsXML>
    </pixiTagMatchAddForOrders>
  </Body>
</Envelope>

Response

1. Status response

Name Type Description
Status string

Status (Error/Warning/Success)

Type: VARCHAR(256)

Available from: 25.06 (25.6.0.58802)
Message string

Message (Status detail information)

Type: VARCHAR(256)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiTagMatchAddForOrdersPost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiTagMatchAddForOrdersPost200TextXmlResponse>

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:pixiTagMatchAddForOrders>
            <TagsXML xsi:type="xsd:string"></TagsXML> <!-- required -->
        </ns1:pixiTagMatchAddForOrders>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiTagMatchAddForOrders', [
    'TagsXML' => '', // 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);
}