Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetOrdersByDeliveryDate

Pixi-Docs
Old Pixi-Docs

Get all orders with a specific delivery date set (orderheader.ShipDate). DeliveryDate is the date, an order gets prepared andput onto the picklist. If no Parameter is passed, it returns all Orders with DeliveryDate in the future. Only available for AVA up.

Since pixi version: AVA Official - Update 7 (8.4.7.23158) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
ShopID string false

Type: varchar(3)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
ShipVendor string false

Type: varchar(3)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
DeliveryDate string false

Type: datetime

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
DaysToDeliveryDate integer false

Type: int

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrdersByDeliveryDate>
      <DaysToDeliveryDate>0</DaysToDeliveryDate>
      <DeliveryDate>string</DeliveryDate>
      <ShipVendor>string</ShipVendor>
      <ShopID>string</ShopID>
    </pixiGetOrdersByDeliveryDate>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiGetOrdersByDeliveryDatePost200TextXmlResponse />

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:pixiGetOrdersByDeliveryDate>
            <ShopID xsi:type="xsd:string"></ShopID>
            <ShipVendor xsi:type="xsd:string"></ShipVendor>
            <DeliveryDate xsi:type="xsd:string"></DeliveryDate>
            <DaysToDeliveryDate xsi:type="xsd:integer"></DaysToDeliveryDate>
        </ns1:pixiGetOrdersByDeliveryDate>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrdersByDeliveryDate', [
    'ShopID' => '', // string
    'ShipVendor' => '', // string
    'DeliveryDate' => '', // string
    'DaysToDeliveryDate' => '', // integer
]);

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