Unofficial Pixi-API-Documentation

by koempf24.de

pixiReadItemBinLog

Pixi-Docs
Old Pixi-Docs

API Call to retrieve all item movements

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Raw-Read

Request

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

Request body

Name Type Required Description
RowCount integer false

Number of returned rows

Type: int

Default value: 1000

Example: 123

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

Create Date to (excluding)

Type: datetime

Default value: NULL

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

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

Update Date To (excluding)

Type: datetime

Default value: NULL

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

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

InvBinItemLog Id

Type: int

Default value: NULL

Example: 123

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

Create Date from (including)

Type: datetime

Default value: NULL

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

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

Update Date from (including)

Type: datetime

Default value: NULL

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

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

Create or Update Date to (excluding)

Type: datetime

Default value: NULL

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

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

Create or Update Date from (including)

Type: datetime

Default value: NULL

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

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReadItemBinLog>
      <ItemBinLogKey>0</ItemBinLogKey>
      <CreateDateFrom>string</CreateDateFrom>
      <CreateDateTo>string</CreateDateTo>
      <UpdateDateFrom>string</UpdateDateFrom>
      <UpdateDateTo>string</UpdateDateTo>
      <CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
      <CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
      <RowCount>0</RowCount>
    </pixiReadItemBinLog>
  </Body>
</Envelope>

Response

1. Bin item information

Name Type Description
Qty integer

Item quantity

Type: int

Available from: 25.06 (25.6.0.58802)
LocID string

Location code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
BinRef integer

Bin ID

Type: int

Available from: 25.06 (25.6.0.58802)
Reason string

Stock movement reason

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)
SMORef integer

Stock movement operation Id

Type: int

Available from: 25.06 (25.6.0.58802)
SMTRef integer

Stock movement type Id

Type: int

Available from: 25.06 (25.6.0.58802)
IBILkey integer

InvbinItemLog Id

Type: int

Available from: 25.06 (25.6.0.58802)
ItemRef integer

Item ID

Type: int

Available from: 25.06 (25.6.0.58802)
UpdateEmp string

User who last updated the record

Type: varchar (100)

Available from: 25.06 (25.6.0.58802)
DeliveryId integer

Delivery Id

Type: int

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)
ForOrderline integer

Connected orderline Id

Type: int

Available from: 25.06 (25.6.0.58802)
ReportedDate string

Type: datetime

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReadItemBinLogPost200TextXmlResponse>
  <IBILkey>0</IBILkey>
  <LocID>string</LocID>
  <BinRef>0</BinRef>
  <Qty>0</Qty>
  <ItemRef>0</ItemRef>
  <UpdateEmp>string</UpdateEmp>
  <UpdateDate>string</UpdateDate>
  <ReportedDate>string</ReportedDate>
  <ForOrderline>0</ForOrderline>
  <Reason>string</Reason>
  <SMORef>0</SMORef>
  <SMTRef>0</SMTRef>
  <DeliveryId>0</DeliveryId>
</PixiReadItemBinLogPost200TextXmlResponse>

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:pixiReadItemBinLog>
            <RowCount xsi:type="xsd:integer">123</RowCount>
            <CreateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateTo>
            <UpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateTo>
            <ItemBinLogKey xsi:type="xsd:integer">123</ItemBinLogKey>
            <CreateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateFrom>
            <UpdateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateFrom>
            <CreateAndUpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateAndUpdateDateTo>
            <CreateAndUpdateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateAndUpdateDateFrom>
        </ns1:pixiReadItemBinLog>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadItemBinLog', [
    'RowCount' => '123', // integer
    'CreateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'UpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'ItemBinLogKey' => '123', // integer
    'CreateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
    'UpdateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
    'CreateAndUpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'CreateAndUpdateDateFrom' => '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);
}