pixiSetOrderShippingInformation

API call set the shipping information for order

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

General

Request

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

Request body

Name	Type	Required	Description
OrderNr	integer	false	pixi order number Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)
DHLExtra	string	false	Transport remark (extras) Type: varchar(50) Default value: NULL Example: 7210 Available from: LOU Official - Update 46 (6.9.46.27927)
DHLProdukt	string	false	Transport remark (product) Type: varchar(50) Default value: NULL Example: 72 Available from: LOU Official - Update 46 (6.9.46.27927)
ShipVendor	string	false	Shipping vendor code Type: varchar(3) Default value: NULL Example: DHL Available from: LOU Official - Update 46 (6.9.46.27927)
DHLVerfahren	string	false	Transport remark (procedure) Type: varchar(50) Default value: NULL Example: 7202 Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNrExternal	string	false	External (shop) order number Type: varchar(50) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetOrderShippingInformation>
      <OrderNr>0</OrderNr>
      <OrderNrExternal>string</OrderNrExternal>
      <ShipVendor>string</ShipVendor>
      <DHLProdukt>string</DHLProdukt>
      <DHLVerfahren>string</DHLVerfahren>
      <DHLExtra>string</DHLExtra>
    </pixiSetOrderShippingInformation>
  </Body>
</Envelope>

Response

1. Status and result

Name	Type	Description
Status	integer	Execution status Type: int Available from: 25.06 (25.6.0.58802)
Message	string	Status description Type: varchar Available from: 25.06 (25.6.0.58802)
OrderNr	integer	pixi order number Type: int Available from: 25.06 (25.6.0.58802)
DHLExtra	string	Transport remark (extras) Type: varchar Available from: 25.06 (25.6.0.58802)
DHLProdukt	string	Transport remark (product) Type: varchar Available from: 25.06 (25.6.0.58802)
ShipVendor	string	Shipping vendor code Type: varchar Available from: 25.06 (25.6.0.58802)
DHLVerfahren	string	Transport remark (procedure) Type: varchar Available from: 25.06 (25.6.0.58802)
OrderNrExternal	string	External (shop) order number Type: varchar Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetOrderShippingInformationPost200TextXmlResponse>
  <Status>0</Status>
  <Message>string</Message>
  <OrderNr>0</OrderNr>
  <OrderNrExternal>string</OrderNrExternal>
  <ShipVendor>string</ShipVendor>
  <DHLProdukt>string</DHLProdukt>
  <DHLVerfahren>string</DHLVerfahren>
  <DHLExtra>string</DHLExtra>
</PixiSetOrderShippingInformationPost200TextXmlResponse>

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:pixiSetOrderShippingInformation>
            <OrderNr xsi:type="xsd:integer">123</OrderNr>
            <DHLExtra xsi:type="xsd:string">7210</DHLExtra>
            <DHLProdukt xsi:type="xsd:string">72</DHLProdukt>
            <ShipVendor xsi:type="xsd:string">DHL</ShipVendor>
            <DHLVerfahren xsi:type="xsd:string">7202</DHLVerfahren>
            <OrderNrExternal xsi:type="xsd:string">abcdefg</OrderNrExternal>
        </ns1:pixiSetOrderShippingInformation>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetOrderShippingInformation', [
    'OrderNr' => '123', // integer
    'DHLExtra' => '7210', // string
    'DHLProdukt' => '72', // string
    'ShipVendor' => 'DHL', // string
    'DHLVerfahren' => '7202', // string
    'OrderNrExternal' => '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);
}

Unofficial Pixi-API-Documentation

by koempf24.de