Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetShippingLock

Pixi-Docs
Old Pixi-Docs

Sets Shipping Lock for a customer by CustKey or CustomerNrExternal

Since pixi version: LOU Official (6.3.0.4452) Additional notes: This call sets the lock on customer level. All orders for this customers are prevented to be shipped. Note that the actual shipping lock for individual orders is not changed.

General

Request

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

Request body

Name Type Required Description
Locked boolean false

1 = Customer Lock set, 0 = Customer Lock released

Type: bit

Default value: 1

Example: 0 or 1

Available from: LOU Official (6.3.0.4452)
ShopID string false

pixi* Shop ID

Type: varchar(3)

Default value: NULL

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)
CustKey integer false

Internal pixi* Customer ID

Type: int

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)
UserName string false

User that updated the customer lock

Type: varchar(50)

Default value: API

Example: abcdefg

Available from: 18.08 (8.4.44.35152)
CustomerNrExternal string false

Customer Nr from Shop

Type: varchar(250)

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="">
    <pixiSetShippingLock>
      <CustKey>0</CustKey>
      <Locked>true</Locked>
      <CustomerNrExternal>string</CustomerNrExternal>
      <ShopID>string</ShopID>
      <UserName>string</UserName>
    </pixiSetShippingLock>
  </Body>
</Envelope>

Response

1. Update status

Name Type Description
Result integer

0 when update successfull, 1 when update failed

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetShippingLockPost200TextXmlResponse>
  <Result>0</Result>
</PixiSetShippingLockPost200TextXmlResponse>

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:pixiSetShippingLock>
            <Locked xsi:type="xsd:boolean">0 or 1</Locked>
            <ShopID xsi:type="xsd:string">abcdefg</ShopID>
            <CustKey xsi:type="xsd:integer">123</CustKey>
            <UserName xsi:type="xsd:string">abcdefg</UserName>
            <CustomerNrExternal xsi:type="xsd:string">abcdefg</CustomerNrExternal>
        </ns1:pixiSetShippingLock>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetShippingLock', [
    'Locked' => '0 or 1', // boolean
    'ShopID' => 'abcdefg', // string
    'CustKey' => '123', // integer
    'UserName' => 'abcdefg', // string
    'CustomerNrExternal' => '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);
}