Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetRelocations

Pixi-Docs
Old Pixi-Docs

API call returns stock movements done when relocating the items

Since pixi version: AVA 17.10 (8.4.34.31829) Additional notes: NOTE: Keep in mind that only stock movements that were done with "Relocate" program will be displayed.

Orderlines Orders

Request

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

Request body

Name Type Required Description
Offset integer false

Pagination: record offset

Type: int

Default value: 0

Example: 123

Available from: AVA 17.10 (8.4.34.31829)
RowCount integer false

Pagination: maximum results per page

Type: int

Default value: 1000

Example: 123

Available from: AVA 17.10 (8.4.34.31829)
ToLocation string false

Filter: To location

Type: varchar(3)

Default value: NULL

Example: abc

Available from: AVA 17.10 (8.4.34.31829)
ChangeDateTo string false

Filter: End of time frame

Type: datetime

Default value: NULL

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

Available from: AVA 17.10 (8.4.34.31829)
FromLocation string false

Filter: From location

Type: varchar(3)

Default value: NULL

Example: abc

Available from: AVA 17.10 (8.4.34.31829)
ChangeDateFrom string false

Filter: Start of time frame

Type: datetime

Default value: NULL

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

Available from: AVA 17.10 (8.4.34.31829)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetRelocations>
      <FromLocation>string</FromLocation>
      <ToLocation>string</ToLocation>
      <ChangeDateFrom>string</ChangeDateFrom>
      <ChangeDateTo>string</ChangeDateTo>
      <Offset>0</Offset>
      <RowCount>0</RowCount>
    </pixiGetRelocations>
  </Body>
</Envelope>

Response

1. Stock movements (relocations)

Name Type Description
Qty integer

Quantity that was relocated

Type: int

Available from: 25.06 (25.6.0.58802)
EANUPC string

Item barcode

Type: varchar (13)

Available from: 25.06 (25.6.0.58802)
ItemKey integer

pixi* item ID

Type: int

Available from: 25.06 (25.6.0.58802)
ItemName string

Item name

Type: varchar (120)

Available from: 25.06 (25.6.0.58802)
RowNumber string

Row number ID. Used in combination with "Offset" parameter

Type: bigint

Available from: 25.06 (25.6.0.58802)
ToLocation string

Stock movement location (to)

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
UpdateDate string

Last update date of the record

Type: datetime

Available from: 25.06 (25.6.0.58802)
FromLocation string

Stock movement location (from)

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetRelocationsPost200TextXmlResponse>
  <RowNumber>string</RowNumber>
  <ItemKey>0</ItemKey>
  <UpdateDate>string</UpdateDate>
  <EANUPC>string</EANUPC>
  <ItemName>string</ItemName>
  <FromLocation>string</FromLocation>
  <ToLocation>string</ToLocation>
  <Qty>0</Qty>
</PixiGetRelocationsPost200TextXmlResponse>

2. Error result

Name Type Description
Status string

Execution status

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)
Message string

Execution status details

Type: varchar (80)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetRelocationsPost400TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiGetRelocationsPost400TextXmlResponse>

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:pixiGetRelocations>
            <Offset xsi:type="xsd:integer">123</Offset>
            <RowCount xsi:type="xsd:integer">123</RowCount>
            <ToLocation xsi:type="xsd:string">abc</ToLocation>
            <ChangeDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</ChangeDateTo>
            <FromLocation xsi:type="xsd:string">abc</FromLocation>
            <ChangeDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</ChangeDateFrom>
        </ns1:pixiGetRelocations>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetRelocations', [
    'Offset' => '123', // integer
    'RowCount' => '123', // integer
    'ToLocation' => 'abc', // string
    'ChangeDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'FromLocation' => 'abc', // string
    'ChangeDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
]);

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