Unofficial Pixi-API-Documentation

by koempf24.de

pixiReadDeliveryItems

Pixi-Docs
Old Pixi-Docs

API call returns goods recived line records

Since pixi version: 21.01 (9.0.23.54983) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
RowCount integer false

Maximum number of records returned

Type: int

Default value: 1000

Example: 123

Available from: 21.01 (9.0.23.54983)
SDelDkey integer false

Delivery line id. If @RowCount is NULL then it returns only this row, otherwise next @RowCount records.

Type: int

Default value: NULL

Example: 123

Available from: 21.01 (9.0.23.54983)
CreateDateTo string false

Create Date to (excluding)

Type: datetime

Default value: NULL

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

Available from: 21.01 (9.0.23.54983)
UpdateDateTo string false

Update Date To (excluding)

Type: datetime

Default value: NULL

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

Available from: 21.01 (9.0.23.54983)
CreateDateFrom string false

Create Date from (including)

Type: datetime

Default value: NULL

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

Available from: 21.01 (9.0.23.54983)
UpdateDateFrom string false

Update Date from (including)

Type: datetime

Default value: NULL

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

Available from: 21.01 (9.0.23.54983)
CreateAndUpdateDateTo string false

Create or Update Date to (excluding)

Type: datetime

Default value: NULL

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

Available from: 21.01 (9.0.23.54983)
CreateAndUpdateDateFrom string false

Create or Update Date from (including)

Type: datetime

Default value: NULL

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

Available from: 21.01 (9.0.23.54983)

Request Example

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

Response

1. Delivery item information

Name Type Description
SDelDkey integer

Delivery detail ID

Type: int

Available from: / (25.7.0.59144)
SDelDHref integer

Delivery header ID

Type: int

Available from: / (25.7.0.59144)
BatchNumber string

Item batch number

Type: varchar (50)

Available from: / (25.7.0.59144)
SDelDsPrice number

Delivery item price

Type: money

Available from: / (25.7.0.59144)
SDelDItemRef integer

Item ID

Type: int

Available from: / (25.7.0.59144)
SDelDItemName string

Item name

Type: varchar (200)

Available from: / (25.7.0.59144)
BestBeforeDate string

Item best before date

Type: datetime

Available from: / (25.7.0.59144)
SDelDcreateEmp string

Create employee of the record

Type: varchar (50)

Available from: / (25.7.0.59144)
SDelDsDiscount number

Delivery item discount

Type: money

Available from: / (25.7.0.59144)
SDelDsMidPrice number

Delivery item discounted price

Type: money

Available from: / (25.7.0.59144)
SDelDupdateEmp string

Update employee of the record

Type: varchar (50)

Available from: / (25.7.0.59144)
SDelDcreateDate string

Create date of the record

Type: datetime

Available from: / (25.7.0.59144)
SDelDqtyOrdered number

Ordered item quantity

Type: money

Available from: / (25.7.0.59144)
SDelDupdateDate string

Update date of the record

Type: datetime

Available from: / (25.7.0.59144)
SDelDsFinalPrice number

Delivery final item price

Type: money

Available from: / (25.7.0.59144)
SDelDqtyDelivered number

Delivered item quantity

Type: money

Available from: / (25.7.0.59144)
SDelDsAddDiscount number

Delivery item additional discount

Type: money

Available from: / (25.7.0.59144)
SDelDsorderlineRef integer

Purchase orderline reference

Type: int

Available from: / (25.7.0.59144)

Response Example

<PixiReadDeliveryItemsPost200TextXmlResponse>
  <SDelDkey>0</SDelDkey>
  <SDelDHref>0</SDelDHref>
  <SDelDItemRef>0</SDelDItemRef>
  <SDelDItemName>string</SDelDItemName>
  <SDelDqtyDelivered>0</SDelDqtyDelivered>
  <SDelDqtyOrdered>0</SDelDqtyOrdered>
  <SDelDsorderlineRef>0</SDelDsorderlineRef>
  <SDelDsPrice>0</SDelDsPrice>
  <SDelDsDiscount>0</SDelDsDiscount>
  <SDelDsFinalPrice>0</SDelDsFinalPrice>
  <SDelDcreateDate>string</SDelDcreateDate>
  <SDelDcreateEmp>string</SDelDcreateEmp>
  <SDelDupdateDate>string</SDelDupdateDate>
  <SDelDupdateEmp>string</SDelDupdateEmp>
  <SDelDsAddDiscount>0</SDelDsAddDiscount>
  <SDelDsMidPrice>0</SDelDsMidPrice>
  <BatchNumber>string</BatchNumber>
  <BestBeforeDate>string</BestBeforeDate>
</PixiReadDeliveryItemsPost200TextXmlResponse>

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:pixiReadDeliveryItems>
            <RowCount xsi:type="xsd:integer">123</RowCount>
            <SDelDkey xsi:type="xsd:integer">123</SDelDkey>
            <CreateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</CreateDateTo>
            <UpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateTo>
            <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:pixiReadDeliveryItems>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadDeliveryItems', [
    'RowCount' => '123', // integer
    'SDelDkey' => '123', // integer
    'CreateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    'UpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
    '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);
}