CarrierType Property

The carrier type.

Syntax

 fedexfreightship.getCarrierType([callback])
 fedexfreightship.setCarrierType( carrierType, [callback])

Possible Values

  0 (ctFDXC), 
  1 (ctFDXE), 
  2 (ctFDXG), 
  3 (ctFXCC), 
  4 (ctFXFR), 
  5 (ctFXSP)

Default Value

1

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 getCarrierType([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 setCarrierType([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 specifies the carrier to be used when calling SchedulePickup, CancelPickup, or CloseSmartPostShipments.

The possible values are as follows:

Note: When calling CloseSmartPostShipments this property must be set to either ctFDXG (2) or ctFXSP (5).

Data Type

Integer