Unofficial Pixi-API-Documentation

by koempf24.de

pixiDFGetChangesConfirmation

Pixi-Docs
Old Pixi-Docs

Call sets the "ClientNotified" flag

Since pixi version: LOU Official (6.3.0.4452) Additional notes: NOTE: When setting "DFAPIAllowFullAccessWithoutSecret" is set to 1 in Control center the values for @SupplNr and @Secret do not need to be valid but still need to be send.

    Sample parameter values when setting "DFAPIAllowFullAccessWithoutSecret" = 1 would be: @SupplNr = "foo", @Secret = "bar"
Direct-Fulfillment

Request

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

Request body

Name Type Required Description
Secret string true

This is the CustomerNr set in the Supplier table in web pixi (Suppliers section under purchasing). Can be "bar" but this has to be enabled in Control Center.

Type: varchar(20)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
SupplNr string true

SupplNr of the items, that should be retrieved. You can also submit "foo" to get all items, but this has to be enabled in Control Center beforehand.

Type: varchar(4)

Default value:

Example: MGS

Available from: LOU Official (6.3.0.4452)
InvoiceKey integer false

Invoice record ID. Used to update "TrackingIDSent" timestamp.

Type: int

Default value: 0

Example: 123

Available from: LOU Official (6.3.0.4452)
OrderHistKey integer true

OrderHistory record ID that you want to set the"ClientNotified" flag for.

Type: int

Default value:

Example: 123

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiDFGetChangesConfirmation>
      <SupplNr>string</SupplNr>
      <Secret>string</Secret>
      <OrderHistKey>0</OrderHistKey>
      <InvoiceKey>0</InvoiceKey>
    </pixiDFGetChangesConfirmation>
  </Body>
</Envelope>

Response

1. Error set

Name Type Description
Status string

HTML error/success code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
ErrorMsg string

Error/Success message

Type: varchar (9)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiDFGetChangesConfirmationPost200TextXmlResponse>
  <Status>string</Status>
  <ErrorMsg>string</ErrorMsg>
</PixiDFGetChangesConfirmationPost200TextXmlResponse>

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:pixiDFGetChangesConfirmation>
            <Secret xsi:type="xsd:string">abcdefg</Secret> <!-- required -->
            <SupplNr xsi:type="xsd:string">MGS</SupplNr> <!-- required -->
            <InvoiceKey xsi:type="xsd:integer">123</InvoiceKey>
            <OrderHistKey xsi:type="xsd:integer">123</OrderHistKey> <!-- required -->
        </ns1:pixiDFGetChangesConfirmation>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiDFGetChangesConfirmation', [
    'Secret' => 'abcdefg', // string (required)
    'SupplNr' => 'MGS', // string (required)
    'InvoiceKey' => '123', // integer
    'OrderHistKey' => '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);
}