Unofficial Pixi-API-Documentation

by koempf24.de

pixiOrderSetInfo

Pixi-Docs
Old Pixi-Docs

API Call to set order information

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
OrderNr integer false

pixi Order Number

Type: int

Default value: NULL

Example: 123456

Available from: LOU Official - Update 46 (6.9.46.27927)
Referrer string false

Referrer

Type: varchar(50)

Default value: NULL

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)
SubShopLogo string false

SubShopLogo

Type: varchar(50)

Default value: NULL

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)
SubShopName string false

SubShopName

Type: varchar(50)

Default value: NULL

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNrExternal string false

External Order Number

Type: varchar(50)

Default value: NULL

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiOrderSetInfo>
      <OrderNr>0</OrderNr>
      <OrderNrExternal>string</OrderNrExternal>
      <SubShopName>string</SubShopName>
      <SubShopLogo>string</SubShopLogo>
      <Referrer>string</Referrer>
    </pixiOrderSetInfo>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
ErrorNr string

200 = Update OK 500 = Technical problems during update 404 = Order not found

Type: varchar

Available from: / (25.7.0.59144)
ErrorMessage string

error message if an error occured or empty if there was no error.

Type: varchar

Available from: / (25.7.0.59144)

Response Example

<PixiOrderSetInfoPost200TextXmlResponse>
  <ErrorNr>string</ErrorNr>
  <ErrorMessage>string</ErrorMessage>
</PixiOrderSetInfoPost200TextXmlResponse>

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:pixiOrderSetInfo>
            <OrderNr xsi:type="xsd:integer">123456</OrderNr>
            <Referrer xsi:type="xsd:string">abcdef</Referrer>
            <SubShopLogo xsi:type="xsd:string">abcdef</SubShopLogo>
            <SubShopName xsi:type="xsd:string">abcdef</SubShopName>
            <OrderNrExternal xsi:type="xsd:string">abcdef</OrderNrExternal>
        </ns1:pixiOrderSetInfo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiOrderSetInfo', [
    'OrderNr' => '123456', // integer
    'Referrer' => 'abcdef', // string
    'SubShopLogo' => 'abcdef', // string
    'SubShopName' => 'abcdef', // string
    'OrderNrExternal' => 'abcdef', // 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);
}