Unofficial Pixi-API-Documentation

by koempf24.de

pixiCreatePicklist

Pixi-Docs
Old Pixi-Docs

It can be used to create a picklist and can only be used when the database setting "Premium API"

Since pixi version: 18.02 (8.4.38.33222) Additional notes: The API call can only be used when "Premium API" setting is enabled.

    By default picklists are executed **asynchronously** in 1 minute intervals.
    When executing the API in this mode user needs to wait/read the pixiEXPicklistCreated message before starting a new picklist creation, to prevent parallel picklist creation error.
    
    If the value for parameter **ExecuteAsynchronous** is set to 0 then the API call waits till the picklist creation is done?.
    
    With parameter **ProfileId** user selects the picklist profile that will be used for creation of the picklist. If no profile is selected the default picklist profile will be taken.
    
    The values of the picklist profile can be than additionally updated by parameters:
     - LocationId 
     - OrderNr 
     - BinFrom 
     - BinTo 
     - UserName 
     - Comment
    
    When picklist is created a message is sent out to exchange pixiEXPicklistCreated. 
    
    If an empty picklist is created, the message is sent, but picklist is not seen in the client because it is empty.
    In case created picklist is split into several picklist because of BatchManagement then we send out several messages - one for each created picklists.
    Body of the message:?
    
        {"data":[{"PicklistHeaderId":1891,"LocationId":"001","FromBox":0,"ToBox":0,"OneScanShipping":0,"DaysBeforeBestBeforeDate":0,"Comment":"test picklist"}]}?
General

Request

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

Request body

Name Type Required Description
BinTo string false

Consider bins equal and lower that specified when gathering items

Type: varchar(50)

Default value: NULL

Example: A-00-99

Available from: 18.02 (8.4.38.33222)
BinFrom string false

Consider bins equal and higher that specified when gathering items

Type: varchar(50)

Default value: NULL

Example: A-00-01

Available from: 18.02 (8.4.38.33222)
Comment string false

Comment added to the picklist creation method

Type: varchar(8000)

Default value: NULL

Example: abcdefg

Available from: 18.02 (8.4.38.33222)
OrderNr integer false

Create picklist for a specific order

Type: int

Default value: NULL

Example: 123

Available from: 18.02 (8.4.38.33222)
UserName string false

User starting the picklist creation

Type: varchar(50)

Default value: API

Example: abcdefg

Available from: 18.02 (8.4.38.33222)
ProfileId string false

ProfileId for which picklist will be created.

Type: smallint

Default value: NULL

Example: 123

Available from: 18.02 (8.4.38.33222)
LocationId string false

Location on which picklist will be created.

Type: varchar(3)

Default value: 001

Example: 002

Available from: 18.02 (8.4.38.33222)
OrderNrExternal string false

Create picklist for a specific external order number

Type: varchar(50)

Default value: NULL

Example: abcdefg

Available from: 21.09 (21.9.0.60964)
ExecuteAsynchronous boolean false

Create picklist in the background or wait till the picklist is created

Type: bit

Default value: 1

Example: 0 or 1

Available from: 18.02 (8.4.38.33222)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCreatePicklist>
      <ProfileId>string</ProfileId>
      <LocationId>string</LocationId>
      <OrderNr>0</OrderNr>
      <BinFrom>string</BinFrom>
      <BinTo>string</BinTo>
      <UserName>string</UserName>
      <Comment>string</Comment>
      <ExecuteAsynchronous>true</ExecuteAsynchronous>
      <OrderNrExternal>string</OrderNrExternal>
    </pixiCreatePicklist>
  </Body>
</Envelope>

Response

1. Status and Log output

Name Type Description
PLHKEY integer

Picklist Id

Type: int

Available from: 25.06 (25.6.0.58802)
PLexecLog string

Picklist Log

Type: varchar

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

Error description

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemsOnPicklist integer

Count of items on this Picklist

Type: int

Available from: 25.06 (25.6.0.58802)
PicklistKeyList string

CSV list of created Picklist(s)

Type: varchar

Available from: 25.06 (25.6.0.58802)
PLexecLogAdvanced string

Advanced (detailed) Picklist Log

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCreatePicklistPost200TextXmlResponse>
  <PLHKEY>0</PLHKEY>
  <PLexecLog>string</PLexecLog>
  <PLexecLogAdvanced>string</PLexecLogAdvanced>
  <ErrorMessage>string</ErrorMessage>
  <ItemsOnPicklist>0</ItemsOnPicklist>
  <PicklistKeyList>string</PicklistKeyList>
</PixiCreatePicklistPost200TextXmlResponse>

2. Status output

Name Type Description
Status string

Execution status (INFO/ERROR)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Message string

Description of the status

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCreatePicklistPost200TextXmlResponse>
  <PLHKEY>0</PLHKEY>
  <PLexecLog>string</PLexecLog>
  <PLexecLogAdvanced>string</PLexecLogAdvanced>
  <ErrorMessage>string</ErrorMessage>
  <ItemsOnPicklist>0</ItemsOnPicklist>
  <PicklistKeyList>string</PicklistKeyList>
</PixiCreatePicklistPost200TextXmlResponse>

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:pixiCreatePicklist>
            <BinTo xsi:type="xsd:string">A-00-99</BinTo>
            <BinFrom xsi:type="xsd:string">A-00-01</BinFrom>
            <Comment xsi:type="xsd:string">abcdefg</Comment>
            <OrderNr xsi:type="xsd:integer">123</OrderNr>
            <UserName xsi:type="xsd:string">abcdefg</UserName>
            <ProfileId xsi:type="xsd:string">123</ProfileId>
            <LocationId xsi:type="xsd:string">002</LocationId>
            <OrderNrExternal xsi:type="xsd:string">abcdefg</OrderNrExternal>
            <ExecuteAsynchronous xsi:type="xsd:boolean">0 or 1</ExecuteAsynchronous>
        </ns1:pixiCreatePicklist>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCreatePicklist', [
    'BinTo' => 'A-00-99', // string
    'BinFrom' => 'A-00-01', // string
    'Comment' => 'abcdefg', // string
    'OrderNr' => '123', // integer
    'UserName' => 'abcdefg', // string
    'ProfileId' => '123', // string
    'LocationId' => '002', // string
    'OrderNrExternal' => 'abcdefg', // string
    'ExecuteAsynchronous' => '0 or 1', // boolean
]);

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