Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetInvoicePackage

Pixi-Docs
Old Pixi-Docs

API call returns invoice packages based on provided filter parameters.

Since pixi version: 19.03 (9.0.1.37798) Additional notes:

General

Request

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

Request body

Name Type Required Description
InvoiceId integer false

Filter: Invoice Id

Type: int

Default value: NULL

Example: 123

Available from: 19.03 (9.0.1.37798)
PackageId integer false

Filter: Package Id

Type: int

Default value: NULL

Example: 123

Available from: 19.03 (9.0.1.37798)
InvoiceNumber string false

Filter: Invoice number

Type: varchar(20)

Default value: NULL

Example: abcdefg

Available from: 19.03 (9.0.1.37798)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetInvoicePackage>
      <InvoiceNumber>string</InvoiceNumber>
      <InvoiceId>0</InvoiceId>
      <PackageId>0</PackageId>
    </pixiGetInvoicePackage>
  </Body>
</Envelope>

Response

1. Returned packages

Name Type Description
InvoiceId integer

Invoice Id

Type: int

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

pixi Invoice Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
PackageId integer

Package Id

Type: int

Available from: 25.06 (25.6.0.58802)
TrackingId string

Tracking ID of the shipment. Applies to the orders that have been shipped

Type: varchar

Available from: 25.06 (25.6.0.58802)
GrossWeight number

Weight of package

Type: money

Available from: 25.06 (25.6.0.58802)
ReturnLabelUrl string

Return label URL

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderNrExternal string

External order number

Type: varchar

Available from: 25.06 (25.6.0.58802)
ReturnTrackingId string

Return tracking Id

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShippingLabelUrl string

Shipping label URL

Type: varchar

Available from: 25.06 (25.6.0.58802)
TimesLabelPrinted string

Counter how many times label was printed

Type: tinyint

Available from: 25.06 (25.6.0.58802)
ExternalShipmentId string

External shipment Id

Type: varchar

Available from: 25.06 (25.6.0.58802)
PackageDimensionId integer

Package dimentions Id

Type: int

Available from: 25.06 (25.6.0.58802)
MessageFromProvider string

Message from label provider

Type: varchar

Available from: 25.06 (25.6.0.58802)
PackageDimensionCode string

Package dimension code

Type: nvarchar

Available from: 25.06 (25.6.0.58802)
MessageFromProviderDetail string

Detailed message from label provider

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetInvoicePackagePost200TextXmlResponse>
  <PackageId>0</PackageId>
  <InvoiceId>0</InvoiceId>
  <GrossWeight>0</GrossWeight>
  <ShippingLabelUrl>string</ShippingLabelUrl>
  <TrackingId>string</TrackingId>
  <TimesLabelPrinted>string</TimesLabelPrinted>
  <ReturnLabelUrl>string</ReturnLabelUrl>
  <ReturnTrackingId>string</ReturnTrackingId>
  <PackageDimensionId>0</PackageDimensionId>
  <ExternalShipmentId>string</ExternalShipmentId>
  <MessageFromProvider>string</MessageFromProvider>
  <MessageFromProviderDetail>string</MessageFromProviderDetail>
  <OrderNrExternal>string</OrderNrExternal>
  <InvoiceNr>string</InvoiceNr>
  <PackageDimensionCode>string</PackageDimensionCode>
</PixiGetInvoicePackagePost200TextXmlResponse>

2. Status output

Name Type Description
Status string

Execution status (Info/Error)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Message string

Description of the status

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetInvoicePackagePost200TextXmlResponse>
  <PackageId>0</PackageId>
  <InvoiceId>0</InvoiceId>
  <GrossWeight>0</GrossWeight>
  <ShippingLabelUrl>string</ShippingLabelUrl>
  <TrackingId>string</TrackingId>
  <TimesLabelPrinted>string</TimesLabelPrinted>
  <ReturnLabelUrl>string</ReturnLabelUrl>
  <ReturnTrackingId>string</ReturnTrackingId>
  <PackageDimensionId>0</PackageDimensionId>
  <ExternalShipmentId>string</ExternalShipmentId>
  <MessageFromProvider>string</MessageFromProvider>
  <MessageFromProviderDetail>string</MessageFromProviderDetail>
  <OrderNrExternal>string</OrderNrExternal>
  <InvoiceNr>string</InvoiceNr>
  <PackageDimensionCode>string</PackageDimensionCode>
</PixiGetInvoicePackagePost200TextXmlResponse>

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:pixiGetInvoicePackage>
            <InvoiceId xsi:type="xsd:integer">123</InvoiceId>
            <PackageId xsi:type="xsd:integer">123</PackageId>
            <InvoiceNumber xsi:type="xsd:string">abcdefg</InvoiceNumber>
        </ns1:pixiGetInvoicePackage>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetInvoicePackage', [
    'InvoiceId' => '123', // integer
    'PackageId' => '123', // integer
    'InvoiceNumber' => 'abcdefg', // 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);
}