pixi Developer & Integration Documentation

pixiGetShippingVendors

Description

This API call retrieves a list of shipping vendors.
It allows filtering based on specific criteria such as the vendor's ID, name, code, and tracking capability. If no filters are applied, it returns all available shipping vendors. The result includes details about each vendor, such as their ID, name, code, tracking capability, and associated channel type


Request Parameters

#

Name

Type

Required

Example

Description

1

ShipVendorKey

integer

0

123

Ship vendor ID

2

ShipVendorName

string

0

abcdefg

Ship vendor name

3

ShipVendorCode

string

0

abc

Ship vendor code

4

Tracking

string

0

N or Y

Ship vendor tracking flag


Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiGetShippingVendors>
         <dem:ShipVendorKey>123</dem:ShipVendorKey>
         <dem:ShipVendorName>abcdefg</dem:ShipVendorName>
         <dem:ShipVendorCode>abc</dem:ShipVendorCode>
         <dem:Tracking>N or Y</dem:Tracking>
      </dem:pixiGetShippingVendors>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Shipping vendors

#

Name

Type

Description

1

ShipVendorKey

integer

Ship vendor ID

2

ShipVendorName

string

Shipping vendor name

3

ShipVendorCode

string

Shipping vendor code

4

Tracking

string

Ship vendor tracking flag

5

ChannelType

string

Channel type


Additional Notes