Unofficial Pixi-API-Documentation

by koempf24.de

pixiCreateReturnCase

Pixi-Docs
Old Pixi-Docs

This call creates a new return case for pixi* Repairs

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

This API call is used to create a new return case which can be worked on in pixi* Repairs.

    These return cases are not shown in Customer Service, Web and can also not be opened in pixi* Mobile.
Replacements Returns

Request

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

Request body

Name Type Required Description
Employee string false

User that created the return case

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
ReturnDate string false

Date when the return arrived

Type: datetime

Default value:

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official (6.3.0.4452)
ReceiversComment string false

Receiver comment

Type: varchar(-1)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCreateReturnCase>
      <ReturnDate>string</ReturnDate>
      <ReceiversComment>string</ReceiversComment>
      <Employee>string</Employee>
    </pixiCreateReturnCase>
  </Body>
</Envelope>

Response

Name Type Description
RET_ID integer

Return case ID

Type: int

Available from: 25.06 (25.6.0.58802)
RET_NUMBER string

Return case number

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCreateReturnCasePost200TextXmlResponse>
  <RET_ID>0</RET_ID>
  <RET_NUMBER>string</RET_NUMBER>
</PixiCreateReturnCasePost200TextXmlResponse>

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:pixiCreateReturnCase>
            <Employee xsi:type="xsd:string">abcdefg</Employee>
            <ReturnDate xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</ReturnDate>
            <ReceiversComment xsi:type="xsd:string">abcdefg</ReceiversComment>
        </ns1:pixiCreateReturnCase>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCreateReturnCase', [
    'Employee' => 'abcdefg', // string
    'ReturnDate' => 'YYYY-MM-DD hh:mm:ss', // string
    'ReceiversComment' => 'abcdefg', // string
]);

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