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

ShipmentSpecialServices Property

Contains the collection of special services offered by FedEx.

Syntax

 fedexshipintl.getShipmentSpecialServices([callback])
 fedexshipintl.setShipmentSpecialServices( shipmentSpecialServices, [callback])

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 getShipmentSpecialServices([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 setShipmentSpecialServices([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

To request any of the special services offered by FedEx in a ship request, you must set the ShipmentSpecialServices to a set of flags as listed below:

ValueMeaning
0x00000001L Broker Select
0x00000002L Call Before Delivery
0x00000004L COD
0x00000008L Custom Delivery Window
0x00000010L Dangerous Goods
0x00000020L Do Not Break Down Pallets
0x00000040L Do Not Stack Pallets
0x00000080L Dry Ice
0x00000100L East Coast Special
0x00000200L Electronic Trade Documents
0x00000400L Email Notification
0x00000800L Extreme Length
0x00001000L Food
0x00002000L Freight Guarantee
0x00004000L Future Day
0x00008000L Hold At Location
0x00010000L International Controlled Export Service
0x00020000L Home Delivery Premium
0x00040000L Inside Delivery
0x00080000L Inside Pickup
0x00100000L Liftgate Delivery
0x00200000L Liftgate Pickup
0x00400000L Limited Access Delivery
0x00800000L Limited Access Pickup
0x01000000L Pending Shipment
0x02000000L Poison
0x04000000L Protection From Freezing
0x08000000L Return shipment
0x10000000L Saturday Delivery
0x20000000L Saturday Pickup
0x40000000L Top Load
0x10000000000LInternational Traffic in Arms Regulations

The meaning and limitations for each special service option are listed below:

  • COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery Premium. When shipping COD via FedEx Ground, the COD details must be provided on the Package level.
  • Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested (i.e., when the corresponding Dry Ice flag is contained in the ShipmentSpecialServices), then the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). This is allowed for FedEx Express shipments only.
  • Email Notification: Indicates that email notification is requested. This might affect the service availability. If this is requested in a ship request, then the Notify collection is required to be set.
  • Future Day: Indicates that future day shipping is requested. This might affect the service availability. When this is requested, for Express shipping the ShipDate must be less than or equal to 10 days in the future. For Express freight, the ShipDate must be less than or equal to 5 days in the future.
  • Hold At Location: This is applicable for FedEx Express services only. Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, and when the RecipientAddressFlags is set to Residential (i.e., for residential delivery). When this service is requested (i.e., when the corresponding Hold At Location flag is contained in the ShipmentSpecialServices), then the HoldAtLocation is required to be provided in the request as well.
  • Home Delivery: Indicates that the Home Delivery Premium special service is requested. This is applicable for residential delivery only (i.e., when this is present in the request, the RecipientAddressFlags is automatically set to Residential in the request). If ServiceType is set to GROUND HOME DELIVERY, the corresponding flag of Home Delivery is automatically added to the ShipmentSpecialServices. In this case, the HomeDeliveryDate, HomeDeliveryPhone, and HomeDeliveryType properties are required to be provided in the request as well. This property is applicable for FedEx Ground services only.
  • Inside Delivery: Indicates that inside delivery service is requested. In this case, FedEx may move shipments to positions beyond the adjacent loading area. In doing so, FedEx will assess an inside delivery charge in addition to all other applicable charges. The adjacent loading area is defined as a delivery site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. FedEx will assess an inside delivery charge when shipment breakdown is necessary to fit a shipment through a doorway. FedEx does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the delivery site. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
  • Inside Pickup: Indicates that inside pickup service is requested. In this case, FedEx may move shipments from positions beyond the adjacent loading area. In doing so, FedEx will assess an inside pickup charge in addition to all other applicable charges. The adjacent loading area is defined as a pickup site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
  • Pending Shipment Indicates that an email label has been requested. When this option is selected, you will need to also set the Notify property to specify the email address to send to and the message to be sent. You will also need to set the MerchantPhoneNumber and EmailLabelExpirationDate configuration settings. When this option is selected a label will not be saved to the location in PackageShippingLabelFile, as the label will now be emailed to the recipient(s) specified in NotifyEmail
  • Return Shipment: Indicates that the return label is requested. This might affect the shipping rates and/or service availability. In this case, the RMANumber and RMAReason can be provided in the request. When this option is selected, the return label will be returned in the server response. The recipient can then apply this return label to the return package as needed and drop the package off at a FedEx drop off location. No charges are assessed until the label is used. Express and Ground return labels are interchangeable, regardless of the original shipping service. For example, you can send the original shipment using an express service, but include a Ground return label as part of your packing documents. Express/Ground Return Labels are available for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Ground, FedEx Home Delivery, FedEx 2Day Freight, and FedEx 3Day Freight throughout the 50 United States. FedEx Express Saver and FedEx 1Day Freight services are not available. Also, Dangerous Goods and Hazardous Materials cannot be shipped. Additional service options include Saturday Service, Dry Ice Shipments, and Hold at FedEx Location. The maximum declared value is $1,000 for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, and FedEx 2Day. The maximum declared value is $50,000 for FedEx 2Day Freight and FedEx 3Day Freight. The maximum declared value is $100 for FedEx Ground and FedEx Home Delivery.
  • Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and you want Saturday delivery, the ground option and some express option will not be valid.
  • Saturday Pickup: Indicates that you request to have the shipment picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on week day other than Saturday and you want Saturday pickup, the ground option and some express option will not be valid.
  • ThirdParty Consignee: Indicates that the third party special service is requested. This might affect the shipping rates and/or service availability.
  • Broker Select: Indicates that the broker select special service is requested. When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services: FedEx International Priority, FedEx International Economy, FedEx International Priority Freight, FedEx International Economy Freight. FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the BrokerType, BrokerContact, and BrokerAddress are required to be provided in the ship request as well. Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.
  • East Coast Special: Indicates that East Coast special service is requested. This is applicable to domestic shipments only. This might affect the shipping rates and/or service availability.
  • International Controlled Export Service Indicates that the Controlled Export service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.
  • International Traffic in Arms Regulations Indicates that the Traffic in Arms Regulations service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.

Data Type

Long64

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