Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetOrderShippingLock

Pixi-Docs
Old Pixi-Docs

API call to set order shipping lock.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: In case when the reason is empty we add Order was locked by / Order was unlocked by + UserName.

Orderlines Orders

Request

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

Request body

Name Type Required Description
Locked boolean false

1 = Order Shipping Lock set, 0 = Order Shipping Lock released

Type: bit

Default value: 1

Example: 0 or 1

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

Released / Locked reason

Type: varchar(255)

Default value:

Example: abcdefg

Available from: 23.03 (23.3.0.36397)
OrderNr integer true

Order to set shipping lock

Type: int

Default value:

Example: 123

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

User that updated the order shipping lock

Type: varchar(50)

Default value: API

Example: abcdefg

Available from: 23.03 (23.3.0.36397)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetOrderShippingLock>
      <OrderNr>0</OrderNr>
      <Locked>true</Locked>
      <UserName>string</UserName>
      <Reason>string</Reason>
    </pixiSetOrderShippingLock>
  </Body>
</Envelope>

Response

1. Result Set.

Name Type Description
ReturnCode string

Return code (OK / INFO / ERROR)

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

Return description message.

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetOrderShippingLockPost200TextXmlResponse>
  <ReturnCode>string</ReturnCode>
  <ErrorMessage>string</ErrorMessage>
</PixiSetOrderShippingLockPost200TextXmlResponse>

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:pixiSetOrderShippingLock>
            <Locked xsi:type="xsd:boolean">0 or 1</Locked>
            <Reason xsi:type="xsd:string">abcdefg</Reason>
            <OrderNr xsi:type="xsd:integer">123</OrderNr> <!-- required -->
            <UserName xsi:type="xsd:string">abcdefg</UserName>
        </ns1:pixiSetOrderShippingLock>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetOrderShippingLock', [
    'Locked' => '0 or 1', // boolean
    'Reason' => 'abcdefg', // string
    'OrderNr' => '123', // integer (required)
    'UserName' => '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);
}