Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetStandardReturnReasons

Pixi-Docs
Old Pixi-Docs

A simple dictionary function which returns the set of standard return reasons, as defined in the pixi Web application.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: This functionality may be useful if you are implementing a web interface for the replacement/return operation.

    Additionally to the R&R Reasons, it returns the Return-Reasons for normal returns set in Control Center. Returns-Only reasons get a NULL in RET_REASON_ID.
Replacements Returns

Request

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

Request body

Name Type Required Description
LanguageID integer false

Defines the language of return values.

Type: int

Default value: 1

Example: 1 - German, 2 - English

Available from: LOU Official (6.3.0.4452)
OnlyReturnReasonsFromPixiWeb boolean false

Show Return reasons from DB setting and pixi Web Code Table

Type: bit

Default value: 0

Example: 0 = Show All (legacy + web) Return Reasons, 1 = Show only pixi Web Reaturn Reasons

Available from: (25.8.0.59841)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetStandardReturnReasons>
      <LanguageID>0</LanguageID>
      <OnlyReturnReasonsFromPixiWeb>true</OnlyReturnReasonsFromPixiWeb>
    </pixiGetStandardReturnReasons>
  </Body>
</Envelope>

Response

1. Return reasons

Name Type Description
LANGUAGEID integer

Language Id (1 - German , 2 - English), NULL is used for legacy application.

Type: int

Available from: / (25.8.0.59841)
RET_REASON_ID integer

Return reason ID, NULL is used for legacy application.

Type: int

Available from: / (25.8.0.59841)

Response Example

<PixiGetStandardReturnReasonsPost200TextXmlResponse>
  <RET_REASON_ID>0</RET_REASON_ID>
  <LANGUAGEID>0</LANGUAGEID>
</PixiGetStandardReturnReasonsPost200TextXmlResponse>

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:pixiGetStandardReturnReasons>
            <LanguageID xsi:type="xsd:integer">1 - German, 2 - English</LanguageID>
            <OnlyReturnReasonsFromPixiWeb xsi:type="xsd:boolean">0 = Show All (legacy + web) Return Reasons, 1 = Show only pixi Web Reaturn Reasons</OnlyReturnReasonsFromPixiWeb>
        </ns1:pixiGetStandardReturnReasons>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetStandardReturnReasons', [
    'LanguageID' => '1 - German, 2 - English', // integer
    'OnlyReturnReasonsFromPixiWeb' => '0 = Show All (legacy + web) Return Reasons, 1 = Show only pixi Web Reaturn Reasons', // boolean
]);

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);
}