Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetMatchesForDeliveredItem

Pixi-Docs
Old Pixi-Docs

API call returns the match between delivery document and supplier order for one item.

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

Suppliers

Request

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

Request body

Name Type Required Description
SDelDkey integer true

Delivery detail ID

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetMatchesForDeliveredItem>
      <SDelDkey>0</SDelDkey>
    </pixiGetMatchesForDeliveredItem>
  </Body>
</Envelope>

Response

1. Item match details

Name Type Description
OrderId integer

Purchase order ID

Type: int

Available from: / (25.7.0.59144)
OrderNr integer

Purchase order number

Type: int

Available from: / (25.7.0.59144)
OrderQty integer

Ordered item quantity

Type: int

Available from: / (25.7.0.59144)
OrderDate string

Purchase order date

Type: datetime

Available from: / (25.7.0.59144)
SupplName string

Supplier name

Type: varchar (60)

Available from: / (25.7.0.59144)
QtyReceived integer

Recived item quantity

Type: int

Available from: / (25.7.0.59144)
SOrderLineRef integer

Purchase orderline ID

Type: int

Available from: / (25.7.0.59144)
BuyingMatchQty integer

Matched item quantity

Type: int

Available from: / (25.7.0.59144)
QtyNotDelivered integer

Quantity of items that were not yet delivered

Type: int

Available from: / (25.7.0.59144)

Response Example

<PixiGetMatchesForDeliveredItemPost200TextXmlResponse>
  <OrderNr>0</OrderNr>
  <SOrderLineRef>0</SOrderLineRef>
  <SupplName>string</SupplName>
  <OrderDate>string</OrderDate>
  <OrderQty>0</OrderQty>
  <QtyReceived>0</QtyReceived>
  <QtyNotDelivered>0</QtyNotDelivered>
  <BuyingMatchQty>0</BuyingMatchQty>
  <OrderId>0</OrderId>
</PixiGetMatchesForDeliveredItemPost200TextXmlResponse>

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:pixiGetMatchesForDeliveredItem>
            <SDelDkey xsi:type="xsd:integer">123</SDelDkey> <!-- required -->
        </ns1:pixiGetMatchesForDeliveredItem>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetMatchesForDeliveredItem', [
    'SDelDkey' => '123', // integer (required)
]);

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