Unofficial Pixi-API-Documentation

by koempf24.de

pixiDFSetSupplierNotifiedFlag

Pixi-Docs
Old Pixi-Docs

This API Call sets the notified flag for the supplier

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: Depending on the filter conditions:

    When Orderline Id is provided then the latest FUT status in the order history table will be updated.
    
    When Order number is provided then the latest FUT status in the order history table for every orderline will be updated.
Direct-Fulfillment

Request

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

Request body

Name Type Required Description
OrderNr integer false

Filter: pixi order number

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
IsNotified boolean false

Switch: Flag whether the supplier has been notified or not

Type: bit

Default value: 1

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderlineKey integer false

Filter: Orderline 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="">
    <pixiDFSetSupplierNotifiedFlag>
      <OrderlineKey>0</OrderlineKey>
      <OrderNr>0</OrderNr>
      <IsNotified>true</IsNotified>
    </pixiDFSetSupplierNotifiedFlag>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiDFSetSupplierNotifiedFlagPost200TextXmlResponse />

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:pixiDFSetSupplierNotifiedFlag>
            <OrderNr xsi:type="xsd:integer">123</OrderNr>
            <IsNotified xsi:type="xsd:boolean">0 or 1</IsNotified>
            <OrderlineKey xsi:type="xsd:integer">123</OrderlineKey>
        </ns1:pixiDFSetSupplierNotifiedFlag>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiDFSetSupplierNotifiedFlag', [
    'OrderNr' => '123', // integer
    'IsNotified' => '0 or 1', // boolean
    'OrderlineKey' => '123', // 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);
}