Unofficial Pixi-API-Documentation

by koempf24.de

pixiInvoiceSetTrackingID

Pixi-Docs
Old Pixi-Docs

Sets tracking ID on an invoice specified by InvoiceNr

Since pixi version: LOU Official (6.3.0.4452) Additional notes: This API call is deprecated, we recommend to use these two calls instead - pixiGetInvoicePackage - pixiUpdateInvoicePackage

General

Request

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

Request body

Name Type Required Description
InvoiceNR string true

InvoiceNr of the invoice you are setting tracking ID for. The way this procedure is typically used, InvoiceNr may come in embellished with an optional suffix, like invoice INV000001 may be specified as INV000001-1 or INV000001-2 This procedure looks for the first existing invoice by removing the suffixes one by one. I.e. in case of the example above, it will first look for invoice with Nr. INV000001-1, if not found, then INV000001. If the number is not found at all, the "non existing" message is returne

Type: varchar(20)

Default value:

Example: INV0001

Available from: LOU Official (6.3.0.4452)
Overwrite boolean false

Delete existing tracking IDs for package and set the new ones

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official (6.3.0.4452)
Separator string false

Delimiter used for splitting Tracking IDs

Type: varchar(1)

Default value: ;

Example: ;

Available from: AVA Official - Update 7 (8.4.7.23158)
TrackingID string true

Tracking IDs for the invoice

Type: varchar(8000)

Default value:

Example: 123;124;124;

Available from: LOU Official (6.3.0.4452)
ResetClientNotifiedFlag boolean false

Reset ClientNotified flag back to: "N"

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiInvoiceSetTrackingID>
      <InvoiceNR>string</InvoiceNR>
      <TrackingID>string</TrackingID>
      <Overwrite>true</Overwrite>
      <ResetClientNotifiedFlag>true</ResetClientNotifiedFlag>
      <Separator>string</Separator>
    </pixiInvoiceSetTrackingID>
  </Body>
</Envelope>

Response

1. Return status

Name Type Description
ReturnMessage string

Return message

Type: varchar

Available from: / (25.7.0.59144)

Response Example

<PixiInvoiceSetTrackingIDPost200TextXmlResponse>
  <ReturnMessage>string</ReturnMessage>
</PixiInvoiceSetTrackingIDPost200TextXmlResponse>

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:pixiInvoiceSetTrackingID>
            <InvoiceNR xsi:type="xsd:string">INV0001</InvoiceNR> <!-- required -->
            <Overwrite xsi:type="xsd:boolean">0 or 1</Overwrite>
            <Separator xsi:type="xsd:string">;</Separator>
            <TrackingID xsi:type="xsd:string">123;124;124;</TrackingID> <!-- required -->
            <ResetClientNotifiedFlag xsi:type="xsd:boolean">0 or 1</ResetClientNotifiedFlag>
        </ns1:pixiInvoiceSetTrackingID>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiInvoiceSetTrackingID', [
    'InvoiceNR' => 'INV0001', // string (required)
    'Overwrite' => '0 or 1', // boolean
    'Separator' => ';', // string
    'TrackingID' => '123;124;124;', // string (required)
    'ResetClientNotifiedFlag' => '0 or 1', // boolean
]);

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