Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetOrdersReadyForPickup

Pixi-Docs
Old Pixi-Docs

Deprecated

Procedure returns orders ready to pick up by customers on POS locations.

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
LocationId string false

Location Id

Type: varchar(50)

Default value: NULL

Example: 001

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrdersReadyForPickup>
      <LocationId>string</LocationId>
    </pixiGetOrdersReadyForPickup>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
CustRef integer

pixi* Customer reference number whos order is ready for pickup

Type: int

Available from: 25.06 (25.6.0.58802)
ordernr integer

pixi* order Nr. that is ready for pickup by customer on POS location

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetOrdersReadyForPickupPost200TextXmlResponse>
  <ordernr>0</ordernr>
  <CustRef>0</CustRef>
</PixiGetOrdersReadyForPickupPost200TextXmlResponse>

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:pixiGetOrdersReadyForPickup>
            <LocationId xsi:type="xsd:string">001</LocationId>
        </ns1:pixiGetOrdersReadyForPickup>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrdersReadyForPickup', [
    'LocationId' => '001', // 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);
}