Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetShippingVendors

Pixi-Docs
Old Pixi-Docs

API call returns shipping vendors

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

Shipping

Request

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

Request body

Name Type Required Description
Tracking string false

Ship vendor tracking flag

Type: varchar(1)

Default value:

Example: N or Y

Available from: LOU Official - Update 46 (6.9.46.27927)
ShipVendorKey integer false

Ship vendor ID

Type: int

Default value: 0

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
ShipVendorCode string false

Ship vendor code

Type: varchar(3)

Default value:

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)
ShipVendorName string false

Ship vendor name

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetShippingVendors>
      <ShipVendorKey>0</ShipVendorKey>
      <ShipVendorName>string</ShipVendorName>
      <ShipVendorCode>string</ShipVendorCode>
      <Tracking>string</Tracking>
    </pixiGetShippingVendors>
  </Body>
</Envelope>

Response

1. Shipping vendors

Name Type Description
Tracking string

Ship vendor tracking flag

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)
ChannelType string

Channel type

Type: varchar (32)

Available from: 25.06 (25.6.0.58802)
ShipVendorKey integer

Ship vendor ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShipVendorCode string

Shipping vendor code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
ShipVendorName string

Shipping vendor name

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetShippingVendorsPost200TextXmlResponse>
  <ShipVendorKey>0</ShipVendorKey>
  <ShipVendorName>string</ShipVendorName>
  <ShipVendorCode>string</ShipVendorCode>
  <Tracking>string</Tracking>
  <ChannelType>string</ChannelType>
</PixiGetShippingVendorsPost200TextXmlResponse>

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:pixiGetShippingVendors>
            <Tracking xsi:type="xsd:string">N or Y</Tracking>
            <ShipVendorKey xsi:type="xsd:integer">123</ShipVendorKey>
            <ShipVendorCode xsi:type="xsd:string">abc</ShipVendorCode>
            <ShipVendorName xsi:type="xsd:string">abcdefg</ShipVendorName>
        </ns1:pixiGetShippingVendors>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetShippingVendors', [
    'Tracking' => 'N or Y', // string
    'ShipVendorKey' => '123', // integer
    'ShipVendorCode' => 'abc', // string
    'ShipVendorName' => '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);
}