Unofficial Pixi-API-Documentation

by koempf24.de

pixiReadDeliveryHeaders

Pixi-Docs
Old Pixi-Docs

API call returns goods recived header records

Since pixi version: 21.01 (9.0.23.54983) Additional notes:

Orderlines Orders

Request

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

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)
SDelHKey integer false

Delivery header 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="">
    <pixiReadDeliveryHeaders>
      <SDelHKey>0</SDelHKey>
      <CreateDateFrom>string</CreateDateFrom>
      <CreateDateTo>string</CreateDateTo>
      <UpdateDateFrom>string</UpdateDateFrom>
      <UpdateDateTo>string</UpdateDateTo>
      <CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
      <CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
      <RowCount>0</RowCount>
    </pixiReadDeliveryHeaders>
  </Body>
</Envelope>

Response

1. Delivery header information

Name Type Description
SDelHNr integer

Delivery Number

Type: int

Available from: / (25.7.0.59144)
SDelHKey integer

Delivery header ID

Type: int

Available from: / (25.7.0.59144)
PiccoUser string

Mobile user working on delivery

Type: varchar (59)

Available from: / (25.7.0.59144)
SDelHDate string

Delivery Date

Type: datetime

Available from: / (25.7.0.59144)
SDelHNote string

Delivery Comment

Type: varchar (8000)

Available from: / (25.7.0.59144)
SDelHStatus string

Status of Delivery

Type: varchar (3)

Available from: / (25.7.0.59144)
WasReopened boolean

Flag indicating that delivery was reopened

Type: bit

Available from: / (25.7.0.59144)
SDelHSupplNr string

Supplier Number of delivery

Type: varchar (4)

Available from: / (25.7.0.59144)
LockedByPicco string

Delivery is locked by mobile user

Type: varchar (1)

Available from: / (25.7.0.59144)
SDelHCreateEmp string

User that created the Delivery

Type: varchar (50)

Available from: / (25.7.0.59144)
SDelHUpdateEmp string

User that last updated the Delivery

Type: varchar (50)

Available from: / (25.7.0.59144)
SDelHCreateDate string

Create Date of the Delivery

Type: datetime

Available from: / (25.7.0.59144)
SDelHLocationID string

Delivery Location ID

Type: varchar (3)

Available from: / (25.7.0.59144)
SDelHUpdateDate string

Update Date of the Delivery

Type: datetime

Available from: / (25.7.0.59144)
SDelHextOrderNr string

Order Number from Supplier

Type: varchar (1000)

Available from: / (25.7.0.59144)
SDelHextInvoiceNr string

Invoice Number from Supplier

Type: varchar (25)

Available from: / (25.7.0.59144)
SDelHfinalDicsount number

Delivery final discount

Type: money

Available from: / (25.7.0.59144)

Response Example

<PixiReadDeliveryHeadersPost200TextXmlResponse>
  <SDelHKey>0</SDelHKey>
  <SDelHDate>string</SDelHDate>
  <SDelHLocationID>string</SDelHLocationID>
  <SDelHSupplNr>string</SDelHSupplNr>
  <SDelHNr>0</SDelHNr>
  <SDelHNote>string</SDelHNote>
  <SDelHStatus>string</SDelHStatus>
  <SDelHCreateDate>string</SDelHCreateDate>
  <SDelHCreateEmp>string</SDelHCreateEmp>
  <SDelHUpdateDate>string</SDelHUpdateDate>
  <SDelHUpdateEmp>string</SDelHUpdateEmp>
  <SDelHextInvoiceNr>string</SDelHextInvoiceNr>
  <SDelHextOrderNr>string</SDelHextOrderNr>
  <SDelHfinalDicsount>0</SDelHfinalDicsount>
  <PiccoUser>string</PiccoUser>
  <LockedByPicco>string</LockedByPicco>
  <WasReopened>true</WasReopened>
</PixiReadDeliveryHeadersPost200TextXmlResponse>

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:pixiReadDeliveryHeaders>
            <RowCount xsi:type="xsd:integer">123</RowCount>
            <SDelHKey xsi:type="xsd:integer">123</SDelHKey>
            <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:pixiReadDeliveryHeaders>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadDeliveryHeaders', [
    'RowCount' => '123', // integer
    'SDelHKey' => '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);
}