Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetOrderlineLocation

Pixi-Docs
Old Pixi-Docs

Since pixi version: AVA Official - Update 23 (8.4.23.27873) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
LocationId string true

Location name to be set

Type: char

Default value:

Example: ABC

Available from: AVA Official - Update 23 (8.4.23.27873)
OrderlineKey integer false

OrderLine to be updated (OrderlineKey or BundleOrderlineKey) in case order lines items is part of bundle all other items in bundle will be also updated

Type: int

Default value: NULL

Example: 123

Available from: AVA Official - Update 23 (8.4.23.27873)
BundleOrderlineKey integer false

BundleorderLine to be updated (OrderlineKey or BundleOrderlineKey)

Type: int

Default value: NULL

Example: 123

Available from: AVA Official - Update 23 (8.4.23.27873)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetOrderlineLocation>
      <OrderlineKey>0</OrderlineKey>
      <BundleOrderlineKey>0</BundleOrderlineKey>
      <LocationId>string</LocationId>
    </pixiSetOrderlineLocation>
  </Body>
</Envelope>

Response

Name Type Description
ReturnCode string

Type: varchar

Available from: / (25.7.0.59144)
ErrorMessage string

Error message

Type: varchar

Available from: / (25.7.0.59144)

Response Example

<PixiSetOrderlineLocationPost200TextXmlResponse>
  <ReturnCode>string</ReturnCode>
  <ErrorMessage>string</ErrorMessage>
</PixiSetOrderlineLocationPost200TextXmlResponse>

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:pixiSetOrderlineLocation>
            <LocationId xsi:type="xsd:string">ABC</LocationId> <!-- required -->
            <OrderlineKey xsi:type="xsd:integer">123</OrderlineKey>
            <BundleOrderlineKey xsi:type="xsd:integer">123</BundleOrderlineKey>
        </ns1:pixiSetOrderlineLocation>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetOrderlineLocation', [
    'LocationId' => 'ABC', // string (required)
    'OrderlineKey' => '123', // integer
    'BundleOrderlineKey' => '123', // integer
]);

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