FedExShip Component

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a FedEx shipping label for any of FedEx domestic services complete with addresses and barcode, cancel a shipment or close out the FedEx Ground shipments.

Syntax

DPayments.DShippingSDK.Fedexship

Remarks

Generating a shipping label can be done by calling either the GetPackageLabel or GetShipmentLabels method. You will have to specify the package information, FedEx service to be used for shipping this package, origin and destination information, and any other special services associated with the shipment (such as Saturday Pickup, Saturday Delivery, Hold At Locations, etc.).

This component also allows you to delete packages included in the daily shipping log that have not already been tendered to FedEx by calling the CancelShipment method. The TrackingNumber parameter that identifies the shipment must be specified in the request along with the AccountNumber.

When shipping with FedEx Ground, you can close out your shipments and generate a FedEx Ground Close Manifest by calling CloseGroundShipments method.

To use this component, you must have a FedEx AccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

NOTE: FedEx requires that all applications that print shipping labels pass a series of certification tests prior to being placed in production. The full version of FedEx Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package, you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

CarrierType Property (FedExShip Component)

The carrier type

Syntax

• C#
• VB.NET

public FedexshipCarrierTypes CarrierType { get; set; }

enum FedexshipCarrierTypes {
  ctFDXC,
  ctFDXE,
  ctFDXG,
  ctFXCC,
  ctFXFR,
  ctFXSP
}

Public Property CarrierType As FedexshipCarrierTypes

Enum FedexshipCarrierTypes
  ctFDXC
  ctFDXE
  ctFDXG
  ctFXCC
  ctFXFR
  ctFXSP
End Enum

Default Value

1

Remarks

This specifies the carrier to be used when calling SchedulePickup, or CancelPickup.

The possible values are as follows:

CloseRequest Property (FedExShip Component)

Identifies the close request.

Syntax

• C#
• VB.NET

public CloseDetail CloseRequest { get; set; }

Public Property CloseRequest As CloseDetail

Remarks

The CloseRequest represents information specific for a close request. This is applicable for FedEx Ground shipments only. Is is required to be provided when the CloseGroundShipments method is called.

This must be set to an instance of the CloseDetail type, which will contain close request details. See the CloseDetail type for more information.

CODLabel Property (FedExShip Component)

The label that is returned

Syntax

• C#
• VB.NET

public string CODLabel { get; }

Public ReadOnly Property CODLabel As String

Default Value

""

Remarks

If CODLabelFile is not set the image for the COD label this will be used to store the COD label.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

This property is read-only.

CODLabelFile Property (FedExShip Component)

The file the COD label should be written to.

Syntax

• C#
• VB.NET

public string CODLabelFile { get; set; }

Public Property CODLabelFile As String

Default Value

""

Remarks

The COD label will be written to the file specified. If no file is specified then the image will be stored in memory in CODLabel.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

CODTotalAmount Property (FedExShip Component)

The total amount to be collected on delivery.

Syntax

• C#
• VB.NET

public string CODTotalAmount { get; set; }

Public Property CODTotalAmount As String

Default Value

""

Remarks

This indicates customer's total COD amount (prior to any accumulations: total collection amount minus transportation charges). The CODTotalAmount is required to be provided in a ship request only if the corresponding flag of COD is contained in the ShipmentSpecialServices property.

For Ground COD shipments, the COD amount must be included on each package that uses COD service by setting the CODAmount and the corresponding flag of COD is contained in the SpecialServices field.

Format: Two explicit decimals (e.g.5.00).

CODTrackingNumber Property (FedExShip Component)

Contains the tracking number for the COD return shipment.

Syntax

• C#
• VB.NET

public string CODTrackingNumber { get; }

Public ReadOnly Property CODTrackingNumber As String

Default Value

""

Remarks

When shipping COD via any of the domestic FedEx Express services, this is returned in the server response. This value can then be used to track the COD return package.

This property is read-only.

CODType Property (FedExShip Component)

COD type.

Syntax

• C#
• VB.NET

public FedexshipCODTypes CODType { get; set; }

enum FedexshipCODTypes {
  codtAny,
  codtCash,
  codtGuaranteedFunds,
  codtCompanyCheck,
  codtPersonalCheck
}

Public Property CODType As FedexshipCODTypes

Enum FedexshipCODTypes
  codtAny
  codtCash
  codtGuaranteedFunds
  codtCompanyCheck
  codtPersonalCheck
End Enum

Default Value

0

Remarks

This field identifies the type of funds FedEx should collect upon package delivery. It is required to be provided in a ship request only if the COD is present (requested) in the ShipmentSpecialServices.

Possible values are as follows:

CompanyCloseTime Property (FedExShip Component)

The time your company closes.

Syntax

• C#
• VB.NET

public string CompanyCloseTime { get; set; }

Public Property CompanyCloseTime As String

Default Value

""

Remarks

This property is required for PickupAvailability and SchedulePickup requests. The ShipTime can be used to set the ready time stamp for the pickup. The ShipTime and the CompanyCloseTime must allow a long enough time period for the pickup to occur.

DeliveryDate Property (FedExShip Component)

Date on which shipment is expected to be delivered.

Syntax

• C#
• VB.NET

public string DeliveryDate { get; }

Public ReadOnly Property DeliveryDate As String

Default Value

""

Remarks

When either the GetPackageLabel or the GetShipmentLabels method is called, the DeliveryDate will be returned in the server reply. For international shipments, this information is limited to a number of international countries.

This property is read-only.

FedExAccount Property (FedExShip Component)

Login information for FedEx.

Syntax

• C#
• VB.NET

public FedExAccount FedExAccount { get; set; }

Public Property FedExAccount As FedExAccount

Remarks

This property must be set when connecting to FedEx server. It contains server and login information.

