Unofficial Pixi-API-Documentation

by koempf24.de

pixiRemoveItemFromPicklist

Pixi-Docs
Old Pixi-Docs

API call deletes item in specified quantity from picklist.

Since pixi version: 19.01 (8.4.49.36788) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
EanUpc string true

Item Barcode.

Type: varchar(50)

Default value: NULL

Example: abc123

Available from: 19.01 (8.4.49.36788)
BinName string true

Bin Name.

Type: varchar(50)

Default value: NULL

Example: A-1-1

Available from: 19.01 (8.4.49.36788)
Quantity integer true

Quantity to remove.

Type: int

Default value: NULL

Example: 1

Available from: 19.01 (8.4.49.36788)
PickListNr integer true

Picklist number.

Type: int

Default value: NULL

Example: 1234

Available from: 19.01 (8.4.49.36788)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiRemoveItemFromPicklist>
      <PickListNr>0</PickListNr>
      <EanUpc>string</EanUpc>
      <BinName>string</BinName>
      <Quantity>0</Quantity>
    </pixiRemoveItemFromPicklist>
  </Body>
</Envelope>

Response

1. Response Message.

Name Type Description
Status string

[Status] of the response. ("SUCCESS" or "ERROR")

Type: varchar

Available from: 25.06 (25.6.0.58802)
Message string

Detailed success or error message.

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiRemoveItemFromPicklistPost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiRemoveItemFromPicklistPost200TextXmlResponse>

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:pixiRemoveItemFromPicklist>
            <EanUpc xsi:type="xsd:string">abc123</EanUpc> <!-- required -->
            <BinName xsi:type="xsd:string">A-1-1</BinName> <!-- required -->
            <Quantity xsi:type="xsd:integer">1</Quantity> <!-- required -->
            <PickListNr xsi:type="xsd:integer">1234</PickListNr> <!-- required -->
        </ns1:pixiRemoveItemFromPicklist>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiRemoveItemFromPicklist', [
    'EanUpc' => 'abc123', // string (required)
    'BinName' => 'A-1-1', // string (required)
    'Quantity' => '1', // integer (required)
    'PickListNr' => '1234', // 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);
}