Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetInvoicePackageLines

Pixi-Docs
Old Pixi-Docs

API call returns invoice package lines based on provided filter parameters.

Since pixi version: 22.08 (22.8.0.29958) Additional notes:

General

Request

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

Request body

Name Type Required Description
InvoiceId integer false

Filter: Invoice Id

Type: int

Default value: NULL

Example: 123

Available from: 22.08 (22.8.0.29958)
PackageId integer false

Filter: Package Id

Type: int

Default value: NULL

Example: 123

Available from: 22.08 (22.8.0.29958)
InvoiceNumber string false

Filter: Invoice number

Type: varchar(20)

Default value: NULL

Example: abcdefg

Available from: 22.08 (22.8.0.29958)

Request Example

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

Response

1. Returned package lines

Name Type Description
ItemKey integer

Item ID

Type: int

Available from: 25.06 (25.6.0.58802)
Quantity integer

Item quantity

Type: int

Available from: 25.06 (25.6.0.58802)
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)
ItemNrInt string

Item shop 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)
InvlineKey integer

Invoice line ID

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetInvoicePackageLinesPost200TextXmlResponse>
  <PackageId>0</PackageId>
  <InvoiceId>0</InvoiceId>
  <InvoiceNr>string</InvoiceNr>
  <ItemKey>0</ItemKey>
  <ItemNrInt>string</ItemNrInt>
  <InvlineKey>0</InvlineKey>
  <Quantity>0</Quantity>
</PixiGetInvoicePackageLinesPost200TextXmlResponse>

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

<PixiGetInvoicePackageLinesPost200TextXmlResponse>
  <PackageId>0</PackageId>
  <InvoiceId>0</InvoiceId>
  <InvoiceNr>string</InvoiceNr>
  <ItemKey>0</ItemKey>
  <ItemNrInt>string</ItemNrInt>
  <InvlineKey>0</InvlineKey>
  <Quantity>0</Quantity>
</PixiGetInvoicePackageLinesPost200TextXmlResponse>

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

PHP Example

<?php

getPixiSoapClientResponse('pixiGetInvoicePackageLines', [
    '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);
}