Firewall Property (FedExShip Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

FreightGuarantee Property (FedExShip Component)

Identifies the freight guarantee details.

Syntax

• C#
• VB.NET

public FreightGuaranteeDetail FreightGuarantee { get; set; }

Public Property FreightGuarantee As FreightGuaranteeDetail

Remarks

This specifies the type and date of guarantee provided for the freight shipment.

HoldAtLocation Property (FedExShip Component)

Identifies the FedEx location where you want to have your shipment held for pickup.

Syntax

• C#
• VB.NET

public AddressDetail HoldAtLocation { get; set; }

Public Property HoldAtLocation As AddressDetail

Remarks

This is the address required for a FedEx shipment that is to be held at the destination FedEx location for pickup by the recipient. The HoldAtLocation and HoldAtLocationPhone properties are required to be provided in a ship request only when the HoldAtLocation is present in the ShipmentSpecialServices.

This must be set to an instance of the AddressDetail type, which will contain HoldAtLocation details.

Hold at FedEx Location (HAL) is available to customers who want to pick up a package rather than have it delivered. The sender must select the FedEx pick-up location from designated FedEx Kinko's Office and Print Centers, FedEx Kinko's ShipCenters, or FedEx World Service Centers. For a list of available FedEx locations, use the FindLocations method of the FedExAddress component to search for FedEx stations where Hold at Location service is available.

The following FedEx services allow the HAL option:

• stFedExPriorityOvernight (10) - FedEx Priority Overnight (Saturday Service available)
• stFedExStandardOvernight (11) - FedEx Standard Overnight
• stFedEx2Day (13) - FedEx 2Day (Saturday Service available)
• stFedEx2DayAM (27) - FedEx 2Day A.M.
• stFedExExpressSaver (14) - FedEx Express Saver
• stFedExGround (15) - FedEx Ground
• stFedExInternationalConnectPlus (33) - FedEx International Connect Plus

To determine if Hold at FedEx Location is available for your origin/destination pair, you can use the FedExRates component. For US, to find the possible FedEx locations close to the recipient address, you can use the FindLocations method of the FedExAddress component.

This is applicable for FedEx Express services only.

HoldAtLocationContact Property (FedExShip Component)

The contact information for shipment when the Hold At Location service is used.

Syntax

• C#
• VB.NET

public ContactDetail HoldAtLocationContact { get; set; }

Public Property HoldAtLocationContact As ContactDetail

Remarks

If the shipment uses the Hold At Location service as specified in ShipmentSpecialServices, this specifies the information for the person to contact.

When the shipment arrives at the FedEx location where the shipment will be held, FedEx will notify the person specified here.

HoldAtLocationPhone Property (FedExShip Component)

Phone number of the FedEx location where the shipment will be hold at.

Syntax

• C#
• VB.NET

public string HoldAtLocationPhone { get; set; }

Public Property HoldAtLocationPhone As String

Default Value

""

Remarks

When your Hold at Location shipment is received at the designated FedEx station, you will be notified that your shipment is ready to be picked up. It is required to be provided in a HoldAtLocation request.

HomeDeliveryDate Property (FedExShip Component)

Date for Ground Home Delivery service.

Syntax

• C#
• VB.NET

public string HomeDeliveryDate { get; set; }

Public Property HomeDeliveryDate As String

Default Value

""

Remarks

The date when the Home Delivery Premium service is requested to happen. This is required when HomeDeliveryType is set to 1 (DateCertain). Valid dates are Monday through Saturday.

Format: YYYY-MM-DD.

HomeDeliveryPhone Property (FedExShip Component)

The phone number of the delivery location.

Syntax

• C#
• VB.NET

public string HomeDeliveryPhone { get; set; }

Public Property HomeDeliveryPhone As String

Default Value

""

Remarks

This is required when HomeDeliveryType is set to 0 (Appointment) or 1 (DateCertain). In a ship request, if this is not specified, it will default to Phone.

HomeDeliveryType Property (FedExShip Component)

The type of Home Delivery Premium service being requested.

Syntax

• C#
• VB.NET

public FedexshipHomeDeliveryTypes HomeDeliveryType { get; set; }

enum FedexshipHomeDeliveryTypes {
  hdtAppointment,
  hdtDateCertain,
  hdtEvening
}

Public Property HomeDeliveryType As FedexshipHomeDeliveryTypes

Enum FedexshipHomeDeliveryTypes
  hdtAppointment
  hdtDateCertain
  hdtEvening
End Enum

Default Value

0

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:

InsuredValue Property (FedExShip Component)

Total insured amount.

Syntax

• C#
• VB.NET

public string InsuredValue { get; set; }

Public Property InsuredValue As String

Default Value

"0.00"

Remarks

This element is optional. This is just insurance on the whole shipment if it is lost or stolen. If not provided in the request, FedEx will assume the 0 USD value. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

LabelImageType Property (FedExShip Component)

Type of image or printer commands the label is to be formatted in.

Syntax

• C#
• VB.NET

public FedexshipLabelImageTypes LabelImageType { get; set; }

enum FedexshipLabelImageTypes {
  fitPDF,
  fitPNG,
  fitEltron,
  fitZebra,
  fitUniMark
}

Public Property LabelImageType As FedexshipLabelImageTypes

Enum FedexshipLabelImageTypes
  fitPDF
  fitPNG
  fitEltron
  fitZebra
  fitUniMark
End Enum

Default Value

0

Remarks

This element is required to indicate the format that the shipping label should be printed in. This must be set when either GetPackageLabel or GetShipmentLabels are called. The values for the thermal printers indicate the type of printer that is being used.

Valid image types and their meanings with the corresponding usage are listed below:

There are two types of shipping labels supported:

• plain paper (to be used in laser printers only. In this case, possible values for the LabelImageType are PNG or PDF),
• thermal (to be used in thermal printers only. In this case, possible values for the LabelImageType are ELTRON, ZEBRA, or UNIMARK).

While the content of each of these labels is the same, using the correct image type for the work environment the application will be used in is essential.

You may use the LabelStockType config to specify the size of the label. By default, the component will request a 4x6 label.

Location Property (FedExShip Component)

The FedEx location identifier that received the express dispatch request.

Syntax

• C#
• VB.NET

public string Location { get; set; }

Public Property Location As String

Default Value

""

Remarks

This property is returned after a call to SchedulePickup and contains the Id of the FedEx location that is scheduled to pick up the package.

When calling CancelPickup, this property must be supplied for the cancel request to be successful.

Manifest Property (FedExShip Component)

Image of the manifest for FedEx Ground shipment activity.

Syntax

• C#
• VB.NET

public string Manifest { get; }
public byte[] ManifestB { get; }

Public ReadOnly Property Manifest As String
Public ReadOnly Property ManifestB As Byte()

Default Value

""

Remarks

This identifies the buffer containing the ASCII data contents of the manifest report for FedEx Ground shipments.

When the CloseGroundShipments method is called, the Manifest is returned when the TrackingNumber is present in the request and Manifest indicates the manifest containing that tracking number, or when the ReportType is set to 1 (Manifest). In the last case, this will indicate all manifests from the last 3 days' Closes.

The report is generated in TXT format and saved to disk under ReportFile. The manifest is essential at the time of pickup.

This property is applicable for FedEx Ground services only.

This property is read-only.

MasterTrackingNumber Property (FedExShip Component)

Tracking number assigned to the whole MPS shipment.

Syntax

• C#
• VB.NET

public string MasterTrackingNumber { get; }

Public ReadOnly Property MasterTrackingNumber As String

Default Value

""

Remarks

This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when either the GetPackageLabel or the GetShipmentLabels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the CancelShipment method is called). It can also be used when tracking a MPS.

