CustomerTools


Click here for a complete list of operations.

Booking

Book a shipment

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /BTXWebServices/CustomerTools.asmx HTTP/1.1
Host: btxedi.btxair.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.btxair.com/BTXWebServices/Booking"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Booking xmlns="http://www.btxair.com/BTXWebServices/">
      <CustomerID>guid</CustomerID>
      <ShipFrom>
        <Name>string</Name>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <State>string</State>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Phone>string</Phone>
        <Contact>string</Contact>
        <OpenTime>string</OpenTime>
        <CloseTime>string</CloseTime>
        <Email>string</Email>
      </ShipFrom>
      <ShipTo>
        <Name>string</Name>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <State>string</State>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Phone>string</Phone>
        <Contact>string</Contact>
        <OpenTime>string</OpenTime>
        <CloseTime>string</CloseTime>
        <Email>string</Email>
      </ShipTo>
      <FreightItems>
        <FreightItem>
          <Description>string</Description>
          <NmfcItemNum>string</NmfcItemNum>
          <FreightClass>_0 or Exempt or NotTaken or _50 or _55 or _60 or _65 or _70 or _775 or _85 or _925 or _100 or _110 or _125 or _150 or _175 or _200 or _250 or _300 or _400 or _500</FreightClass>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <Pieces>int</Pieces>
          <ExtActualWeight>double</ExtActualWeight>
          <WeightUnit>Pounds or Kilograms</WeightUnit>
          <DimUnit>inches or centimeters</DimUnit>
          <ContainerType>Carton or Drum or Other or Pallet or Reel or Skid</ContainerType>
        </FreightItem>
        <FreightItem>
          <Description>string</Description>
          <NmfcItemNum>string</NmfcItemNum>
          <FreightClass>_0 or Exempt or NotTaken or _50 or _55 or _60 or _65 or _70 or _775 or _85 or _925 or _100 or _110 or _125 or _150 or _175 or _200 or _250 or _300 or _400 or _500</FreightClass>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <Pieces>int</Pieces>
          <ExtActualWeight>double</ExtActualWeight>
          <WeightUnit>Pounds or Kilograms</WeightUnit>
          <DimUnit>inches or centimeters</DimUnit>
          <ContainerType>Carton or Drum or Other or Pallet or Reel or Skid</ContainerType>
        </FreightItem>
      </FreightItems>
      <Accessorials>
        <Accessorial>
          <ID>int</ID>
          <Description>string</Description>
          <Cost>double</Cost>
        </Accessorial>
        <Accessorial>
          <ID>int</ID>
          <Description>string</Description>
          <Cost>double</Cost>
        </Accessorial>
      </Accessorials>
      <ShipDate>string</ShipDate>
      <ReadyTime>string</ReadyTime>
      <ShipmentSubType>DomesticAir or GlobalAirImport or GlobalAirExport or GroundLTL or GroundTruckingService</ShipmentSubType>
      <ServiceType>NextFlightOut or NextDay or TwoDay or ThreeDay or Economy35Day or Economy2 or Economy3 or Express or Express2 or LessThanTruckload or FullTruckload or Hotshot</ServiceType>
      <COD>decimal</COD>
      <DeclaredValue>decimal</DeclaredValue>
      <InsuranceValue>decimal</InsuranceValue>
      <Test>boolean</Test>
    </Booking>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BookingResponse xmlns="http://www.btxair.com/BTXWebServices/">
      <BookingResult>
        <Error>boolean</Error>
        <ErrorDescription>string</ErrorDescription>
        <BookingNumber>string</BookingNumber>
      </BookingResult>
    </BookingResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /BTXWebServices/CustomerTools.asmx HTTP/1.1
Host: btxedi.btxair.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Booking xmlns="http://www.btxair.com/BTXWebServices/">
      <CustomerID>guid</CustomerID>
      <ShipFrom>
        <Name>string</Name>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <State>string</State>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Phone>string</Phone>
        <Contact>string</Contact>
        <OpenTime>string</OpenTime>
        <CloseTime>string</CloseTime>
        <Email>string</Email>
      </ShipFrom>
      <ShipTo>
        <Name>string</Name>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <State>string</State>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Phone>string</Phone>
        <Contact>string</Contact>
        <OpenTime>string</OpenTime>
        <CloseTime>string</CloseTime>
        <Email>string</Email>
      </ShipTo>
      <FreightItems>
        <FreightItem>
          <Description>string</Description>
          <NmfcItemNum>string</NmfcItemNum>
          <FreightClass>_0 or Exempt or NotTaken or _50 or _55 or _60 or _65 or _70 or _775 or _85 or _925 or _100 or _110 or _125 or _150 or _175 or _200 or _250 or _300 or _400 or _500</FreightClass>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <Pieces>int</Pieces>
          <ExtActualWeight>double</ExtActualWeight>
          <WeightUnit>Pounds or Kilograms</WeightUnit>
          <DimUnit>inches or centimeters</DimUnit>
          <ContainerType>Carton or Drum or Other or Pallet or Reel or Skid</ContainerType>
        </FreightItem>
        <FreightItem>
          <Description>string</Description>
          <NmfcItemNum>string</NmfcItemNum>
          <FreightClass>_0 or Exempt or NotTaken or _50 or _55 or _60 or _65 or _70 or _775 or _85 or _925 or _100 or _110 or _125 or _150 or _175 or _200 or _250 or _300 or _400 or _500</FreightClass>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
          <Pieces>int</Pieces>
          <ExtActualWeight>double</ExtActualWeight>
          <WeightUnit>Pounds or Kilograms</WeightUnit>
          <DimUnit>inches or centimeters</DimUnit>
          <ContainerType>Carton or Drum or Other or Pallet or Reel or Skid</ContainerType>
        </FreightItem>
      </FreightItems>
      <Accessorials>
        <Accessorial>
          <ID>int</ID>
          <Description>string</Description>
          <Cost>double</Cost>
        </Accessorial>
        <Accessorial>
          <ID>int</ID>
          <Description>string</Description>
          <Cost>double</Cost>
        </Accessorial>
      </Accessorials>
      <ShipDate>string</ShipDate>
      <ReadyTime>string</ReadyTime>
      <ShipmentSubType>DomesticAir or GlobalAirImport or GlobalAirExport or GroundLTL or GroundTruckingService</ShipmentSubType>
      <ServiceType>NextFlightOut or NextDay or TwoDay or ThreeDay or Economy35Day or Economy2 or Economy3 or Express or Express2 or LessThanTruckload or FullTruckload or Hotshot</ServiceType>
      <COD>decimal</COD>
      <DeclaredValue>decimal</DeclaredValue>
      <InsuranceValue>decimal</InsuranceValue>
      <Test>boolean</Test>
    </Booking>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <BookingResponse xmlns="http://www.btxair.com/BTXWebServices/">
      <BookingResult>
        <Error>boolean</Error>
        <ErrorDescription>string</ErrorDescription>
        <BookingNumber>string</BookingNumber>
      </BookingResult>
    </BookingResponse>
  </soap12:Body>
</soap12:Envelope>