pixiGetShippingVendors · Pixi API documentation

Reads the shipping vendors from the ShipVendor table. For each vendor it also returns the name of the channel type of the connected channel, if any.

Filtering

Empty values are treated as "not set". This means 0 for ShipVendorKey and an empty string for the text parameters.
If no parameter is set, all shipping vendors are returned.
If one or more parameters are set, a vendor is returned when at least one of the set filters matches exactly. The filters are combined with OR, not AND.
- ShipVendorKey must equal the given key.
- ShipVendorName must equal the given name.
- ShipVendorCode must equal the given code.
- Tracking must equal the given flag.

Channel type

The procedure joins the vendor's ConnectedChannelId to the channel table and then to the channel type table. ChannelType is empty (NULL) for vendors without a connected channel.

No sort order is defined.

Notes

Because the filters are OR-combined, the result can grow when several filters are set. For example, setting ShipVendorCode = UPS and Tracking = Y returns every UPS vendor plus every vendor with tracking enabled. To narrow the result, set a single filter and filter further on the client side.
The comparisons are exact matches. Wildcards are not supported. Case sensitivity depends on the database collation.
The code does not restrict the values of Tracking. Typical values are a one-character flag such as Y/N, but this is not enforced by the procedure.
All tables are read with NOLOCK, so uncommitted data may be returned.

Tables used

ShipVendor · Read C_Channels · Read C_ChannelTypes · Read

Parameter	Type	Default	Description
`ShipVendorKey`	int	0	Key of the shipping vendor. `0` means not set. Example: `3`
`ShipVendorName`	varchar(50) string	–	Exact name of the shipping vendor. An empty string means not set. Example: `UPS Standard`
`ShipVendorCode`	varchar(3) string	–	Exact code of the shipping vendor. An empty string means not set. Example: `UPS`
`Tracking`	varchar(1) string	–	Exact value of the tracking flag of the shipping vendor. An empty string means not set. Example: `Y`

Result set 1 · Always

One row per matching shipping vendor.

Column	Type	Description
`ShipVendorKey`	int	Key of the shipping vendor.
`ShipVendorName` Nullable	varchar(50) string	Name of the shipping vendor.
`ShipVendorCode` Nullable	varchar(3) string	Code of the shipping vendor.
`Tracking` Nullable	varchar(1) string	Tracking flag of the shipping vendor.
`ChannelType` Nullable	string	Name of the channel type of the connected channel. NULL if the vendor has no connected channel.

Response example

<SqlRowSet1>
  <row>
    <ShipVendorKey>3</ShipVendorKey>
    <ShipVendorName>UPS Standard</ShipVendorName>
    <ShipVendorCode>UPS</ShipVendorCode>
    <Tracking>Y</Tracking>
  </row>
  <row>
    <ShipVendorKey>5</ShipVendorKey>
    <ShipVendorName>DHL Paket</ShipVendorName>
    <ShipVendorCode>DHL</ShipVendorCode>
    <Tracking>Y</Tracking>
    <ChannelType>Shopware</ChannelType>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetShippingVendors>
      <!-- <ShipVendorKey>3</ShipVendorKey> -->
      <!-- <ShipVendorName>UPS Standard</ShipVendorName> -->
      <!-- <ShipVendorCode>UPS</ShipVendorCode> -->
      <!-- <Tracking>Y</Tracking> -->
    </ns1:pixiGetShippingVendors>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetShippingVendors>
      <!-- <ShipVendorKey>3</ShipVendorKey> -->
      <!-- <ShipVendorName>UPS Standard</ShipVendorName> -->
      <!-- <ShipVendorCode>UPS</ShipVendorCode> -->
      <!-- <Tracking>Y</Tracking> -->
    </ns1:pixiGetShippingVendors>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'ShipVendorKey' => '3',
    // 'ShipVendorName' => 'UPS Standard',
    // 'ShipVendorCode' => 'UPS',
    // 'Tracking' => 'Y',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetShippingVendors', $soapArguments);