This property is read-only.

Notify Property (FedExShip Component)

Collection of recipients to get notified.

Syntax

• C#
• VB.NET

public NotifyDetailList Notify { get; }

Public Property Notify As NotifyDetailList

Remarks

The Notify is required to be provided when the Event Notification flag has been set on the ShipmentSpecialServices property.

For each idx = 0 to NotifyCount - 1, this must be set to an instance of the NotifyDetail type, which will contain specific information about the recipient to be notified. See the NotifyDetail type for more information.

Each recipient to receive an e-mail notification has a Email (required), RecipientType (optional), Message (optional), and NotificationFlags (optional).

Optionally, Aggregate may be specified for the entire "Recipients" xml aggregate to be included for the recipient.

For instance, if the recipients' list consists of one recipient:

component.Notify[0].Email = "test@test.com"; component.Notify[0].RecipientType = rtShipper; component.Notify[0].NotificationFlags = (0x08 | 0x20); // (NOTIFY_FLAG_DELIVERY | NOTIFY_FLAG_HTML)

This property is not available at design time.

OP950Certificate Property (FedExShip Component)

Image of the OP_950 certification report.

Syntax

• C#
• VB.NET

public string OP950Certificate { get; }
public byte[] OP950CertificateB { get; }

Public ReadOnly Property OP950Certificate As String
Public ReadOnly Property OP950CertificateB As Byte()

Default Value

""

Remarks

This identifies the buffer containing the OP_950 certification report for FedEx Ground shipments.

When calling the CloseGroundShipments method, the OP950Certificate is returned when ReportType is set to 2 (OP950).

The report is generated in TXT format. The report will automatically be saved to disk in the file designated by ReportFile.

This property is applicable for FedEx Ground services only.

This property is read-only.

OriginAddress Property (FedExShip Component)

Identifies the originating address.

Syntax

• C#
• VB.NET

public AddressDetail OriginAddress { get; set; }

Public Property OriginAddress As AddressDetail

Remarks

The OriginAddress is optional and should be used when the OriginAddress is different from the SenderAddress.

The Residential flag in the AddressFlags field is applicable for FedEx Ground services only.

This must be set to an instance of the AddressDetail type, which will contain origin's address details. See the AddressDetail type for more information.

OriginContact Property (FedExShip Component)

Identifies the sender's contact info.

Syntax

• C#
• VB.NET

public ContactDetail OriginContact { get; set; }

Public Property OriginContact As ContactDetail

Remarks

The OriginContact is optional and should be used to when the OriginAddress is different from the SenderAddress

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.

PackageLocation Property (FedExShip Component)

The location of pickup.

Syntax

• C#
• VB.NET

public FedexshipPackageLocations PackageLocation { get; set; }

enum FedexshipPackageLocations {
  plNone,
  plFront,
  plSide,
  plRear
}

Public Property PackageLocation As FedexshipPackageLocations

Enum FedexshipPackageLocations
  plNone
  plFront
  plSide
  plRear
End Enum

Default Value

0

Remarks

This property is optional when calling SchedulePickup. The allowed values to be selected are: None, Front, Side, or Rear.

Packages Property (FedExShip Component)

A collection of packages contained in the shipment.

Syntax

• C#
• VB.NET

public PackageDetailList Packages { get; }

Public Property Packages As PackageDetailList

Remarks

At least one package must be specified.

This property must be set to a collection of PackageDetail instances, which will contain specific information about a package contained in the shipment. See the PackageDetail type for more information.

For FedEx, the PackagingType and either the Weight or TotalWeight must be specified. The Length, Width, Height, InsuredValue, and SpecialServices are optional.

This property is not available at design time.

Payor Property (FedExShip Component)

Identifies the payor of transportation charges for the requested shipment.

Syntax

• C#
• VB.NET

public PayorDetail Payor { get; set; }

Public Property Payor As PayorDetail

Remarks

The Payor is required to be provided in a ship request. This must be set to an instance of the PayorDetail type, which will contain the payor details. See the PayorDetail type for more information.

PickupType Property (FedExShip Component)

Pickup type used for the shipment that rate is requested for.

Syntax

• C#
• VB.NET

public FedexshipPickupTypes PickupType { get; set; }

enum FedexshipPickupTypes {
  fptDropoffAtFedexLocation,
  fptContactFedexToSchedule,
  fptUseScheduledPickup,
  fptOnCall,
  fptPackageReturnProgram,
  fptRegularStop,
  fptTag,
  fptNone
}

Public Property PickupType As FedexshipPickupTypes

