Unofficial Pixi-API-Documentation

by koempf24.de

pixiDFSetStatus

Pixi-Docs
Old Pixi-Docs

You can change the Status of Fullfilment orders

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

        <SETDFSTATUS>
        <ITEM>
        	<ORDERHISTORYKEY>432046</ORDERHISTORYKEY>
        	<STATUS>FUS</STATUS>
        	<QTY>1</QTY>
        	<SHIPDATE>20100114 23:40:12</SHIPDATE>
        	<TRACKINGID>233242345345</TRACKINGID>
        	<INVOICENREXTERNAL>RE234234</INVOICENREXTERNAL>
        	<BESTBEFOREDATE>03-13-2023</BESTBEFOREDATE>
        	<BATCHNUMBER>BN0113</BATCHNUMBER>
        	<SERIALNUMBER>SN-11223344</SERIALNUMBER>
        </ITEM>	
        <ITEM>
        	<ORDERHISTORYKEY>432051</ORDERHISTORYKEY>
        	<STATUS>FUS</STATUS>
        	<QTY>1</QTY>
        	<SHIPDATE>01-01-2010 11:11:11</SHIPDATE>
        	<TRACKINGID>233242345345</TRACKINGID>
        	<INVOICENREXTERNAL>RE234234</INVOICENREXTERNAL>
        	<BESTBEFOREDATE>09-22-2023</BESTBEFOREDATE>
        	<BATCHNUMBER>BN0333</BATCHNUMBER> 
        </ITEM>	
        <ITEM>
        	<ORDERHISTORYKEY>432052</ORDERHISTORYKEY>
        	<STATUS>STO</STATUS>
        	<QTY>1</QTY>
        	<SHIPDATE>01-13-2010</SHIPDATE>
        	<TRACKINGID>233242345345</TRACKINGID>
        	<INVOICENREXTERNAL>RE234234</INVOICENREXTERNAL>
        	<SERIALNUMBER>SN-55667788</SERIALNUMBER>
        </ITEM>	
        </SETDFSTATUS>
    
    *ORDERHISTORYKEY* = Unique orderline ID; can be retrieved from API calls pixiDFGetOrderlines or pixiDFGetChanges
    *QTY* = Orderline quantity for the status change
    *STATUS* = New status for the orderline
    *SHIPDATE* = Set the ship date for the orderline (DF Ship Date)
    *TRACKINGID* = DF Shipment TrackingID
    *INVOICENREXTERNAL* = Orderlines invoice number
    *BATCHNUMBER* = Set batch number for items tagged with Batch Number
    *BESTBEFOREDATE* = Set best before date for items tagged with Best Before Date
    *SERIALNUMBER* = Set item serial number
    
    **Info**: Depending on where you execute the call, the XML might need to be put into a `<![CDATA[...]]>` block.
Direct-Fulfillment

Request

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

Request body

Name Type Required Description
XML string true

Place XML here. Samples you find in additional notes

Type: varchar(-1)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
Secret string false

Customer number of Supplier

Type: varchar(20)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
SupplNr string false

Short name of Supplier

Type: varchar(4)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
CreateInvoices string false

If invoice should be created use "Y" otherwise "N"

Type: varchar(1)

Default value: N

Example: A

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiDFSetStatus>
      <XML>string</XML>
      <CreateInvoices>string</CreateInvoices>
      <SupplNr>string</SupplNr>
      <Secret>string</Secret>
    </pixiDFSetStatus>
  </Body>
</Envelope>

Response

Name Type Description
Error integer

Error code

Type: int

Available from: 25.06 (25.6.0.58802)
ErrorMsg string

Error Message

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiDFSetStatusPost200TextXmlResponse>
  <Error>0</Error>
  <ErrorMsg>string</ErrorMsg>
</PixiDFSetStatusPost200TextXmlResponse>

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:pixiDFSetStatus>
            <XML xsi:type="xsd:string">abcdefg</XML> <!-- required -->
            <Secret xsi:type="xsd:string">abcdefg</Secret>
            <SupplNr xsi:type="xsd:string">abcdefg</SupplNr>
            <CreateInvoices xsi:type="xsd:string">A</CreateInvoices>
        </ns1:pixiDFSetStatus>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiDFSetStatus', [
    'XML' => 'abcdefg', // string (required)
    'Secret' => 'abcdefg', // string
    'SupplNr' => 'abcdefg', // string
    'CreateInvoices' => 'A', // 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);
}