pixiSetShippingLock · Pixi API documentation

Sets the shipping lock flag of one customer record in Customers.

UserName is trimmed. If it is empty or missing, API is used. The value is written to Customers.UpdateEmp.
Locked is converted to the stored value: 1 becomes Y. Any other value, including 0 and NULL, becomes N.
If CustomerNrExternal is not empty, the procedure looks up the CustKey of the customer whose CustomerNrExternal matches and whose CustomerOf equals ShopID. If several customers match, only one of them (TOP 1, no defined order) is used.
The customer with the resulting CustKey gets SLocked and UpdateEmp updated.
A single row with the column Result is returned: 0 if exactly one customer was updated, 1 otherwise.

Notes

If CustomerNrExternal is given but no customer matches, the variable keeps the passed CustKey. In that case the customer with that CustKey is updated, or nothing is updated if CustKey is NULL.
ShopID is compared with =. If ShopID is NULL while CustomerNrExternal is set, the lookup never finds a match.
If neither CustKey nor a matching external number is given, no row is updated and Result = 1 is returned.
The lookup uses UPDLOCK. There is no explicit transaction, so the lock is held only for the duration of that statement.
No error messages are produced. Only the Result value indicates success or failure.

Tables used

Customers · Write

Parameter	Type	Default	Description
`CustKey`	int	NULL	Internal key of the customer. Used if `CustomerNrExternal` is empty or no matching customer is found by it. Example: `10452`
`Locked`	bit boolean	1	`1` sets the shipping lock (`SLocked` = `Y`). Any other value removes it (`SLocked` = `N`). Allowed values `1` – Lock shipping (`SLocked` = `Y`) `0` – Unlock shipping (`SLocked` = `N`) Example: `1`
`CustomerNrExternal`	varchar(250) string	NULL	External customer number, for example from the shop. If set, the customer is looked up by this number together with `ShopID`. Example: `SHOP-000123`
`ShopID`	varchar(3) string	NULL	Shop code compared with `Customers.CustomerOf`. Required for the lookup by `CustomerNrExternal`. Example: `WEB`
`UserName`	varchar(50) string	NULL	User name written to `UpdateEmp`. If empty or missing, `API` is used. Example: `shopsync`

Result set 1 · Always

Single row with the outcome of the update.

Column	Type	Description
`Result`	int	`0` if exactly one customer was updated, `1` if no customer was updated.

Response example

<SqlRowSet1>
  <row>
    <Result>0</Result>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiSetShippingLock>
      <!-- <CustKey>10452</CustKey> -->
      <!-- <Locked>1</Locked> -->
      <!-- <CustomerNrExternal>SHOP-000123</CustomerNrExternal> -->
      <!-- <ShopID>WEB</ShopID> -->
      <!-- <UserName>shopsync</UserName> -->
    </ns1:pixiSetShippingLock>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiSetShippingLock>
      <!-- <CustKey>10452</CustKey> -->
      <!-- <Locked>1</Locked> -->
      <!-- <CustomerNrExternal>SHOP-000123</CustomerNrExternal> -->
      <!-- <ShopID>WEB</ShopID> -->
      <!-- <UserName>shopsync</UserName> -->
    </ns1:pixiSetShippingLock>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'CustKey' => '10452',
    // 'Locked' => '1',
    // 'CustomerNrExternal' => 'SHOP-000123',
    // 'ShopID' => 'WEB',
    // 'UserName' => 'shopsync',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiSetShippingLock', $soapArguments);