Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetBoxRangeForPicklist

Pixi-Docs
Old Pixi-Docs

API call to set box range for a picklist

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: API call allows changing the box range for picklists even if items have already been put to box.

Shipping

Request

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

Request body

Name Type Required Description
BoxNrTo integer true

End of box range

Type: int

Default value:

Example: 20

Available from: LOU Official - Update 46 (6.9.46.27927)
Picklist integer true

Picklist number

Type: int

Default value:

Example: 1234

Available from: LOU Official - Update 46 (6.9.46.27927)
BoxNrFrom integer true

Start of box range

Type: int

Default value:

Example: 10

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetBoxRangeForPicklist>
      <Picklist>0</Picklist>
      <BoxNrFrom>0</BoxNrFrom>
      <BoxNrTo>0</BoxNrTo>
    </pixiSetBoxRangeForPicklist>
  </Body>
</Envelope>

Response

1. Successfull response

Name Type Description
Status string

Status message

Type: varchar (1000)

Available from: 25.06 (25.6.0.58802)
BoxNrTo integer

End of box range

Type: int

Available from: 25.06 (25.6.0.58802)
Picklist integer

Picklist number

Type: int

Available from: 25.06 (25.6.0.58802)
BoxNrFrom integer

Start of box range

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetBoxRangeForPicklistPost200TextXmlResponse>
  <Picklist>0</Picklist>
  <BoxNrFrom>0</BoxNrFrom>
  <BoxNrTo>0</BoxNrTo>
  <Status>string</Status>
</PixiSetBoxRangeForPicklistPost200TextXmlResponse>

2. Successfull response

Name Type Description
Status string

Status (Error/Success)

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)
Message string

Error description

Type: varchar (1000)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetBoxRangeForPicklistPost200TextXmlResponse>
  <Picklist>0</Picklist>
  <BoxNrFrom>0</BoxNrFrom>
  <BoxNrTo>0</BoxNrTo>
  <Status>string</Status>
</PixiSetBoxRangeForPicklistPost200TextXmlResponse>

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:pixiSetBoxRangeForPicklist>
            <BoxNrTo xsi:type="xsd:integer">20</BoxNrTo> <!-- required -->
            <Picklist xsi:type="xsd:integer">1234</Picklist> <!-- required -->
            <BoxNrFrom xsi:type="xsd:integer">10</BoxNrFrom> <!-- required -->
        </ns1:pixiSetBoxRangeForPicklist>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetBoxRangeForPicklist', [
    'BoxNrTo' => '20', // integer (required)
    'Picklist' => '1234', // integer (required)
    'BoxNrFrom' => '10', // integer (required)
]);

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