Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

LocationCarrierType Property

This contains the type of carrier the current carrier is.

Syntax

 fedexaddress.getLocationCarrierType(index, [callback])

Possible Values

  0 (lctFDXC), 
  1 (lctFDXE), 
  2 (lctFDXG), 
  3 (lctFXCC), 
  4 (lctFXFR), 
  5 (lctFXSP)

Default Value

0


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getLocationCarrierType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setLocationCarrierType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This contains the type of carrier the current carrier is. This is populated when LocationCarrierIndex is set.

The possible values are as follows:

ValueDescription
lctFDXC (0) FedEx Cargo
lctFDXE (1) FedEx Express
lctFDXG (2) FedEx Ground
lctFXCC (3) FedEx Custom Critical
lctFXFR (4) FedEx Freight
lctFXSP (5) FedEx Smart Post

The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0