Unofficial Pixi-API-Documentation

by koempf24.de

pixiUpdateInvoicePackageTrackingIds

Pixi-Docs
Old Pixi-Docs

Update existing (return) tracking IDs for package on an invoice specified by InvoiceNr or PackageId

Since pixi version: 21.06 (21.6.0.58890) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
InvoiceNr string false

Invoice number

Type: varchar(20)

Default value:

Example: INV0001

Available from: 21.06 (21.6.0.58890)
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: 21.07 (21.7.0.59709)
PackageId integer false

Reference for InvoicePackage table

Type: int

Default value:

Example: 0 or 1

Available from: 21.06 (21.6.0.58890)
TrackingId string false

Tracking IDs for the invoice, separated by ;

Type: varchar(512)

Default value:

Example: 123;124;124

Available from: 21.06 (21.6.0.58890)
ReturnTrackingId string false

ReturnTracking IDs for the invoice, separated by ;

Type: varchar(512)

Default value:

Example: 123;124;124

Available from: 21.06 (21.6.0.58890)
ResetClientNotifiedFlag boolean false

Reset ClientNotified flag back to: "N"

Type: bit

Default value: 0

Example: 0 or 1

Available from: 21.07 (21.7.0.59709)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiUpdateInvoicePackageTrackingIds>
      <PackageId>0</PackageId>
      <InvoiceNr>string</InvoiceNr>
      <TrackingId>string</TrackingId>
      <ReturnTrackingId>string</ReturnTrackingId>
      <Overwrite>true</Overwrite>
      <ResetClientNotifiedFlag>true</ResetClientNotifiedFlag>
    </pixiUpdateInvoicePackageTrackingIds>
  </Body>
</Envelope>

Response

1. Return status

Name Type Description
Status string

Result code of the operation: 200 = Success, 4** = Logical errors (check Message for details)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Message string

Detail description of the return status

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiUpdateInvoicePackageTrackingIdsPost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiUpdateInvoicePackageTrackingIdsPost200TextXmlResponse>

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:pixiUpdateInvoicePackageTrackingIds>
            <InvoiceNr xsi:type="xsd:string">INV0001</InvoiceNr>
            <Overwrite xsi:type="xsd:boolean">0 or 1</Overwrite>
            <PackageId xsi:type="xsd:integer">0 or 1</PackageId>
            <TrackingId xsi:type="xsd:string">123;124;124</TrackingId>
            <ReturnTrackingId xsi:type="xsd:string">123;124;124</ReturnTrackingId>
            <ResetClientNotifiedFlag xsi:type="xsd:boolean">0 or 1</ResetClientNotifiedFlag>
        </ns1:pixiUpdateInvoicePackageTrackingIds>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiUpdateInvoicePackageTrackingIds', [
    'InvoiceNr' => 'INV0001', // string
    'Overwrite' => '0 or 1', // boolean
    'PackageId' => '0 or 1', // integer
    'TrackingId' => '123;124;124', // string
    'ReturnTrackingId' => '123;124;124', // string
    '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);
}