Enum FedexshipPickupTypes
  fptDropoffAtFedexLocation
  fptContactFedexToSchedule
  fptUseScheduledPickup
  fptOnCall
  fptPackageReturnProgram
  fptRegularStop
  fptTag
  fptNone
End Enum

Default Value

0

Remarks

Indicate the pickup type method by which the shipment to be tendered to FedEx.

Valid values are:

Proxy Property (FedExShip Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

RecipientAddress Property (FedExShip Component)

Identifies the recipient's address.

Syntax

• C#
• VB.NET

public AddressDetail RecipientAddress { get; set; }

Public Property RecipientAddress As AddressDetail

Remarks

The Residential flag is required to be set in the AddressFlags field in a ship request.

This must be set to an instance of the AddressDetail type, which will contain recipient's address info. See the AddressDetail type for more information.

RecipientContact Property (FedExShip Component)

Identifies the recipient's contact info.

Syntax

• C#
• VB.NET

public ContactDetail RecipientContact { get; set; }

Public Property RecipientContact As ContactDetail

Remarks

The RecipientContact is required to be provided in a ship request.

When shipping via FedEx Ground, the FirstName, LastName, and Company are all required to be provided in the request. Otherwise, either one of those is sufficient.

The RecipientContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact recipient. See the ContactDetail type for more information.

ReturnAddress Property (FedExShip Component)

Identifies the return address to be printed on the label.

Syntax

• C#
• VB.NET

public AddressDetail ReturnAddress { get; set; }

Public Property ReturnAddress As AddressDetail

Remarks

The ReturnAddress is required to be provided in a ship request. may be provided in a ship request, however it is optional. This should be set if the return address to be printed on the label is different than what is provided in SenderAddress

The Residential flag in the AddressFlags field is applicable for FedEx Ground services only.

This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.

ReturnContact Property (FedExShip Component)

Identifies the return contact info to be printed on the label.

Syntax

• C#
• VB.NET

public ContactDetail ReturnContact { get; set; }

Public Property ReturnContact As ContactDetail

Remarks

The ReturnContact may be provided in a ship request, however it is optional. This should be set if the return address to be printed on the label is different than what is provided in SenderContact.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.

SenderAddress Property (FedExShip Component)

Identifies the sender's address.

Syntax

• C#
• VB.NET

public AddressDetail SenderAddress { get; set; }

Public Property SenderAddress As AddressDetail

Remarks

The SenderAddress is required to be provided in a ship request.

The Residential flag in the AddressFlags field is applicable for FedEx Ground services only.

This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.

SenderContact Property (FedExShip Component)

Identifies the sender's contact info.

Syntax

• C#
• VB.NET

public ContactDetail SenderContact { get; set; }

Public Property SenderContact As ContactDetail

Remarks

The SenderContact is required to be provided in a ship request.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.

ServiceType Property (FedExShip Component)

Identifies the FedEx domestic service to use in a ship request.

Syntax

• C#
• VB.NET

public ServiceTypes ServiceType { get; set; }

enum FedexshipServiceTypes {
  stUnspecified,
  stFedExPriorityOvernight,
  stFedExStandardOvernight,
  stFedExFirstOvernight,
  stFedEx2Day,
  stFedExExpressSaver,
  stFedExGround,
  stFedExGroundHomeDelivery,
  stFedEx1DayFreight,
  stFedEx2DayFreight,
  stFedEx3DayFreight,
  stFedExInternationalPriority,
  stFedExInternationalEconomy,
  stFedExInternationalFirst,
  stFedExInternationalPriorityFreight,
  stFedExInternationalEconomyFreight,
  stFedExEuropeFirstInternationalPriority,
  stFedExSmartPost,
  stFedEx2DayAM,
  stFedExFirstFreight,
  stFedExInternationalGround,
  stFedExFreightEconomy,
  stFedExFreightPriority,
  stFedExInternationalPriorityExpress,
  stFedExInternationalConnectPlus,
  stUPSFirstClass,
  stUPSPriorityMail,
  stUPSExpeditedMailInnovations,
  stUPSPriorityMailInnovations,
  stUPSEconomyMailInnovations,
  stUPSNextDayAir,
  stUPSExpress,
  stUPS2ndDayAir,
  stUPSGround,
  stUPSWorldwideExpress,
  stUPSWorldwideExpedited,
  stUPSExpedited,
  stUPSStandard,
  stUPS3DaySelect,
  stUPSNextDayAirSaver,
  stUPSSaver,
  stUPSNextDayAirEarlyAM,
  stUPSExpressEarlyAM,
  stUPSWorldwideExpressPlus,
  stUPSExpressPlus,
  stUPS2ndDayAirAM,
  stUPSTodayStandard,
  stUPSTodayCourrier,
  stUPSTodayInterCity,
  stUPSTodayExpress,
  stUPSTodayExpressSaver,
  stUPSWorldwideExpressFreight,
  stUPSSurePostLessThan1LB,
  stUPSSurePost1LBOrGreater,
  stUPSSurePostBPM,
  stUPSSurePostMedia,
  stUSPSExpress,
  stUSPSFirstClass,
  stUSPSPriority,
  stUSPSParcelPost,
  stUSPSBPM,
  stUSPSMedia,
  stUSPSLibrary,
  stUSPSOnline,
  stUSPSGlobalExpress,
  stUSPSParcelSelect,
  stUSPSCriticalMail,
  stUSPSStandardMail,
  stUSPSExpressMailInternational,
  stUSPSFirstClassMailInternational,
  stUSPSPriorityMailInternational,
  stUSPSPriorityExpress,
  stUSPSRetailGround,
  stUSPSFirstClassPackageInternationalService,
  stUSPSPriorityMailExpressInternational,
  stCanadaRegularParcel,
  stCanadaExpeditedParcel,
  stCanadaXpresspost,
  stCanadaLibrary,
  stCanadaPriority,
  stCanadaPriorityEnvelopeUSA,
  stCanadaPriorityPakUSA,
  stCanadaPriorityParcelUSA,
  stCanadaXpresspostUSA,
  stCanadaExpeditedParcelUSA,
  stCanadaSmallPacketAirUSA,
  stCanadaTrackedPacketUSA,
  stCanadaTrackedPacketLVMUSA,
  stCanadaPriorityEnvelopeInternational,
  stCanadaPriorityPakInternational,
  stCanadaPriorityParcelInternational,
  stCanadaXpresspostInternational,
  stCanadaSmallPacketAirInternational,
  stCanadaSmallPacketLandInternational,
  stCanadaParcelAirInternational,
  stCanadaParcelLandInternational,
  stCanadaTrackedPacketInternational,
  stFedExSameDay,
  stFedExSameDayCity,
  stFedExSameDayMetroAfternoon,
  stFedExSameDayMetroMorning,
  stFedExSameDayMetroRush,
  stUPSWorldwideEconomyDDU,
  stUPSWorldwideEconomyDDP,
  stUSPSParcelSelectGround,
  stUSPSPriorityMailCubic,
  stUSPSGroundAdvantage,
  stUSPSGroundAdvantageCubic,
  stFedExFirst,
  stFedExPriority,
  stFedExPriorityExpress,
  stFedExPriorityExpressFreight,
  stFedExPriorityFreight,
  stFedExEconomySelect
}

Public Property ServiceType As ServiceTypes

Enum FedexshipServiceTypes
  stUnspecified
  stFedExPriorityOvernight
  stFedExStandardOvernight
  stFedExFirstOvernight
  stFedEx2Day
  stFedExExpressSaver
  stFedExGround
  stFedExGroundHomeDelivery
  stFedEx1DayFreight
  stFedEx2DayFreight
  stFedEx3DayFreight
  stFedExInternationalPriority
  stFedExInternationalEconomy
  stFedExInternationalFirst
  stFedExInternationalPriorityFreight
  stFedExInternationalEconomyFreight
  stFedExEuropeFirstInternationalPriority
  stFedExSmartPost
  stFedEx2DayAM
  stFedExFirstFreight
  stFedExInternationalGround
  stFedExFreightEconomy
  stFedExFreightPriority
  stFedExInternationalPriorityExpress
  stFedExInternationalConnectPlus
  stUPSFirstClass
  stUPSPriorityMail
  stUPSExpeditedMailInnovations
  stUPSPriorityMailInnovations
  stUPSEconomyMailInnovations
  stUPSNextDayAir
  stUPSExpress
  stUPS2ndDayAir
  stUPSGround
  stUPSWorldwideExpress
  stUPSWorldwideExpedited
  stUPSExpedited
  stUPSStandard
  stUPS3DaySelect
  stUPSNextDayAirSaver
  stUPSSaver
  stUPSNextDayAirEarlyAM
  stUPSExpressEarlyAM
  stUPSWorldwideExpressPlus
  stUPSExpressPlus
  stUPS2ndDayAirAM
  stUPSTodayStandard
  stUPSTodayCourrier
  stUPSTodayInterCity
  stUPSTodayExpress
  stUPSTodayExpressSaver
  stUPSWorldwideExpressFreight
  stUPSSurePostLessThan1LB
  stUPSSurePost1LBOrGreater
  stUPSSurePostBPM
  stUPSSurePostMedia
  stUSPSExpress
  stUSPSFirstClass
  stUSPSPriority
  stUSPSParcelPost
  stUSPSBPM
  stUSPSMedia
  stUSPSLibrary
  stUSPSOnline
  stUSPSGlobalExpress
  stUSPSParcelSelect
  stUSPSCriticalMail
  stUSPSStandardMail
  stUSPSExpressMailInternational
  stUSPSFirstClassMailInternational
  stUSPSPriorityMailInternational
  stUSPSPriorityExpress
  stUSPSRetailGround
  stUSPSFirstClassPackageInternationalService
  stUSPSPriorityMailExpressInternational
  stCanadaRegularParcel
  stCanadaExpeditedParcel
  stCanadaXpresspost
  stCanadaLibrary
  stCanadaPriority
  stCanadaPriorityEnvelopeUSA
  stCanadaPriorityPakUSA
  stCanadaPriorityParcelUSA
  stCanadaXpresspostUSA
  stCanadaExpeditedParcelUSA
  stCanadaSmallPacketAirUSA
  stCanadaTrackedPacketUSA
  stCanadaTrackedPacketLVMUSA
  stCanadaPriorityEnvelopeInternational
  stCanadaPriorityPakInternational
  stCanadaPriorityParcelInternational
  stCanadaXpresspostInternational
  stCanadaSmallPacketAirInternational
  stCanadaSmallPacketLandInternational
  stCanadaParcelAirInternational
  stCanadaParcelLandInternational
  stCanadaTrackedPacketInternational
  stFedExSameDay
  stFedExSameDayCity
  stFedExSameDayMetroAfternoon
  stFedExSameDayMetroMorning
  stFedExSameDayMetroRush
  stUPSWorldwideEconomyDDU
  stUPSWorldwideEconomyDDP
  stUSPSParcelSelectGround
  stUSPSPriorityMailCubic
  stUSPSGroundAdvantage
  stUSPSGroundAdvantageCubic
  stFedExFirst
  stFedExPriority
  stFedExPriorityExpress
  stFedExPriorityExpressFreight
  stFedExPriorityFreight
  stFedExEconomySelect
End Enum

Default Value

0

Remarks

This property is required to be provided in a ship request. FedEx Ground and FedEx Ground Home Delivery are applicable to FedEx Ground carrier only. All other service types are only applicable to FedEx Express carrier.

Valid values for FedEx are:

This property is not available at design time.

ShipDate Property (FedExShip Component)

The date on which the package will be tendered to FedEx.

Syntax

• C#
• VB.NET

public string ShipDate { get; set; }

Public Property ShipDate As String

Default Value

""

Remarks

This is required to be provided in a ship request. The date should be the current date, or a date no more than 10 days in the future.

Defaults to current system date if not present.

This property is also required to be used for the PickupAvailability and SchedulePickup methods. It is used by these methods to tell FedEx when to pickup the packages.

Format: YYYY-MM-DD (e.g. 2024-09-30).

ShipmentSpecialServices Property (FedExShip Component)

Contains the collection of special services offered by FedEx.

Syntax

• C#
• VB.NET

public long ShipmentSpecialServices { get; set; }

Public Property ShipmentSpecialServices As Long

Default Value

0

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:

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.
• Event Notification: Indicates that event 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.
• 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 AddressFlags 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 AddressFlags 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 ShippingLabelFile, as the label will now be emailed to the recipient(s) specified in Email
• 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.
• Electronic Trade Documents: This only applies when shipping internationally. FedEx will generate and submit your trade documents specified in the ShippingDocumentTypes electronically and you no longer need to print and attach them. Note that some countries do not accept Electronic Trade Documents (ETD). For a full list of countries that support ETD you can go to http://images.fedex.com/international/pdf/FedExElectronicTradeDocuments_Coverage.pdf.

  If you also want to receive copies of the FedEx generated documents use the RequestedETDDocuments property together with the ShippingDocumentFile config to specify the files you are requesting and the location where to save them.

• 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:
  • stFedExInternationalPriority (20)
  • stFedExInternationalEconomy (21)
  • stFedExInternationalPriorityFreight (23)
  • stFedExInternationalEconomyFreight (24)
  • stFedExInternationalPriorityExpress (32)
  • stFedExInternationalConnectPlus (33)
  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 ClearanceBrokerageType, 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.
• FedEx One Rate Shipping Indicates that FedEx One Rate packaging is being used. This is only applicable for when using a U.S. origin and destination, excluding Hawaii. Valid service types are listed below as both the :

  ServiceType	FedEx Service
  stFedExPriorityOvernight (10)	PRIORITY_OVERNIGHT
  stFedExStandardOvernight (11)	STANDARD_OVERNIGHT
  stFedExFirstOvernight (12)	FIRST_OVERNIGHT
  stFedExExpressSaver (14)	FEDEX_EXPRESS_SAVER
  stFedEx2Day (13)	FEDEX_2_DAY
  stFedEx2DayAM (27)	FEDEX_2_DAY_AM

SSLAcceptServerCert Property (FedExShip Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (FedExShip Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (FedExShip Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public FedexshipSSLProviders SSLProvider { get; set; }

enum FedexshipSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As FedexshipSSLProviders

Enum FedexshipSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (FedExShip Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (FedExShip Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TotalNetCharge Property (FedExShip Component)

The total net charge applied to the whole shipment (specific to the AccountNumber ).

Syntax

• C#
• VB.NET

public string TotalNetCharge { get; }

Public ReadOnly Property TotalNetCharge As String

Default Value

""

Remarks

In a MPS ship request, this represents the total net charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as NetCharge at index=0.

This property is read-only.

TotalWeight Property (FedExShip Component)

Total shipment weight.

Syntax

• C#
• VB.NET

public string TotalWeight { get; set; }

Public Property TotalWeight As String

Default Value

""

Remarks

Identifies the total weight of the shipment being conveyed to FedEx. This element is optional when submitting a ship request. It requires one explicit decimal position (i.e. N.N formatting).

TransitTime Property (FedExShip Component)

Expected number of days in transit from pickup to delivery.

Syntax

• C#
• VB.NET

public string TransitTime { get; }

Public ReadOnly Property TransitTime As String

Default Value

""

Remarks

This is an estimate only. When either the GetPackageLabel or GetShipmentLabels method is called, the DeliveryDate will be returned in the server reply. For international shipments, this information is a limited to a number of international countries and it depends on the customs clearance times.

Possible values are: ONE_DAY, TWO_DAYS, THREE_DAYS, FOUR_DAYS, FIVE_DAYS, SIX_DAYS, SEVEN_DAYS, EIGHT_DAYS, NINE_DAYS, and UNKNOWN.

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

CancelPackage Method (FedExShip Component)

Cancels a single package shipment by deleting it from the shipping log.

Syntax

• C#
• VB.NET

public void CancelPackage(string trackingNumber);

Public Sub CancelPackage(ByVal TrackingNumber As String)

Remarks

Cancels FedEx Express and Ground package that have not already been tendered to FedEx.

The TrackingNumber parameter, that identifies the package to be canceled and deleted from the shipping log, is the TrackingNumber assigned to the package by FedEx server when either the GetPackageLabel or the GetShipmentLabels method was called.

The following properties can be set prior to calling this method:

• AccountNumber (required)
• CountryCode

To check the status of your cancel request the CancelledShipment config should be inspected.

CancelPickup Method (FedExShip Component)

Cancels a scheduled Carrier Pickup request.

Syntax

• C#
• VB.NET

public string CancelPickup(string confirmationNumber);

Public Function CancelPickup(ByVal ConfirmationNumber As String) As String

Remarks

When the CancelPickup method is called, the exact data from the original SchedulePickup request must be entered.

You must enter the following information:

• ConfirmationNumber (required)
• AccountNumber (required)
• CarrierType (required)
• ShipDate (required)
• Location (required for canceling an express pickup)
• SpecialInstructions (required for canceling ground pickup)

Valid CarrierType values are FDXG (FedEx Ground) or FDXE (FedEx Express).

If the information entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from FedEx about the request to cancel the pickup, if one exists.

CancelShipment Method (FedExShip Component)

Cancels all packages within the shipment.

Syntax

• C#
• VB.NET

public void CancelShipment(string trackingNumber);

Public Sub CancelShipment(ByVal TrackingNumber As String)

Remarks

Cancels FedEx Express and Ground shipments that have not already been tendered to FedEx.

The TrackingNumber parameter, that identifies the shipment to be canceled and deleted from the shipping log, is assigned by FedEx server when either the GetPackageLabel or GetShipmentLabels method was called.

The following properties can be set prior to calling this method:

• AccountNumber (required)
• CountryCode

To check the status of your cancel request the CancelledShipment config should be inspected.

CloseGroundShipments Method (FedExShip Component)

Closes out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests.

Syntax

• C#
• VB.NET

public void CloseGroundShipments();

Public Sub CloseGroundShipments()

Remarks

Closing is a function to be used for FedEx Ground shipments only. Express shipments are automatically closed and do not require you to perform a specific close operation. The Close service allows you to reconcile shipping information for your Ground shipments and print a Ground Manifest for your Ground driver.

At the end of the shipping day, you should perform the FedEx Ground End of Day Close procedure. To do so, call the CloseGroundShipments method. The Ground manifest (Manifest stored in ReportFile) is generated after a successful close and must be printed before your Ground shipments are tendered to FedEx. This is required to be tendered to FedEx along with your packages if they are being picked up by FedEx Ground. If you are dropping the packages off at a FedEx drop-off location, the manifest is not required.

You may continue to ship Ground packages after a Close has been performed. The Close service may be performed multiple times during your shipping day. Use the Close service to initiate the final stage of processing all shipment data submitted for the day (close of business).

A customer cannot cancel any shipments once they are closed out. However, shipments can be added to a day's shipment after a close operation has been performed and multiple closes can be performed in a day.

When this method is called, the following properties must have been set:

• AuthorizationToken (required)
• Server (optional)
• AccountNumber (required)
• CloseRequest (required)

ReportType specifies the type of report. Only one type of report can be returned per Close request. If you need multiple report types you will have to issue multiple CloseGroundShipments requests.

The report will automatically be written to the file specified by ReportFile. These reports can be printed anytime during the shipping day for shipments that have already been closed (up to three days in the past).

Config Method (FedExShip Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetPackageLabel Method (FedExShip Component)

Generates a shipping label for the specified package.

Syntax

• C#
• VB.NET

public void GetPackageLabel(int index);

Public Sub GetPackageLabel(ByVal Index As Integer)

Remarks

When this method is called, the following properties must have been set:

• AuthorizationToken (required)
• Server (optional)
• AccountNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackagingType (required)
• TotalWeight (optional; applicable to international shipments only)
• WeightUnit (required; defaults to LB)
• SizeUnit (required; defaults to IN)
• InsuredValue (optional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• Packages (required)
• LabelImageType (required)
• DeliveryInstructions (optional; applicable to Home Delivery and Freight services only)
• BlockVisibility (optional)

When shipping via FedEx Ground then the PackagingType should be set to ptYourPackaging.

This method fills in the following fields:

• TrackingNumber for each package included in the shipment;
• ShippingLabel for each package included in the shipment;
• NetCharge for each package included in the shipment;
• BaseCharge for each package included in the shipment;
• TotalDiscount for each package included in the shipment;
• TotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

GetShipmentLabels Method (FedExShip Component)

Generates a shipping label for all packages in the shipment.

Syntax

• C#
• VB.NET

public void GetShipmentLabels();

Public Sub GetShipmentLabels()

Remarks

When this method is called, the following properties must have been set:

• AuthorizationToken (required)
• Server (optional)
• AccountNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackagingType (required)
• TotalWeight (optional; applicable to international shipments only)
• WeightUnit (required; defaults to LB)
• SizeUnit (required; defaults to IN)
• InsuredValue (optional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• Packages (required)
• LabelImageType (required)
• DeliveryInstructions (optional; applicable to Home Delivery and Freight services only)
• BlockVisibility (optional)

When shipping via FedEx Ground then the PackagingType should be set to ptYourPackaging.

This method fills in the following fields:

• TrackingNumber for each package included in the shipment;
• ShippingLabel for each package included in the shipment;
• NetCharge for each package included in the shipment;
• BaseCharge for each package included in the shipment;
• TotalDiscount for each package included in the shipment;
• TotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

PickupAvailability Method (FedExShip Component)

Checks the availability of the courier dispatch service for the given address.

Syntax

• C#
• VB.NET

public void PickupAvailability();

Public Sub PickupAvailability()

Remarks

The PickupAvailability method requires the values for the following properties:

• ServiceType (required)
• CarrierType (required)
• Address1 (required)
• City (optional)
• State (optional)
• ZipCode (required)
• CountryCode (required)
• ShipDate (optional)
• ShipTime (optional)
• CompanyCloseTime (optional)
• PickupType (optional)
• Packages (optional)
• TotalWeight (optional)

Valid values for CarrierType are FDXE (FedEx Express) or FDXG (FedEx Ground).

The Packages property may optionally be populated with dimensions such as Length, Width, and Height.

If the Carrier Pickup service is available to the supplied address, the following properties will be returned. These properties indicate the earliest available pickup date and the carrier that will be picking up your packages:

• ShipDate
• ShipTime
• CarrierType
• CutoffTime
• AccessTime (Example: 'PT1H0M' means Pickup Time is 1 Hour and 0 Minutes)

ReprintDocuments Method (FedExShip Component)

Reprints the requested document.

Syntax

• C#
• VB.NET

public void ReprintDocuments();

Public Sub ReprintDocuments()

Remarks

When called this will request the document type specified in ReportType for the specified.

Reset Method (FedExShip Component)

Resets the internal state of the component and all properties to their default values.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

The Reset method does not have any parameters and does not return any value.

SchedulePickup Method (FedExShip Component)

This method schedules a courier pickup.

Syntax

• C#
• VB.NET

public string SchedulePickup();

Public Function SchedulePickup() As String

Remarks

Schedules a courier pickup and returns a confirmation number for the scheduled pickup.

The following properties are applicable:

• CarrierType (required, valid values are ctFDXG (FedEx Ground) or ctFDXE (FedEx Express))
• CompanyCloseTime
• Packages (required if PackageCount is not set)
• PackageLocation
• SenderAddress
  • Address1 (required when UseAccountAddress is false)
  • Address2 (optional)
  • City (required when UseAccountAddress is false)
  • State (required when UseAccountAddress is false)
  • ZipCode (required when UseAccountAddress is false)
  • CountryCode (required when UseAccountAddress is false)
• SenderContact
  • Company (required when UseAccountAddress is false)
  • Email (optional)
  • Fax (optional)
  • FirstName (required when UseAccountAddress is false)
  • LastName (required when UseAccountAddress is false)
  • MiddleInitial (optional)
  • Phone (required when UseAccountAddress is false)
• ShipDate
• ShipTime
• PackageCount (optional)
• TotalWeight (required)
• SpecialInstructions (optional)
• UseAccountAddress (optional)

If the courier pickup service is available for the supplied address, the confirmation number will be returned by this method. The Location property will also be populated.

Prior to making a SchedulePickup call, it is recommended to first call the PickupAvailability method to confirm that the pickup service is available.

Error Event (FedExShip Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, FedexshipErrorEventArgs e);

public class FedexshipErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As FedexshipErrorEventArgs)

Public Class FedexshipErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (FedExShip Component)

Notification returned by the server upon successful request (if applicable).

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, FedexshipNotificationEventArgs e);

public class FedexshipNotificationEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As FedexshipNotificationEventArgs)

Public Class FedexshipNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (FedExShip Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, FedexshipSSLServerAuthenticationEventArgs e);

public class FedexshipSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As FedexshipSSLServerAuthenticationEventArgs)

Public Class FedexshipSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FedExShip Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, FedexshipSSLStatusEventArgs e);

public class FedexshipSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As FedexshipSSLStatusEventArgs)

Public Class FedexshipSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

AddressDetail Type

Represents the address details of a sender or recipient.

Remarks

This type contains descriptive data of physical location of a sender or recipient.

Example: Setting the fields of a sender SenderAddress addr = new SenderAddress addr.Address1 = "100 Somewhere St." addr.Address2 = "Ste 100" addr.City = "Raleigh" addr.State = "NC" addr.ZipCode = "27154" addr.CountryCode = "US"

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public AddressDetail();

Public AddressDetail()

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

CloseDetail Type

Represents the details of a Close request (applicable to Ground shipments only).

Remarks

This type contains specific information of a Close request. It is used in the FedExShip and FedExShipIntl components when the CloseGroundShipments method is called.

Example: Setting the fields of a Close request (when requesting to reprint the Close manifest) CloseDetail close = new CloseDetail close.Date = "2008-10-15" close.TrackingNumber = "123456789012345" close.ReportFile = "manifest.txt"

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public CloseDetail();

Public CloseDetail()

• C#
• VB.NET

public CloseDetail(string date);

Public CloseDetail(ByVal Date As String)

• C#
• VB.NET

public CloseDetail(string date, string trackingNumber, string reportFile);

Public CloseDetail(ByVal Date As String, ByVal TrackingNumber As String, ByVal ReportFile As String)

• C#
• VB.NET

public CloseDetail(string date, int reportType, string reportFile);

Public CloseDetail(ByVal Date As String, ByVal ReportType As Integer, ByVal ReportFile As String)

ContactDetail Type

Represents the contact information.

Remarks

This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).

Example: Setting the fields of the sender ContactDetail senderContact = new ContactDetail senderContact.Company = "Anything Anywhere" senderContact.FirstName = "John" senderContact.LastName = "Doe" senderContact.Phone = "1234567890" senderContact.Email = "test@test.com"

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public ContactDetail();

Public ContactDetail()

• C#
• VB.NET

public ContactDetail(string firstName, string lastName, string phone);

Public ContactDetail(ByVal FirstName As String, ByVal LastName As String, ByVal Phone As String)

• C#
• VB.NET

public ContactDetail(string firstName, string lastName, string phone, string email);

Public ContactDetail(ByVal FirstName As String, ByVal LastName As String, ByVal Phone As String, ByVal Email As String)

• C#
• VB.NET

public ContactDetail(string firstName, string lastName, string phone, string email, string company);

Public ContactDetail(ByVal FirstName As String, ByVal LastName As String, ByVal Phone As String, ByVal Email As String, ByVal Company As String)

FedExAccount Type

Represents the details of a FedEx account.

Remarks

This type contains data describing the FedEx server and login information.

Example: Setting the fields of an account FedExAccount account = new FedExAccount account.AccountNumber = "1234567" account.AuthorizationToken = "bearer_token_value" account.Server = "https://test.fedex.com"

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public FedExAccount();

Public FedExAccount()

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

FreightGuaranteeDetail Type

Indicates the freight guarantee details.

Remarks

This type provide the details for when the freight shipment is guaranteed for.

Example: Setting the fields for the freight guarantee details

FreightGuaranteeDetail detail = new FreightGuaranteeDetail detail.Type = TFreightGuaranteeType.fgtGuaranteedMorning detail.Date = "2013-08-15"

Fields

Constructors

• C#
• VB.NET

public FreightGuaranteeDetail();

Public FreightGuaranteeDetail()

NotifyDetail Type

Represents a single recipient to be notified via email.

Remarks

This type contains specific information about a recipient to be notified via email on shipment, exception and/or delivery status.

The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public NotifyDetail();

Public NotifyDetail()

• C#
• VB.NET

public NotifyDetail(int notificationFlags, string email, string message);

Public NotifyDetail(ByVal NotificationFlags As Integer, ByVal Email As String, ByVal Message As String)

• C#
• VB.NET

public NotifyDetail(int notificationFlags, string email);

Public NotifyDetail(ByVal NotificationFlags As Integer, ByVal Email As String)

• C#
• VB.NET

public NotifyDetail(int notificationFlags, int recipientType, string email);

Public NotifyDetail(ByVal NotificationFlags As Integer, ByVal RecipientType As Integer, ByVal Email As String)

• C#
• VB.NET

public NotifyDetail(string name);

Public NotifyDetail(ByVal Name As String)

PackageDetail Type

Represents a single package contained in shipment.

Remarks

This type contains specific information on the package that is part of the whole shipment.

Example: Setting the package elements PackageDetail pckg = new PackageDetail pckg.Weight = "2.0" pckg.Description = "Your order for the 4D Shipping SDK" pckg.ShippingLabelFile = "shipping label for package# 1.pdf"

The fields contained by this type are listed below.

Fields