HomeDeliveryType Property

The type of Home Delivery Premium service being requested.

Syntax

 fedexrates.getHomeDeliveryType([callback])
 fedexrates.setHomeDeliveryType( homeDeliveryType, [callback])

Possible Values

  0 (hdtAppointment), 
  1 (hdtDateCertain), 
  2 (hdtEvening)

Default Value

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 getHomeDeliveryType([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 setHomeDeliveryType([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 property is required to be provided in a ship request when ServiceType is set to GroundHomeDelivery and ShipmentSpecialServices is set to Home Delivery Premium.

Possible values are as follows:


hdtAppointment (0)	This option is time-specific. If you want your package delivered at 1:30 on Tuesday, FedEx calls the recipient to confirm this date/time. The RecipientPhone is required in the transaction.
hdtDateCertain (1)	FedEx contacts the customer (RecipientPhone is required in transaction) and schedules a specific date for package delivery.
hdtEvening (2)	Just like 'Date Certain Delivery'. FedEx contacts the customer (RecipientPhone is required in transaction) and schedules an evening package delivery.

Data Type

Integer