Unofficial Pixi-API-Documentation

by koempf24.de

pixiPutIntoBox

Pixi-Docs
Old Pixi-Docs

Shipping scan in of item into box or directly for invoice in case of 1SS functionality

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: The API call can only be used when "Premium API" setting is enabled.

Shipping

Request

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

Request body

Name Type Required Description
ToBox integer true

Define box range (to box)

Type: int

Default value:

Example: 123

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

Bin place ID

Type: int

Default value: 0

Example: 123

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

Define box range (from box)

Type: int

Default value:

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
SerialNr string true

Serial number of the item on the orderline

Type: varchar(200)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)
Username string true

User name

Type: varchar(50)

Default value:

Example: abcdefg

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

Picklist number

Type: int

Default value: 0

Example: 123

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

Quantity for scan to box

Type: int

Default value: 0

Example: 123

Available from: 21.10 (21.10.0.61843)
SupplGroup string true

Supplier group

Type: varchar(5)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)
BatchNumber string false

Search by Batch number

Type: varchar(50)

Default value: NULL

Example: asdf1234

Available from: 21.10 (21.10.0.61843)
OrderlineKey integer true

Orderline ID

Type: int

Default value:

Example: 123

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

Supplier order number

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
BestBeforeDate string false

Search by Best Before Date - From

Type: datetime

Default value: NULL

Example: YYYY-MM-DD hh:mm:ss

Available from: 21.10 (21.10.0.61843)
IsPersonalizedScanIn boolean false

Indicate if scanning in a personalized item

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiPutIntoBox>
      <OrderlineKey>0</OrderlineKey>
      <SupplGroup>string</SupplGroup>
      <Username>string</Username>
      <SupplOrderNr>0</SupplOrderNr>
      <FromBox>0</FromBox>
      <ToBox>0</ToBox>
      <SerialNr>string</SerialNr>
      <PickListNr>0</PickListNr>
      <IsPersonalizedScanIn>true</IsPersonalizedScanIn>
      <BinRef>0</BinRef>
      <BatchNumber>string</BatchNumber>
      <BestBeforeDate>string</BestBeforeDate>
      <ScannedQty>0</ScannedQty>
    </pixiPutIntoBox>
  </Body>
</Envelope>

Response

1. Status output

Name Type Description
BoxNr integer

Box number where the item should be put

Type: int

Available from: 25.06 (25.6.0.58802)
Action string

Execution status/action

Type: varchar

Available from: 25.06 (25.6.0.58802)
BoxKey integer

Box Id where the item should be put

Type: int

Available from: 25.06 (25.6.0.58802)
BoxColor integer

Box color - for display in pixi UI.

Type: int

Available from: 25.06 (25.6.0.58802)
DESCRIPTION string

Description of the status/actioin

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiPutIntoBoxPost200TextXmlResponse>
  <BoxKey>0</BoxKey>
  <BoxNr>0</BoxNr>
  <BoxColor>0</BoxColor>
  <Action>string</Action>
  <DESCRIPTION>string</DESCRIPTION>
</PixiPutIntoBoxPost200TextXmlResponse>

2. Status output

Name Type Description
Status string

Execution status (OK/ERROR)

Type: varchar

Available from: 25.06 (25.6.0.58802)
StatusMessage string

Description of the status

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiPutIntoBoxPost200TextXmlResponse>
  <BoxKey>0</BoxKey>
  <BoxNr>0</BoxNr>
  <BoxColor>0</BoxColor>
  <Action>string</Action>
  <DESCRIPTION>string</DESCRIPTION>
</PixiPutIntoBoxPost200TextXmlResponse>

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:pixiPutIntoBox>
            <ToBox xsi:type="xsd:integer">123</ToBox> <!-- required -->
            <BinRef xsi:type="xsd:integer">123</BinRef>
            <FromBox xsi:type="xsd:integer">123</FromBox> <!-- required -->
            <SerialNr xsi:type="xsd:string">abcdefg</SerialNr> <!-- required -->
            <Username xsi:type="xsd:string">abcdefg</Username> <!-- required -->
            <PickListNr xsi:type="xsd:integer">123</PickListNr>
            <ScannedQty xsi:type="xsd:integer">123</ScannedQty>
            <SupplGroup xsi:type="xsd:string">abcdefg</SupplGroup> <!-- required -->
            <BatchNumber xsi:type="xsd:string">asdf1234</BatchNumber>
            <OrderlineKey xsi:type="xsd:integer">123</OrderlineKey> <!-- required -->
            <SupplOrderNr xsi:type="xsd:integer">123</SupplOrderNr>
            <BestBeforeDate xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</BestBeforeDate>
            <IsPersonalizedScanIn xsi:type="xsd:boolean">0 or 1</IsPersonalizedScanIn>
        </ns1:pixiPutIntoBox>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiPutIntoBox', [
    'ToBox' => '123', // integer (required)
    'BinRef' => '123', // integer
    'FromBox' => '123', // integer (required)
    'SerialNr' => 'abcdefg', // string (required)
    'Username' => 'abcdefg', // string (required)
    'PickListNr' => '123', // integer
    'ScannedQty' => '123', // integer
    'SupplGroup' => 'abcdefg', // string (required)
    'BatchNumber' => 'asdf1234', // string
    'OrderlineKey' => '123', // integer (required)
    'SupplOrderNr' => '123', // integer
    'BestBeforeDate' => 'YYYY-MM-DD hh:mm:ss', // string
    'IsPersonalizedScanIn' => '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);
}