pixiSetInvoiceShippingInformation

Sets weight and number of packages

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Shipping

Request

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

Request body

Name	Type	Required	Description
Packages	integer	false	Number of packages Type: int Default value: NULL Example: 13 Available from: LOU Official - Update 46 (6.9.46.27927)
InvoiceNr	string	false	Invoice number Type: varchar(20) Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)
ShipVendor	string	false	Ship vendor code Type: varchar(3) Default value: NULL Example: DHL Available from: LOU Official - Update 46 (6.9.46.27927)
PackageNetWeight	string	false	Package weight (netto) Type: float Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)
PackageGrossWeight	string	false	Package weight (bruto) Type: float Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetInvoiceShippingInformation>
      <InvoiceNr>string</InvoiceNr>
      <PackageNetWeight>string</PackageNetWeight>
      <PackageGrossWeight>string</PackageGrossWeight>
      <Packages>0</Packages>
      <ShipVendor>string</ShipVendor>
    </pixiSetInvoiceShippingInformation>
  </Body>
</Envelope>

Response

1. Picklist data

Name	Type	Description
Status	integer	Status Code (200 means OK, 500 means that data could not be updated, 400 means that Invoice was not found in pixi) Type:* int Available from: 25.06 (25.6.0.58802)
Message	string	Status Message Type: varchar Available from: 25.06 (25.6.0.58802)
Packages	integer	Number of packages Type: int Available from: 25.06 (25.6.0.58802)
InvoiceNr	string	InvoiceNr that was updated Type: varchar Available from: 25.06 (25.6.0.58802)
ShipVendor	string	Ship Vendor for this invoice Type: varchar Available from: 25.06 (25.6.0.58802)
PackageNetWeight	number	Package net weight Type: decimal Available from: 25.06 (25.6.0.58802)
PackageGrossWeight	number	Package gross weight Type: decimal Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetInvoiceShippingInformationPost200TextXmlResponse>
  <Status>0</Status>
  <Message>string</Message>
  <InvoiceNr>string</InvoiceNr>
  <Packages>0</Packages>
  <PackageNetWeight>0</PackageNetWeight>
  <PackageGrossWeight>0</PackageGrossWeight>
  <ShipVendor>string</ShipVendor>
</PixiSetInvoiceShippingInformationPost200TextXmlResponse>

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:pixiSetInvoiceShippingInformation>
            <Packages xsi:type="xsd:integer">13</Packages>
            <InvoiceNr xsi:type="xsd:string">123</InvoiceNr>
            <ShipVendor xsi:type="xsd:string">DHL</ShipVendor>
            <PackageNetWeight xsi:type="xsd:string">123</PackageNetWeight>
            <PackageGrossWeight xsi:type="xsd:string">123</PackageGrossWeight>
        </ns1:pixiSetInvoiceShippingInformation>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetInvoiceShippingInformation', [
    'Packages' => '13', // integer
    'InvoiceNr' => '123', // string
    'ShipVendor' => 'DHL', // string
    'PackageNetWeight' => '123', // string
    'PackageGrossWeight' => '123', // 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);
}

Unofficial Pixi-API-Documentation

by koempf24.de