FedExFreightShip Module

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a FedEx shipping label for any of FedEx freight services complete with addresses and barcode, or cancel a shipment.

Syntax

DShippingSDK.Fedexfreightship

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 Location, etc.).

This class 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 FedExAccountAccountNumber.

To use this class, you must have a FedEx FedExAccountAccountNumber. 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ApprovedBy Property (FedExFreightShip Module)

Identifies the person the pickup was approved by.

Syntax

• Swift
• Objective-C

public var approvedBy: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=approvedByCompany,setter=setApprovedByCompany:) NSString* approvedByCompany;

- (NSString*)approvedByCompany;
- (void)setApprovedByCompany :(NSString*)newApprovedByCompany;

@property (nonatomic,readwrite,assign,getter=approvedByEmail,setter=setApprovedByEmail:) NSString* approvedByEmail;

- (NSString*)approvedByEmail;
- (void)setApprovedByEmail :(NSString*)newApprovedByEmail;

@property (nonatomic,readwrite,assign,getter=approvedByFax,setter=setApprovedByFax:) NSString* approvedByFax;

- (NSString*)approvedByFax;
- (void)setApprovedByFax :(NSString*)newApprovedByFax;

@property (nonatomic,readwrite,assign,getter=approvedByFirstName,setter=setApprovedByFirstName:) NSString* approvedByFirstName;

- (NSString*)approvedByFirstName;
- (void)setApprovedByFirstName :(NSString*)newApprovedByFirstName;

@property (nonatomic,readwrite,assign,getter=approvedByLastName,setter=setApprovedByLastName:) NSString* approvedByLastName;

- (NSString*)approvedByLastName;
- (void)setApprovedByLastName :(NSString*)newApprovedByLastName;

@property (nonatomic,readwrite,assign,getter=approvedByMiddleInitial,setter=setApprovedByMiddleInitial:) NSString* approvedByMiddleInitial;

- (NSString*)approvedByMiddleInitial;
- (void)setApprovedByMiddleInitial :(NSString*)newApprovedByMiddleInitial;

@property (nonatomic,readwrite,assign,getter=approvedByPhone,setter=setApprovedByPhone:) NSString* approvedByPhone;

- (NSString*)approvedByPhone;
- (void)setApprovedByPhone :(NSString*)newApprovedByPhone;

 

Default Value

""

Remarks

This is only required when calling SchedulePickup and the ServiceType is either stFedExFreightEconomy or stFedExFreightPriority.

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.

BrokerAddress Property (FedExFreightShip Module)

Identifies the broker's address.

Syntax

• Swift
• Objective-C

public var brokerAddress: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=brokerAddress1,setter=setBrokerAddress1:) NSString* brokerAddress1;

- (NSString*)brokerAddress1;
- (void)setBrokerAddress1 :(NSString*)newBrokerAddress1;

@property (nonatomic,readwrite,assign,getter=brokerAddress2,setter=setBrokerAddress2:) NSString* brokerAddress2;

- (NSString*)brokerAddress2;
- (void)setBrokerAddress2 :(NSString*)newBrokerAddress2;

@property (nonatomic,readwrite,assign,getter=brokerAddressFlags,setter=setBrokerAddressFlags:) int brokerAddressFlags;

- (int)brokerAddressFlags;
- (void)setBrokerAddressFlags :(int)newBrokerAddressFlags;

@property (nonatomic,readwrite,assign,getter=brokerCity,setter=setBrokerCity:) NSString* brokerCity;

- (NSString*)brokerCity;
- (void)setBrokerCity :(NSString*)newBrokerCity;

@property (nonatomic,readwrite,assign,getter=brokerCountryCode,setter=setBrokerCountryCode:) NSString* brokerCountryCode;

- (NSString*)brokerCountryCode;
- (void)setBrokerCountryCode :(NSString*)newBrokerCountryCode;

@property (nonatomic,readwrite,assign,getter=brokerState,setter=setBrokerState:) NSString* brokerState;

- (NSString*)brokerState;
- (void)setBrokerState :(NSString*)newBrokerState;

@property (nonatomic,readwrite,assign,getter=brokerZipCode,setter=setBrokerZipCode:) NSString* brokerZipCode;

- (NSString*)brokerZipCode;
- (void)setBrokerZipCode :(NSString*)newBrokerZipCode;

 

Default Value

""

Remarks

The BrokerAddress represents address data identifying the Broker responsible for the shipment. This is required to be provided in an international ship request only if the BrokerSelect is present (requested) in the ShipmentSpecialServices.

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.

Note this only applies when shipping internationally.

BrokerContact Property (FedExFreightShip Module)

Identifies the broker's contact info.

Syntax

• Swift
• Objective-C

public var brokerContact: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=brokerCompany,setter=setBrokerCompany:) NSString* brokerCompany;

- (NSString*)brokerCompany;
- (void)setBrokerCompany :(NSString*)newBrokerCompany;

@property (nonatomic,readwrite,assign,getter=brokerEmail,setter=setBrokerEmail:) NSString* brokerEmail;

- (NSString*)brokerEmail;
- (void)setBrokerEmail :(NSString*)newBrokerEmail;

@property (nonatomic,readwrite,assign,getter=brokerFax,setter=setBrokerFax:) NSString* brokerFax;

- (NSString*)brokerFax;
- (void)setBrokerFax :(NSString*)newBrokerFax;

@property (nonatomic,readwrite,assign,getter=brokerFirstName,setter=setBrokerFirstName:) NSString* brokerFirstName;

- (NSString*)brokerFirstName;
- (void)setBrokerFirstName :(NSString*)newBrokerFirstName;

@property (nonatomic,readwrite,assign,getter=brokerLastName,setter=setBrokerLastName:) NSString* brokerLastName;

- (NSString*)brokerLastName;
- (void)setBrokerLastName :(NSString*)newBrokerLastName;

@property (nonatomic,readwrite,assign,getter=brokerMiddleInitial,setter=setBrokerMiddleInitial:) NSString* brokerMiddleInitial;

- (NSString*)brokerMiddleInitial;
- (void)setBrokerMiddleInitial :(NSString*)newBrokerMiddleInitial;

@property (nonatomic,readwrite,assign,getter=brokerPhone,setter=setBrokerPhone:) NSString* brokerPhone;

- (NSString*)brokerPhone;
- (void)setBrokerPhone :(NSString*)newBrokerPhone;

 

Default Value

""

Remarks

The BrokerContact represents descriptive contact data identifying the Broker responsible for the shipment. It is required to be provided in an international ship request only if the BrokerSelect is present (requested) in the ShipmentSpecialServices.

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

Note this only applies when shipping internationally.

BrokerType Property (FedExFreightShip Module)

Identifies the broker type.

Syntax

• Swift
• Objective-C

public var brokerType: FedexfreightshipBrokerTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipBrokerTypes: Int32 {
  case btUnassigned = 0
  case btExport = 1
  case btImport = 2
}

@property (nonatomic,readwrite,assign,getter=brokerType,setter=setBrokerType:) int brokerType;

- (int)brokerType;
- (void)setBrokerType :(int)newBrokerType;

Default Value

0

Remarks

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)

Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

Possible values are:

Note this only applies when shipping internationally.

CarrierType Property (FedExFreightShip Module)

The carrier type.

Syntax

• Swift
• Objective-C

public var carrierType: FedexfreightshipCarrierTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipCarrierTypes: Int32 {
  case ctFDXC = 0
  case ctFDXE = 1
  case ctFDXG = 2
  case ctFXCC = 3
  case ctFXFR = 4
  case ctFXSP = 5
}

@property (nonatomic,readwrite,assign,getter=carrierType,setter=setCarrierType:) int carrierType;

- (int)carrierType;
- (void)setCarrierType :(int)newCarrierType;

Default Value

1

Remarks

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

The possible values are as follows:

ClearanceBrokerageType Property (FedExFreightShip Module)

Specifies the type of brokerage to be applied to a shipment.

Syntax

• Swift
• Objective-C

public var clearanceBrokerageType: FedexfreightshipClearanceBrokerageTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipClearanceBrokerageTypes: Int32 {
  case cbUnassigned = 0
  case cbInclusive = 1
  case cbInclusiveNonResidentImporter = 2
  case cbSelect = 3
  case cbSelectNonResidentImporter = 4
}

@property (nonatomic,readwrite,assign,getter=clearanceBrokerageType,setter=setClearanceBrokerageType:) int clearanceBrokerageType;

- (int)clearanceBrokerageType;
- (void)setClearanceBrokerageType :(int)newClearanceBrokerageType;

Default Value

0

Remarks

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)

Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

Possible values are:

Note this only applies when shipping internationally.

CODLabel Property (FedExFreightShip Module)

The label that is returned.

Syntax

• Swift
• Objective-C

public var codLabel: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=CODLabel) NSString* CODLabel;

- (NSString*)CODLabel;

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 (FedExFreightShip Module)

The file the COD label should be written to.

Syntax

• Swift
• Objective-C

public var codLabelFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=CODLabelFile,setter=setCODLabelFile:) NSString* CODLabelFile;

- (NSString*)CODLabelFile;
- (void)setCODLabelFile :(NSString*)newCODLabelFile;

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 (FedExFreightShip Module)

The total amount to be collected on delivery.

Syntax

• Swift
• Objective-C

public var codTotalAmount: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=CODTotalAmount,setter=setCODTotalAmount:) NSString* CODTotalAmount;

- (NSString*)CODTotalAmount;
- (void)setCODTotalAmount :(NSString*)newCODTotalAmount;

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 PackagesCODAmount and the corresponding flag of COD is contained in the PackagesSpecialServices field.

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

CODTrackingNumber Property (FedExFreightShip Module)

Contains the tracking number for the COD return shipment.

Syntax

• Swift
• Objective-C

public var codTrackingNumber: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=CODTrackingNumber) NSString* CODTrackingNumber;

- (NSString*)CODTrackingNumber;

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 (FedExFreightShip Module)

COD type.

Syntax

• Swift
• Objective-C

public var codType: FedexfreightshipCODTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipCODTypes: Int32 {
  case codtAny = 0
  case codtCash = 1
  case codtGuaranteedFunds = 2
  case codtCompanyCheck = 3
  case codtPersonalCheck = 4
}

@property (nonatomic,readwrite,assign,getter=CODType,setter=setCODType:) int CODType;

- (int)CODType;
- (void)setCODType :(int)newCODType;

Default Value

0

Remarks

This property 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:

CommercialInvoice Property (FedExFreightShip Module)

Contains the collection of commercial Invoice (CI) details.

Syntax

• Swift
• Objective-C

public var commercialInvoice: CommercialInvoiceDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=commercialInvoiceComments,setter=setCommercialInvoiceComments:) NSString* commercialInvoiceComments;

- (NSString*)commercialInvoiceComments;
- (void)setCommercialInvoiceComments :(NSString*)newCommercialInvoiceComments;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceFreightCharge,setter=setCommercialInvoiceFreightCharge:) NSString* commercialInvoiceFreightCharge;

- (NSString*)commercialInvoiceFreightCharge;
- (void)setCommercialInvoiceFreightCharge :(NSString*)newCommercialInvoiceFreightCharge;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceInsurance,setter=setCommercialInvoiceInsurance:) NSString* commercialInvoiceInsurance;

- (NSString*)commercialInvoiceInsurance;
- (void)setCommercialInvoiceInsurance :(NSString*)newCommercialInvoiceInsurance;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceNumber,setter=setCommercialInvoiceNumber:) NSString* commercialInvoiceNumber;

- (NSString*)commercialInvoiceNumber;
- (void)setCommercialInvoiceNumber :(NSString*)newCommercialInvoiceNumber;

@property (nonatomic,readwrite,assign,getter=commercialInvoicePurpose,setter=setCommercialInvoicePurpose:) int commercialInvoicePurpose;

- (int)commercialInvoicePurpose;
- (void)setCommercialInvoicePurpose :(int)newCommercialInvoicePurpose;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceTerms,setter=setCommercialInvoiceTerms:) int commercialInvoiceTerms;

- (int)commercialInvoiceTerms;
- (void)setCommercialInvoiceTerms :(int)newCommercialInvoiceTerms;

 

Default Value

""

Remarks

This is applicable only to international shipments that contain non-documents.

Commercial Invoice is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through FedEx System. Customers are responsible for printing their own Commercial Invoice. Commercial Invoice support consists of a maximum of 99 commodity line items.

This must be set to an instance of the CommercialInvoiceDetail type, which will contain specific information about the commercial invoice that should associate an international shipment. See the CommercialInvoiceDetail type for more information.

Note this only applies when shipping internationally.

Commodities Property (FedExFreightShip Module)

Collection of commodity line items in the fright shipment.

Syntax

• Swift
• Objective-C

public var commodities: Array<FreightCommodityDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=commodityCount,setter=setCommodityCount:) int commodityCount;

- (int)commodityCount;
- (void)setCommodityCount :(int)newCommodityCount;

- (NSString*)commodityDescription:(int)commodityIdx;
- (void)setCommodityDescription:(int)commodityIdx :(NSString*)newCommodityDescription;

- (int)commodityFreightClass:(int)commodityIdx;
- (void)setCommodityFreightClass:(int)commodityIdx :(int)newCommodityFreightClass;

- (int)commodityFreightPackagingType:(int)commodityIdx;
- (void)setCommodityFreightPackagingType:(int)commodityIdx :(int)newCommodityFreightPackagingType;

- (int)commodityHandlingUnits:(int)commodityIdx;
- (void)setCommodityHandlingUnits:(int)commodityIdx :(int)newCommodityHandlingUnits;

- (NSString*)commodityHarmonizedCode:(int)commodityIdx;
- (void)setCommodityHarmonizedCode:(int)commodityIdx :(NSString*)newCommodityHarmonizedCode;

- (int)commodityHazardousMaterialsOptions:(int)commodityIdx;
- (void)setCommodityHazardousMaterialsOptions:(int)commodityIdx :(int)newCommodityHazardousMaterialsOptions;

- (int)commodityHeight:(int)commodityIdx;
- (void)setCommodityHeight:(int)commodityIdx :(int)newCommodityHeight;

- (NSString*)commodityId:(int)commodityIdx;
- (void)setCommodityId:(int)commodityIdx :(NSString*)newCommodityId;

- (int)commodityLength:(int)commodityIdx;
- (void)setCommodityLength:(int)commodityIdx :(int)newCommodityLength;

- (NSString*)commodityManufacturer:(int)commodityIdx;
- (void)setCommodityManufacturer:(int)commodityIdx :(NSString*)newCommodityManufacturer;

- (NSString*)commodityNmfcCode:(int)commodityIdx;
- (void)setCommodityNmfcCode:(int)commodityIdx :(NSString*)newCommodityNmfcCode;

- (int)commodityNumberOfPieces:(int)commodityIdx;
- (void)setCommodityNumberOfPieces:(int)commodityIdx :(int)newCommodityNumberOfPieces;

- (NSString*)commodityPartNumber:(int)commodityIdx;
- (void)setCommodityPartNumber:(int)commodityIdx :(NSString*)newCommodityPartNumber;

- (NSString*)commodityPONumber:(int)commodityIdx;
- (void)setCommodityPONumber:(int)commodityIdx :(NSString*)newCommodityPONumber;

- (int)commodityQuantity:(int)commodityIdx;
- (void)setCommodityQuantity:(int)commodityIdx :(int)newCommodityQuantity;

- (NSString*)commodityQuantityUnit:(int)commodityIdx;
- (void)setCommodityQuantityUnit:(int)commodityIdx :(NSString*)newCommodityQuantityUnit;

- (NSString*)commodityUnitPrice:(int)commodityIdx;
- (void)setCommodityUnitPrice:(int)commodityIdx :(NSString*)newCommodityUnitPrice;

- (NSString*)commodityValue:(int)commodityIdx;
- (void)setCommodityValue:(int)commodityIdx :(NSString*)newCommodityValue;

- (NSString*)commodityVolume:(int)commodityIdx;
- (void)setCommodityVolume:(int)commodityIdx :(NSString*)newCommodityVolume;

- (NSString*)commodityWeight:(int)commodityIdx;
- (void)setCommodityWeight:(int)commodityIdx :(NSString*)newCommodityWeight;

- (int)commodityWidth:(int)commodityIdx;
- (void)setCommodityWidth:(int)commodityIdx :(int)newCommodityWidth;

Default Value

""

Remarks

This contains a collection of the commodity line items required when shipping internationally or when the ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority.

CompanyCloseTime Property (FedExFreightShip Module)

The time your company closes.

Syntax

• Swift
• Objective-C

public var companyCloseTime: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=companyCloseTime,setter=setCompanyCloseTime:) NSString* companyCloseTime;

- (NSString*)companyCloseTime;
- (void)setCompanyCloseTime :(NSString*)newCompanyCloseTime;

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 (FedExFreightShip Module)

Date on which shipment is expected to be delivered.

Syntax

• Swift
• Objective-C

public var deliveryDate: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=deliveryDate) NSString* deliveryDate;

- (NSString*)deliveryDate;

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.

DutiesPayor Property (FedExFreightShip Module)

Identifies how payment of duties for the shipment will be made.

Syntax

• Swift
• Objective-C

public var dutiesPayor: PayorDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=dutiesPayorAccountNumber,setter=setDutiesPayorAccountNumber:) NSString* dutiesPayorAccountNumber;

- (NSString*)dutiesPayorAccountNumber;
- (void)setDutiesPayorAccountNumber :(NSString*)newDutiesPayorAccountNumber;

@property (nonatomic,readwrite,assign,getter=dutiesPayorCountryCode,setter=setDutiesPayorCountryCode:) NSString* dutiesPayorCountryCode;

- (NSString*)dutiesPayorCountryCode;
- (void)setDutiesPayorCountryCode :(NSString*)newDutiesPayorCountryCode;

@property (nonatomic,readwrite,assign,getter=dutiesPayorType,setter=setDutiesPayorType:) int dutiesPayorType;

- (int)dutiesPayorType;
- (void)setDutiesPayorType :(int)newDutiesPayorType;

 

Default Value

""

Remarks

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

Note this only applies when shipping internationally.

FedExAccount Property (FedExFreightShip Module)

Login information for FedEx.

Syntax

• Swift
• Objective-C

public var fedExAccount: FedExAccount {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=fedExAccountNumber,setter=setFedExAccountNumber:) NSString* fedExAccountNumber;

- (NSString*)fedExAccountNumber;
- (void)setFedExAccountNumber :(NSString*)newFedExAccountNumber;

@property (nonatomic,readwrite,assign,getter=fedExAuthorizationToken,setter=setFedExAuthorizationToken:) NSString* fedExAuthorizationToken;

- (NSString*)fedExAuthorizationToken;
- (void)setFedExAuthorizationToken :(NSString*)newFedExAuthorizationToken;

@property (nonatomic,readwrite,assign,getter=fedExLanguageCode,setter=setFedExLanguageCode:) NSString* fedExLanguageCode;

- (NSString*)fedExLanguageCode;
- (void)setFedExLanguageCode :(NSString*)newFedExLanguageCode;

@property (nonatomic,readwrite,assign,getter=fedExLocaleCode,setter=setFedExLocaleCode:) NSString* fedExLocaleCode;

- (NSString*)fedExLocaleCode;
- (void)setFedExLocaleCode :(NSString*)newFedExLocaleCode;

@property (nonatomic,readwrite,assign,getter=fedExServer,setter=setFedExServer:) NSString* fedExServer;

- (NSString*)fedExServer;
- (void)setFedExServer :(NSString*)newFedExServer;

 

Default Value

""

Remarks

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

Firewall Property (FedExFreightShip Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

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

FreightGuarantee Property (FedExFreightShip Module)

Identifies the freight guarantee details.

Syntax

• Swift
• Objective-C

public var freightGuarantee: FreightGuaranteeDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=freightGuaranteeDate,setter=setFreightGuaranteeDate:) NSString* freightGuaranteeDate;

- (NSString*)freightGuaranteeDate;
- (void)setFreightGuaranteeDate :(NSString*)newFreightGuaranteeDate;

@property (nonatomic,readwrite,assign,getter=freightGuaranteeType,setter=setFreightGuaranteeType:) int freightGuaranteeType;

- (int)freightGuaranteeType;
- (void)setFreightGuaranteeType :(int)newFreightGuaranteeType;

 

Default Value

""

Remarks

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

HoldAtLocation Property (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var holdAtLocation: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=holdAtLocationAddress1,setter=setHoldAtLocationAddress1:) NSString* holdAtLocationAddress1;

- (NSString*)holdAtLocationAddress1;
- (void)setHoldAtLocationAddress1 :(NSString*)newHoldAtLocationAddress1;

@property (nonatomic,readwrite,assign,getter=holdAtLocationAddress2,setter=setHoldAtLocationAddress2:) NSString* holdAtLocationAddress2;

- (NSString*)holdAtLocationAddress2;
- (void)setHoldAtLocationAddress2 :(NSString*)newHoldAtLocationAddress2;

@property (nonatomic,readwrite,assign,getter=holdAtLocationCity,setter=setHoldAtLocationCity:) NSString* holdAtLocationCity;

- (NSString*)holdAtLocationCity;
- (void)setHoldAtLocationCity :(NSString*)newHoldAtLocationCity;

@property (nonatomic,readwrite,assign,getter=holdAtLocationCountryCode,setter=setHoldAtLocationCountryCode:) NSString* holdAtLocationCountryCode;

- (NSString*)holdAtLocationCountryCode;
- (void)setHoldAtLocationCountryCode :(NSString*)newHoldAtLocationCountryCode;

@property (nonatomic,readwrite,assign,getter=holdAtLocationState,setter=setHoldAtLocationState:) NSString* holdAtLocationState;

- (NSString*)holdAtLocationState;
- (void)setHoldAtLocationState :(NSString*)newHoldAtLocationState;

@property (nonatomic,readwrite,assign,getter=holdAtLocationZipCode,setter=setHoldAtLocationZipCode:) NSString* holdAtLocationZipCode;

- (NSString*)holdAtLocationZipCode;
- (void)setHoldAtLocationZipCode :(NSString*)newHoldAtLocationZipCode;

 

Default Value

""

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 class 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 class. For US, to find the possible FedEx locations close to the recipient address, you can use the FindLocations method of the FedExAddress class.

This is applicable for FedEx Express services only.

HoldAtLocationContact Property (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var holdAtLocationContact: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=holdAtLocationContactCompany,setter=setHoldAtLocationContactCompany:) NSString* holdAtLocationContactCompany;

- (NSString*)holdAtLocationContactCompany;
- (void)setHoldAtLocationContactCompany :(NSString*)newHoldAtLocationContactCompany;

@property (nonatomic,readwrite,assign,getter=holdAtLocationContactEmail,setter=setHoldAtLocationContactEmail:) NSString* holdAtLocationContactEmail;

- (NSString*)holdAtLocationContactEmail;
- (void)setHoldAtLocationContactEmail :(NSString*)newHoldAtLocationContactEmail;

@property (nonatomic,readwrite,assign,getter=holdAtLocationContactFax,setter=setHoldAtLocationContactFax:) NSString* holdAtLocationContactFax;

- (NSString*)holdAtLocationContactFax;
- (void)setHoldAtLocationContactFax :(NSString*)newHoldAtLocationContactFax;

@property (nonatomic,readwrite,assign,getter=holdAtLocationContactFirstName,setter=setHoldAtLocationContactFirstName:) NSString* holdAtLocationContactFirstName;

- (NSString*)holdAtLocationContactFirstName;
- (void)setHoldAtLocationContactFirstName :(NSString*)newHoldAtLocationContactFirstName;

@property (nonatomic,readwrite,assign,getter=holdAtLocationContactLastName,setter=setHoldAtLocationContactLastName:) NSString* holdAtLocationContactLastName;

- (NSString*)holdAtLocationContactLastName;
- (void)setHoldAtLocationContactLastName :(NSString*)newHoldAtLocationContactLastName;

@property (nonatomic,readwrite,assign,getter=holdAtLocationContactMiddleInitial,setter=setHoldAtLocationContactMiddleInitial:) NSString* holdAtLocationContactMiddleInitial;

- (NSString*)holdAtLocationContactMiddleInitial;
- (void)setHoldAtLocationContactMiddleInitial :(NSString*)newHoldAtLocationContactMiddleInitial;

@property (nonatomic,readwrite,assign,getter=holdAtLocationContactPhone,setter=setHoldAtLocationContactPhone:) NSString* holdAtLocationContactPhone;

- (NSString*)holdAtLocationContactPhone;
- (void)setHoldAtLocationContactPhone :(NSString*)newHoldAtLocationContactPhone;

 

Default Value

""

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 (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var holdAtLocationPhone: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=holdAtLocationPhone,setter=setHoldAtLocationPhone:) NSString* holdAtLocationPhone;

- (NSString*)holdAtLocationPhone;
- (void)setHoldAtLocationPhone :(NSString*)newHoldAtLocationPhone;

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.

InsuredValue Property (FedExFreightShip Module)

Total insured amount.

Syntax

• Swift
• Objective-C

public var insuredValue: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=insuredValue,setter=setInsuredValue:) NSString* insuredValue;

- (NSString*)insuredValue;
- (void)setInsuredValue :(NSString*)newInsuredValue;

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.

When shipping internationally, this cannot exceed the TotalCustomsValue

IntlExportControlledExportType Property (FedExFreightShip Module)

The controlled export type.

Syntax

• Swift
• Objective-C

public var intlExportControlledExportType: FedexfreightshipIntlExportControlledExportTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipIntlExportControlledExportTypes: Int32 {
  case cetDEA036 = 0
  case cetDEA236 = 1
  case cetDEA486 = 2
  case cetDSP05 = 3
  case cetDSP61 = 4
  case cetDSP73 = 5
  case cetDSP85 = 6
  case cetDSP94 = 7
  case cetDSPLicenceAgreement = 8
  case cetFromForeignTradeZone = 9
  case cetWarehouseWithdrawal = 10
}

@property (nonatomic,readwrite,assign,getter=intlExportControlledExportType,setter=setIntlExportControlledExportType:) int intlExportControlledExportType;

- (int)intlExportControlledExportType;
- (void)setIntlExportControlledExportType :(int)newIntlExportControlledExportType;

Default Value

0

Remarks

This specifies the type of permit to be used for shipments that are controlled by the US State Department or the US Drug Enforcement Agency.

This only applies when the ServiceType is stFedExInternationalPriority or stFedExInternationalPriorityFreight.

Note this only applies when shipping internationally.

IntlExportEntryNumber Property (FedExFreightShip Module)

The entry number for the controlled export.

Syntax

• Swift
• Objective-C

public var intlExportEntryNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=intlExportEntryNumber,setter=setIntlExportEntryNumber:) NSString* intlExportEntryNumber;

- (NSString*)intlExportEntryNumber;
- (void)setIntlExportEntryNumber :(NSString*)newIntlExportEntryNumber;

Default Value

""

Remarks

This specifies the entry number for any shipments that are controlled by the US State Department or the US Drug Enforcement Agency.

This only applies when the ServiceType is stFedExInternationalPriority or stFedExInternationalPriorityFreight.

Note this only applies when shipping internationally.

IntlExportForeignTradeZoneCode Property (FedExFreightShip Module)

The foreign trade zone code.

Syntax

• Swift
• Objective-C

public var intlExportForeignTradeZoneCode: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=intlExportForeignTradeZoneCode,setter=setIntlExportForeignTradeZoneCode:) NSString* intlExportForeignTradeZoneCode;

- (NSString*)intlExportForeignTradeZoneCode;
- (void)setIntlExportForeignTradeZoneCode :(NSString*)newIntlExportForeignTradeZoneCode;

Default Value

""

Remarks

This specifies the trade zone for shipments that are controlled by the US State Department or the US Drug Enforcement Agency.

This only applies when the ServiceType is stFedExInternationalPriority or stFedExInternationalPriorityFreight.

Note this only applies when shipping internationally.

IntlExportLicenseNumber Property (FedExFreightShip Module)

The license or permit number.

Syntax

• Swift
• Objective-C

public var intlExportLicenseNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=intlExportLicenseNumber,setter=setIntlExportLicenseNumber:) NSString* intlExportLicenseNumber;

- (NSString*)intlExportLicenseNumber;
- (void)setIntlExportLicenseNumber :(NSString*)newIntlExportLicenseNumber;

Default Value

""

Remarks

This should be set to the license or permit number to be used when the International Controlled Export option (0x00010000L) or International Traffic in arms Regulations option (0x10000000000L) is selected in the ShipmentSpecialServices

Note this only applies when shipping internationally.

IntlExportLicenseNumberExpiration Property (FedExFreightShip Module)

The license or permit number expiration date.

Syntax

• Swift
• Objective-C

public var intlExportLicenseNumberExpiration: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=intlExportLicenseNumberExpiration,setter=setIntlExportLicenseNumberExpiration:) NSString* intlExportLicenseNumberExpiration;

- (NSString*)intlExportLicenseNumberExpiration;
- (void)setIntlExportLicenseNumberExpiration :(NSString*)newIntlExportLicenseNumberExpiration;

Default Value

""

Remarks

This should be set to the expiration date for the license or permit to be used when the International Controlled Export option (0x00010000L) is selected in the ShipmentSpecialServices

Note this only applies when shipping internationally.

LabelImageType Property (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var labelImageType: FedexfreightshipLabelImageTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipLabelImageTypes: Int32 {
  case fitPDF = 0
  case fitPNG = 1
  case fitEltron = 2
  case fitZebra = 3
  case fitUniMark = 4
}

@property (nonatomic,readwrite,assign,getter=labelImageType,setter=setLabelImageType:) int labelImageType;

- (int)labelImageType;
- (void)setLabelImageType :(int)newLabelImageType;

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 class will request a 4x6 label.

Location Property (FedExFreightShip Module)

The FedEx location identifier that received the express dispatch request.

Syntax

• Swift
• Objective-C

public var location: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=location,setter=setLocation:) NSString* location;

- (NSString*)location;
- (void)setLocation :(NSString*)newLocation;

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.

MasterTrackingNumber Property (FedExFreightShip Module)

Tracking number assigned to the whole MPS shipment.

Syntax

• Swift
• Objective-C

public var masterTrackingNumber: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=masterTrackingNumber) NSString* masterTrackingNumber;

- (NSString*)masterTrackingNumber;

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 (FedExFreightShip Module)

Collection of recipients to get notified.

Syntax

• Swift
• Objective-C

public var notify: Array<NotifyDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=notifyCount,setter=setNotifyCount:) int notifyCount;

- (int)notifyCount;
- (void)setNotifyCount :(int)newNotifyCount;

- (NSString*)notifyAggregate:(int)notifyIdx;
- (void)setNotifyAggregate:(int)notifyIdx :(NSString*)newNotifyAggregate;

- (NSString*)notifyEmail:(int)notifyIdx;
- (void)setNotifyEmail:(int)notifyIdx :(NSString*)newNotifyEmail;

- (NSString*)notifyMessage:(int)notifyIdx;
- (void)setNotifyMessage:(int)notifyIdx :(NSString*)newNotifyMessage;

- (NSString*)notifyName:(int)notifyIdx;
- (void)setNotifyName:(int)notifyIdx :(NSString*)newNotifyName;

- (int)notifyFlags:(int)notifyIdx;
- (void)setNotifyFlags:(int)notifyIdx :(int)newNotifyFlags;

- (int)notifyType:(int)notifyIdx;
- (void)setNotifyType:(int)notifyIdx :(int)newNotifyType;

Default Value

""

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 (required), (optional), (optional), and (optional).

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

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

class.Email(0) = "test@test.com" class.RecipientType(0) = RT_SHIPPER class.NotificationFlags(0) = (0x08 | 0x20); // (NOTIFY_FLAG_DELIVERY | NOTIFY_FLAG_HTML)

PackageLocation Property (FedExFreightShip Module)

The location of pickup.

Syntax

• Swift
• Objective-C

public var packageLocation: FedexfreightshipPackageLocations {
  get {...}
  set {...}
}

public enum FedexfreightshipPackageLocations: Int32 {
  case plNone = 0
  case plFront = 1
  case plSide = 2
  case plRear = 3
}

@property (nonatomic,readwrite,assign,getter=packageLocation,setter=setPackageLocation:) int packageLocation;

- (int)packageLocation;
- (void)setPackageLocation :(int)newPackageLocation;

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 (FedExFreightShip Module)

A collection of packages contained in the shipment.

Syntax

• Swift
• Objective-C

public var packages: Array<PackageDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=packageCount,setter=setPackageCount:) int packageCount;

- (int)packageCount;
- (void)setPackageCount :(int)newPackageCount;

- (NSString*)packageBaseCharge:(int)packageIdx;

- (BOOL)packageDangerousGoodsAccessible:(int)packageIdx;
- (void)setPackageDangerousGoodsAccessible:(int)packageIdx :(BOOL)newPackageDangerousGoodsAccessible;

- (int)packageDangerousGoodsOptions:(int)packageIdx;
- (void)setPackageDangerousGoodsOptions:(int)packageIdx :(int)newPackageDangerousGoodsOptions;

- (NSString*)packageDescription:(int)packageIdx;
- (void)setPackageDescription:(int)packageIdx :(NSString*)newPackageDescription;

- (int)packageHeight:(int)packageIdx;
- (void)setPackageHeight:(int)packageIdx :(int)newPackageHeight;

- (NSString*)packageId:(int)packageIdx;
- (void)setPackageId:(int)packageIdx :(NSString*)newPackageId;

- (NSString*)packageInsuredValue:(int)packageIdx;
- (void)setPackageInsuredValue:(int)packageIdx :(NSString*)newPackageInsuredValue;

- (int)packageLength:(int)packageIdx;
- (void)setPackageLength:(int)packageIdx :(int)newPackageLength;

- (NSString*)packageNetCharge:(int)packageIdx;
- (void)setPackageNetCharge:(int)packageIdx :(NSString*)newPackageNetCharge;

- (int)packageType:(int)packageIdx;
- (void)setPackageType:(int)packageIdx :(int)newPackageType;

- (NSString*)packageReference:(int)packageIdx;
- (void)setPackageReference:(int)packageIdx :(NSString*)newPackageReference;

- (NSString*)packageShippingLabel:(int)packageIdx;

- (NSData*)packageShippingLabelB:(int)packageIdx;
- (NSString*)packageShippingLabelFile:(int)packageIdx;
- (void)setPackageShippingLabelFile:(int)packageIdx :(NSString*)newPackageShippingLabelFile;

- (int)packageSignatureType:(int)packageIdx;
- (void)setPackageSignatureType:(int)packageIdx :(int)newPackageSignatureType;

- (long long)packageSpecialServices:(int)packageIdx;
- (void)setPackageSpecialServices:(int)packageIdx :(long long)newPackageSpecialServices;

- (NSString*)packageTotalDiscount:(int)packageIdx;

- (NSString*)packageTotalSurcharges:(int)packageIdx;

- (NSString*)packageTrackingNumber:(int)packageIdx;

- (NSString*)packageWeight:(int)packageIdx;
- (void)setPackageWeight:(int)packageIdx :(NSString*)newPackageWeight;

- (int)packageWidth:(int)packageIdx;
- (void)setPackageWidth:(int)packageIdx :(int)newPackageWidth;

Default Value

""

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 PackagesPackagingType and either the PackagesWeight or TotalWeight must be specified. The PackagesLength, PackagesWidth, PackagesHeight, PackagesInsuredValue, and PackagesSpecialServices are optional.

Payor Property (FedExFreightShip Module)

Identifies the payor of transportation charges for the requested shipment.

Syntax

• Swift
• Objective-C

public var payor: PayorDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=payorAccountNumber,setter=setPayorAccountNumber:) NSString* payorAccountNumber;

- (NSString*)payorAccountNumber;
- (void)setPayorAccountNumber :(NSString*)newPayorAccountNumber;

@property (nonatomic,readwrite,assign,getter=payorAddress1,setter=setPayorAddress1:) NSString* payorAddress1;

- (NSString*)payorAddress1;
- (void)setPayorAddress1 :(NSString*)newPayorAddress1;

@property (nonatomic,readwrite,assign,getter=payorAddress2,setter=setPayorAddress2:) NSString* payorAddress2;

- (NSString*)payorAddress2;
- (void)setPayorAddress2 :(NSString*)newPayorAddress2;

@property (nonatomic,readwrite,assign,getter=payorCity,setter=setPayorCity:) NSString* payorCity;

- (NSString*)payorCity;
- (void)setPayorCity :(NSString*)newPayorCity;

@property (nonatomic,readwrite,assign,getter=payorCountryCode,setter=setPayorCountryCode:) NSString* payorCountryCode;

- (NSString*)payorCountryCode;
- (void)setPayorCountryCode :(NSString*)newPayorCountryCode;

@property (nonatomic,readwrite,assign,getter=payorName,setter=setPayorName:) NSString* payorName;

- (NSString*)payorName;
- (void)setPayorName :(NSString*)newPayorName;

@property (nonatomic,readwrite,assign,getter=payorType,setter=setPayorType:) int payorType;

- (int)payorType;
- (void)setPayorType :(int)newPayorType;

@property (nonatomic,readwrite,assign,getter=payorState,setter=setPayorState:) NSString* payorState;

- (NSString*)payorState;
- (void)setPayorState :(NSString*)newPayorState;

@property (nonatomic,readwrite,assign,getter=payorZipCode,setter=setPayorZipCode:) NSString* payorZipCode;

- (NSString*)payorZipCode;
- (void)setPayorZipCode :(NSString*)newPayorZipCode;

 

Default Value

""

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.

PickupPaymentType Property (FedExFreightShip Module)

The payment type for the pickup.

Syntax

• Swift
• Objective-C

public var pickupPaymentType: FedexfreightshipPickupPaymentTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipPickupPaymentTypes: Int32 {
  case pptSender = 0
  case pptRecipient = 1
  case pptThirdParty = 2
  case pptCollect = 3
  case pptAccount = 4
  case pptCash = 5
  case pptCreditCard = 6
}

@property (nonatomic,readwrite,assign,getter=pickupPaymentType,setter=setPickupPaymentType:) int pickupPaymentType;

- (int)pickupPaymentType;
- (void)setPickupPaymentType :(int)newPickupPaymentType;

Default Value

0

Remarks

This indicates the payment method to be used for a pickup.

Note that if pptCreditCard is selected, FedEx will use the credit card on file with the account associated with the FedExAccountAccountNumber

PickupType Property (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var pickupType: FedexfreightshipPickupTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipPickupTypes: Int32 {
  case fptDropoffAtFedexLocation = 0
  case fptContactFedexToSchedule = 1
  case fptUseScheduledPickup = 2
  case fptOnCall = 3
  case fptPackageReturnProgram = 4
  case fptRegularStop = 5
  case fptTag = 6
  case fptNone = 7
}

@property (nonatomic,readwrite,assign,getter=pickupType,setter=setPickupType:) int pickupType;

- (int)pickupType;
- (void)setPickupType :(int)newPickupType;

Default Value

0

Remarks

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

Valid values are:

Proxy Property (FedExFreightShip Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

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

RecipientAddress Property (FedExFreightShip Module)

Identifies the recipient's address.

Syntax

• Swift
• Objective-C

public var recipientAddress: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recipientAddress1,setter=setRecipientAddress1:) NSString* recipientAddress1;

- (NSString*)recipientAddress1;
- (void)setRecipientAddress1 :(NSString*)newRecipientAddress1;

@property (nonatomic,readwrite,assign,getter=recipientAddress2,setter=setRecipientAddress2:) NSString* recipientAddress2;

- (NSString*)recipientAddress2;
- (void)setRecipientAddress2 :(NSString*)newRecipientAddress2;

@property (nonatomic,readwrite,assign,getter=recipientAddressFlags,setter=setRecipientAddressFlags:) int recipientAddressFlags;

- (int)recipientAddressFlags;
- (void)setRecipientAddressFlags :(int)newRecipientAddressFlags;

@property (nonatomic,readwrite,assign,getter=recipientCity,setter=setRecipientCity:) NSString* recipientCity;

- (NSString*)recipientCity;
- (void)setRecipientCity :(NSString*)newRecipientCity;

@property (nonatomic,readwrite,assign,getter=recipientCountryCode,setter=setRecipientCountryCode:) NSString* recipientCountryCode;

- (NSString*)recipientCountryCode;
- (void)setRecipientCountryCode :(NSString*)newRecipientCountryCode;

@property (nonatomic,readwrite,assign,getter=recipientState,setter=setRecipientState:) NSString* recipientState;

- (NSString*)recipientState;
- (void)setRecipientState :(NSString*)newRecipientState;

@property (nonatomic,readwrite,assign,getter=recipientZipCode,setter=setRecipientZipCode:) NSString* recipientZipCode;

- (NSString*)recipientZipCode;
- (void)setRecipientZipCode :(NSString*)newRecipientZipCode;

 

Default Value

""

Remarks

The Residential flag is required to be set in the RecipientAddressAddressFlags property 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 (FedExFreightShip Module)

Identifies the recipient's contact info.

Syntax

• Swift
• Objective-C

public var recipientContact: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recipientCompany,setter=setRecipientCompany:) NSString* recipientCompany;

- (NSString*)recipientCompany;
- (void)setRecipientCompany :(NSString*)newRecipientCompany;

@property (nonatomic,readwrite,assign,getter=recipientEmail,setter=setRecipientEmail:) NSString* recipientEmail;

- (NSString*)recipientEmail;
- (void)setRecipientEmail :(NSString*)newRecipientEmail;

@property (nonatomic,readwrite,assign,getter=recipientFax,setter=setRecipientFax:) NSString* recipientFax;

- (NSString*)recipientFax;
- (void)setRecipientFax :(NSString*)newRecipientFax;

@property (nonatomic,readwrite,assign,getter=recipientFirstName,setter=setRecipientFirstName:) NSString* recipientFirstName;

- (NSString*)recipientFirstName;
- (void)setRecipientFirstName :(NSString*)newRecipientFirstName;

@property (nonatomic,readwrite,assign,getter=recipientLastName,setter=setRecipientLastName:) NSString* recipientLastName;

- (NSString*)recipientLastName;
- (void)setRecipientLastName :(NSString*)newRecipientLastName;

@property (nonatomic,readwrite,assign,getter=recipientMiddleInitial,setter=setRecipientMiddleInitial:) NSString* recipientMiddleInitial;

- (NSString*)recipientMiddleInitial;
- (void)setRecipientMiddleInitial :(NSString*)newRecipientMiddleInitial;

@property (nonatomic,readwrite,assign,getter=recipientPhone,setter=setRecipientPhone:) NSString* recipientPhone;

- (NSString*)recipientPhone;
- (void)setRecipientPhone :(NSString*)newRecipientPhone;

 

Default Value

""

Remarks

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

When shipping via FedEx Ground, the RecipientContactFirstName, RecipientContactLastName, and RecipientContactCompany 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.

RequestedETDDocuments Property (FedExFreightShip Module)

Specifies which document type to request copies of when using Electronic Trade Document Special Service.

Syntax

• Swift
• Objective-C

public var requestedETDDocuments: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=requestedETDDocuments,setter=setRequestedETDDocuments:) int requestedETDDocuments;

- (int)requestedETDDocuments;
- (void)setRequestedETDDocuments :(int)newRequestedETDDocuments;

Default Value

0

Remarks

This specifies which documents you would like to get copies of when using FedEx Special Services to generate and send the documents electronically (Electronic Trade Documents option is set in the ShipmentSpecialServices). Note that not all customs offices support 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.

Make sure to specify in the ShippingDocumentFile config the location where you want to save the documents.

To request one or more ETD documents be generated by FedEx you will need to set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

Note this only applies when shipping internationally.

ReturnAddress Property (FedExFreightShip Module)

Identifies the return address to be printed on the label.

Syntax

• Swift
• Objective-C

public var returnAddress: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=returnAddress1,setter=setReturnAddress1:) NSString* returnAddress1;

- (NSString*)returnAddress1;
- (void)setReturnAddress1 :(NSString*)newReturnAddress1;

@property (nonatomic,readwrite,assign,getter=returnAddress2,setter=setReturnAddress2:) NSString* returnAddress2;

- (NSString*)returnAddress2;
- (void)setReturnAddress2 :(NSString*)newReturnAddress2;

@property (nonatomic,readwrite,assign,getter=returnAddressFlags,setter=setReturnAddressFlags:) int returnAddressFlags;

- (int)returnAddressFlags;
- (void)setReturnAddressFlags :(int)newReturnAddressFlags;

@property (nonatomic,readwrite,assign,getter=returnCity,setter=setReturnCity:) NSString* returnCity;

- (NSString*)returnCity;
- (void)setReturnCity :(NSString*)newReturnCity;

@property (nonatomic,readwrite,assign,getter=returnCountryCode,setter=setReturnCountryCode:) NSString* returnCountryCode;

- (NSString*)returnCountryCode;
- (void)setReturnCountryCode :(NSString*)newReturnCountryCode;

@property (nonatomic,readwrite,assign,getter=returnState,setter=setReturnState:) NSString* returnState;

- (NSString*)returnState;
- (void)setReturnState :(NSString*)newReturnState;

@property (nonatomic,readwrite,assign,getter=returnZipCode,setter=setReturnZipCode:) NSString* returnZipCode;

- (NSString*)returnZipCode;
- (void)setReturnZipCode :(NSString*)newReturnZipCode;

 

Default Value

""

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 ReturnAddressAddressFlags property 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 (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var returnContact: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=returnCompany,setter=setReturnCompany:) NSString* returnCompany;

- (NSString*)returnCompany;
- (void)setReturnCompany :(NSString*)newReturnCompany;

@property (nonatomic,readwrite,assign,getter=returnEmail,setter=setReturnEmail:) NSString* returnEmail;

- (NSString*)returnEmail;
- (void)setReturnEmail :(NSString*)newReturnEmail;

@property (nonatomic,readwrite,assign,getter=returnFax,setter=setReturnFax:) NSString* returnFax;

- (NSString*)returnFax;
- (void)setReturnFax :(NSString*)newReturnFax;

@property (nonatomic,readwrite,assign,getter=returnFirstName,setter=setReturnFirstName:) NSString* returnFirstName;

- (NSString*)returnFirstName;
- (void)setReturnFirstName :(NSString*)newReturnFirstName;

@property (nonatomic,readwrite,assign,getter=returnLastName,setter=setReturnLastName:) NSString* returnLastName;

- (NSString*)returnLastName;
- (void)setReturnLastName :(NSString*)newReturnLastName;

@property (nonatomic,readwrite,assign,getter=returnMiddleInitial,setter=setReturnMiddleInitial:) NSString* returnMiddleInitial;

- (NSString*)returnMiddleInitial;
- (void)setReturnMiddleInitial :(NSString*)newReturnMiddleInitial;

@property (nonatomic,readwrite,assign,getter=returnPhone,setter=setReturnPhone:) NSString* returnPhone;

- (NSString*)returnPhone;
- (void)setReturnPhone :(NSString*)newReturnPhone;

 

Default Value

""

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 (FedExFreightShip Module)

Identifies the sender's address.

Syntax

• Swift
• Objective-C

public var senderAddress: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=senderAddress1,setter=setSenderAddress1:) NSString* senderAddress1;

- (NSString*)senderAddress1;
- (void)setSenderAddress1 :(NSString*)newSenderAddress1;

@property (nonatomic,readwrite,assign,getter=senderAddress2,setter=setSenderAddress2:) NSString* senderAddress2;

- (NSString*)senderAddress2;
- (void)setSenderAddress2 :(NSString*)newSenderAddress2;

@property (nonatomic,readwrite,assign,getter=senderAddressFlags,setter=setSenderAddressFlags:) int senderAddressFlags;

- (int)senderAddressFlags;
- (void)setSenderAddressFlags :(int)newSenderAddressFlags;

@property (nonatomic,readwrite,assign,getter=senderCity,setter=setSenderCity:) NSString* senderCity;

- (NSString*)senderCity;
- (void)setSenderCity :(NSString*)newSenderCity;

@property (nonatomic,readwrite,assign,getter=senderCountryCode,setter=setSenderCountryCode:) NSString* senderCountryCode;

- (NSString*)senderCountryCode;
- (void)setSenderCountryCode :(NSString*)newSenderCountryCode;

@property (nonatomic,readwrite,assign,getter=senderState,setter=setSenderState:) NSString* senderState;

- (NSString*)senderState;
- (void)setSenderState :(NSString*)newSenderState;

@property (nonatomic,readwrite,assign,getter=senderZipCode,setter=setSenderZipCode:) NSString* senderZipCode;

- (NSString*)senderZipCode;
- (void)setSenderZipCode :(NSString*)newSenderZipCode;

 

Default Value

""

Remarks

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

The Residential flag in the SenderAddressAddressFlags property 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 (FedExFreightShip Module)

Identifies the sender's contact info.

Syntax

• Swift
• Objective-C

public var senderContact: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=senderCompany,setter=setSenderCompany:) NSString* senderCompany;

- (NSString*)senderCompany;
- (void)setSenderCompany :(NSString*)newSenderCompany;

@property (nonatomic,readwrite,assign,getter=senderEmail,setter=setSenderEmail:) NSString* senderEmail;

- (NSString*)senderEmail;
- (void)setSenderEmail :(NSString*)newSenderEmail;

@property (nonatomic,readwrite,assign,getter=senderFax,setter=setSenderFax:) NSString* senderFax;

- (NSString*)senderFax;
- (void)setSenderFax :(NSString*)newSenderFax;

@property (nonatomic,readwrite,assign,getter=senderFirstName,setter=setSenderFirstName:) NSString* senderFirstName;

- (NSString*)senderFirstName;
- (void)setSenderFirstName :(NSString*)newSenderFirstName;

@property (nonatomic,readwrite,assign,getter=senderLastName,setter=setSenderLastName:) NSString* senderLastName;

- (NSString*)senderLastName;
- (void)setSenderLastName :(NSString*)newSenderLastName;

@property (nonatomic,readwrite,assign,getter=senderMiddleInitial,setter=setSenderMiddleInitial:) NSString* senderMiddleInitial;

- (NSString*)senderMiddleInitial;
- (void)setSenderMiddleInitial :(NSString*)newSenderMiddleInitial;

@property (nonatomic,readwrite,assign,getter=senderPhone,setter=setSenderPhone:) NSString* senderPhone;

- (NSString*)senderPhone;
- (void)setSenderPhone :(NSString*)newSenderPhone;

 

Default Value

""

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 (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var serviceType: ServiceTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipServiceTypes: Int32 {
  case stUnspecified = 0
  case stFedExPriorityOvernight = 10
  case stFedExStandardOvernight = 11
  case stFedExFirstOvernight = 12
  case stFedEx2Day = 13
  case stFedExExpressSaver = 14
  case stFedExGround = 15
  case stFedExGroundHomeDelivery = 16
  case stFedEx1DayFreight = 17
  case stFedEx2DayFreight = 18
  case stFedEx3DayFreight = 19
  case stFedExInternationalPriority = 20
  case stFedExInternationalEconomy = 21
  case stFedExInternationalFirst = 22
  case stFedExInternationalPriorityFreight = 23
  case stFedExInternationalEconomyFreight = 24
  case stFedExEuropeFirstInternationalPriority = 25
  case stFedExSmartPost = 26
  case stFedEx2DayAM = 27
  case stFedExFirstFreight = 28
  case stFedExInternationalGround = 29
  case stFedExFreightEconomy = 30
  case stFedExFreightPriority = 31
  case stFedExInternationalPriorityExpress = 32
  case stFedExInternationalConnectPlus = 33
  case stUPSFirstClass = 35
  case stUPSPriorityMail = 36
  case stUPSExpeditedMailInnovations = 37
  case stUPSPriorityMailInnovations = 38
  case stUPSEconomyMailInnovations = 39
  case stUPSNextDayAir = 40
  case stUPSExpress = 41
  case stUPS2ndDayAir = 42
  case stUPSGround = 43
  case stUPSWorldwideExpress = 44
  case stUPSWorldwideExpedited = 45
  case stUPSExpedited = 46
  case stUPSStandard = 47
  case stUPS3DaySelect = 48
  case stUPSNextDayAirSaver = 49
  case stUPSSaver = 50
  case stUPSNextDayAirEarlyAM = 51
  case stUPSExpressEarlyAM = 52
  case stUPSWorldwideExpressPlus = 53
  case stUPSExpressPlus = 54
  case stUPS2ndDayAirAM = 55
  case stUPSTodayStandard = 56
  case stUPSTodayCourrier = 57
  case stUPSTodayInterCity = 58
  case stUPSTodayExpress = 59
  case stUPSTodayExpressSaver = 60
  case stUPSWorldwideExpressFreight = 61
  case stUPSSurePostLessThan1LB = 62
  case stUPSSurePost1LBOrGreater = 63
  case stUPSSurePostBPM = 64
  case stUPSSurePostMedia = 65
  case stUSPSExpress = 70
  case stUSPSFirstClass = 71
  case stUSPSPriority = 72
  case stUSPSParcelPost = 73
  case stUSPSBPM = 74
  case stUSPSMedia = 75
  case stUSPSLibrary = 76
  case stUSPSOnline = 77
  case stUSPSGlobalExpress = 78
  case stUSPSParcelSelect = 79
  case stUSPSCriticalMail = 80
  case stUSPSStandardMail = 81
  case stUSPSExpressMailInternational = 82
  case stUSPSFirstClassMailInternational = 83
  case stUSPSPriorityMailInternational = 84
  case stUSPSPriorityExpress = 85
  case stUSPSRetailGround = 86
  case stUSPSFirstClassPackageInternationalService = 87
  case stUSPSPriorityMailExpressInternational = 88
  case stCanadaRegularParcel = 90
  case stCanadaExpeditedParcel = 91
  case stCanadaXpresspost = 92
  case stCanadaLibrary = 93
  case stCanadaPriority = 94
  case stCanadaPriorityEnvelopeUSA = 95
  case stCanadaPriorityPakUSA = 96
  case stCanadaPriorityParcelUSA = 97
  case stCanadaXpresspostUSA = 98
  case stCanadaExpeditedParcelUSA = 99
  case stCanadaSmallPacketAirUSA = 100
  case stCanadaTrackedPacketUSA = 101
  case stCanadaTrackedPacketLVMUSA = 102
  case stCanadaPriorityEnvelopeInternational = 103
  case stCanadaPriorityPakInternational = 104
  case stCanadaPriorityParcelInternational = 105
  case stCanadaXpresspostInternational = 106
  case stCanadaSmallPacketAirInternational = 107
  case stCanadaSmallPacketLandInternational = 108
  case stCanadaParcelAirInternational = 109
  case stCanadaParcelLandInternational = 110
  case stCanadaTrackedPacketInternational = 111
  case stFedExSameDay = 126
  case stFedExSameDayCity = 127
  case stFedExSameDayMetroAfternoon = 128
  case stFedExSameDayMetroMorning = 129
  case stFedExSameDayMetroRush = 130
  case stUPSWorldwideEconomyDDU = 131
  case stUPSWorldwideEconomyDDP = 132
  case stUSPSParcelSelectGround = 133
  case stUSPSPriorityMailCubic = 134
  case stUSPSGroundAdvantage = 135
  case stUSPSGroundAdvantageCubic = 136
  case stFedExFirst = 140
  case stFedExPriority = 141
  case stFedExPriorityExpress = 142
  case stFedExPriorityExpressFreight = 143
  case stFedExPriorityFreight = 144
  case stFedExEconomySelect = 145
}

@property (nonatomic,readwrite,assign,getter=serviceType,setter=setServiceType:) int serviceType;

- (int)serviceType;
- (void)setServiceType :(int)newServiceType;

Default Value

0

Remarks

This property is required to be provided in a ship request.

Possible values are:

For all services, the following guidelines apply:

• Packages/skids must wight more than 150 lbs.
• Individual pallets/skids weighing in excess of 2200 lbs or larger than 70" in height, 119" in length, or 80" in width require prior approval by FedEx.
• Service days are Monday through Friday, with Saturday pickup and delivery available to many major markets.

ShipDate Property (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var shipDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipDate,setter=setShipDate:) NSString* shipDate;

- (NSString*)shipDate;
- (void)setShipDate :(NSString*)newShipDate;

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).

ShipmentInfo Property (FedExFreightShip Module)

The shipment info for the freight shipment.

Syntax

• Swift
• Objective-C

public var shipmentInfo: FreightShipmentDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipmentInfoAccountNumber,setter=setShipmentInfoAccountNumber:) NSString* shipmentInfoAccountNumber;

- (NSString*)shipmentInfoAccountNumber;
- (void)setShipmentInfoAccountNumber :(NSString*)newShipmentInfoAccountNumber;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingAccountNumber,setter=setShipmentInfoAlternateBillingAccountNumber:) NSString* shipmentInfoAlternateBillingAccountNumber;

- (NSString*)shipmentInfoAlternateBillingAccountNumber;
- (void)setShipmentInfoAlternateBillingAccountNumber :(NSString*)newShipmentInfoAlternateBillingAccountNumber;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingCity,setter=setShipmentInfoAlternateBillingCity:) NSString* shipmentInfoAlternateBillingCity;

- (NSString*)shipmentInfoAlternateBillingCity;
- (void)setShipmentInfoAlternateBillingCity :(NSString*)newShipmentInfoAlternateBillingCity;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingCompanyName,setter=setShipmentInfoAlternateBillingCompanyName:) NSString* shipmentInfoAlternateBillingCompanyName;

- (NSString*)shipmentInfoAlternateBillingCompanyName;
- (void)setShipmentInfoAlternateBillingCompanyName :(NSString*)newShipmentInfoAlternateBillingCompanyName;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingCountryCode,setter=setShipmentInfoAlternateBillingCountryCode:) NSString* shipmentInfoAlternateBillingCountryCode;

- (NSString*)shipmentInfoAlternateBillingCountryCode;
- (void)setShipmentInfoAlternateBillingCountryCode :(NSString*)newShipmentInfoAlternateBillingCountryCode;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingPersonName,setter=setShipmentInfoAlternateBillingPersonName:) NSString* shipmentInfoAlternateBillingPersonName;

- (NSString*)shipmentInfoAlternateBillingPersonName;
- (void)setShipmentInfoAlternateBillingPersonName :(NSString*)newShipmentInfoAlternateBillingPersonName;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingPhone,setter=setShipmentInfoAlternateBillingPhone:) NSString* shipmentInfoAlternateBillingPhone;

- (NSString*)shipmentInfoAlternateBillingPhone;
- (void)setShipmentInfoAlternateBillingPhone :(NSString*)newShipmentInfoAlternateBillingPhone;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingState,setter=setShipmentInfoAlternateBillingState:) NSString* shipmentInfoAlternateBillingState;

- (NSString*)shipmentInfoAlternateBillingState;
- (void)setShipmentInfoAlternateBillingState :(NSString*)newShipmentInfoAlternateBillingState;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingStreetAddress,setter=setShipmentInfoAlternateBillingStreetAddress:) NSString* shipmentInfoAlternateBillingStreetAddress;

- (NSString*)shipmentInfoAlternateBillingStreetAddress;
- (void)setShipmentInfoAlternateBillingStreetAddress :(NSString*)newShipmentInfoAlternateBillingStreetAddress;

@property (nonatomic,readwrite,assign,getter=shipmentInfoAlternateBillingZipCode,setter=setShipmentInfoAlternateBillingZipCode:) NSString* shipmentInfoAlternateBillingZipCode;

- (NSString*)shipmentInfoAlternateBillingZipCode;
- (void)setShipmentInfoAlternateBillingZipCode :(NSString*)newShipmentInfoAlternateBillingZipCode;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingAddress1,setter=setShipmentInfoBillingAddress1:) NSString* shipmentInfoBillingAddress1;

- (NSString*)shipmentInfoBillingAddress1;
- (void)setShipmentInfoBillingAddress1 :(NSString*)newShipmentInfoBillingAddress1;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingAddress2,setter=setShipmentInfoBillingAddress2:) NSString* shipmentInfoBillingAddress2;

- (NSString*)shipmentInfoBillingAddress2;
- (void)setShipmentInfoBillingAddress2 :(NSString*)newShipmentInfoBillingAddress2;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingCity,setter=setShipmentInfoBillingCity:) NSString* shipmentInfoBillingCity;

- (NSString*)shipmentInfoBillingCity;
- (void)setShipmentInfoBillingCity :(NSString*)newShipmentInfoBillingCity;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingCompanyName,setter=setShipmentInfoBillingCompanyName:) NSString* shipmentInfoBillingCompanyName;

- (NSString*)shipmentInfoBillingCompanyName;
- (void)setShipmentInfoBillingCompanyName :(NSString*)newShipmentInfoBillingCompanyName;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingCountryCode,setter=setShipmentInfoBillingCountryCode:) NSString* shipmentInfoBillingCountryCode;

- (NSString*)shipmentInfoBillingCountryCode;
- (void)setShipmentInfoBillingCountryCode :(NSString*)newShipmentInfoBillingCountryCode;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingEmail,setter=setShipmentInfoBillingEmail:) NSString* shipmentInfoBillingEmail;

- (NSString*)shipmentInfoBillingEmail;
- (void)setShipmentInfoBillingEmail :(NSString*)newShipmentInfoBillingEmail;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingFax,setter=setShipmentInfoBillingFax:) NSString* shipmentInfoBillingFax;

- (NSString*)shipmentInfoBillingFax;
- (void)setShipmentInfoBillingFax :(NSString*)newShipmentInfoBillingFax;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingPersonName,setter=setShipmentInfoBillingPersonName:) NSString* shipmentInfoBillingPersonName;

- (NSString*)shipmentInfoBillingPersonName;
- (void)setShipmentInfoBillingPersonName :(NSString*)newShipmentInfoBillingPersonName;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingPhone,setter=setShipmentInfoBillingPhone:) NSString* shipmentInfoBillingPhone;

- (NSString*)shipmentInfoBillingPhone;
- (void)setShipmentInfoBillingPhone :(NSString*)newShipmentInfoBillingPhone;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingState,setter=setShipmentInfoBillingState:) NSString* shipmentInfoBillingState;

- (NSString*)shipmentInfoBillingState;
- (void)setShipmentInfoBillingState :(NSString*)newShipmentInfoBillingState;

@property (nonatomic,readwrite,assign,getter=shipmentInfoBillingZipCode,setter=setShipmentInfoBillingZipCode:) NSString* shipmentInfoBillingZipCode;

- (NSString*)shipmentInfoBillingZipCode;
- (void)setShipmentInfoBillingZipCode :(NSString*)newShipmentInfoBillingZipCode;

@property (nonatomic,readwrite,assign,getter=shipmentInfoClientDiscountPercent,setter=setShipmentInfoClientDiscountPercent:) NSString* shipmentInfoClientDiscountPercent;

- (NSString*)shipmentInfoClientDiscountPercent;
- (void)setShipmentInfoClientDiscountPercent :(NSString*)newShipmentInfoClientDiscountPercent;

@property (nonatomic,readwrite,assign,getter=shipmentInfoCollectTermsType,setter=setShipmentInfoCollectTermsType:) int shipmentInfoCollectTermsType;

- (int)shipmentInfoCollectTermsType;
- (void)setShipmentInfoCollectTermsType :(int)newShipmentInfoCollectTermsType;

@property (nonatomic,readwrite,assign,getter=shipmentInfoComments,setter=setShipmentInfoComments:) NSString* shipmentInfoComments;

- (NSString*)shipmentInfoComments;
- (void)setShipmentInfoComments :(NSString*)newShipmentInfoComments;

@property (nonatomic,readwrite,assign,getter=shipmentInfoCoupons,setter=setShipmentInfoCoupons:) NSString* shipmentInfoCoupons;

- (NSString*)shipmentInfoCoupons;
- (void)setShipmentInfoCoupons :(NSString*)newShipmentInfoCoupons;

@property (nonatomic,readwrite,assign,getter=shipmentInfoDeclaredValue,setter=setShipmentInfoDeclaredValue:) NSString* shipmentInfoDeclaredValue;

- (NSString*)shipmentInfoDeclaredValue;
- (void)setShipmentInfoDeclaredValue :(NSString*)newShipmentInfoDeclaredValue;

@property (nonatomic,readwrite,assign,getter=shipmentInfoDeclaredValueUnits,setter=setShipmentInfoDeclaredValueUnits:) NSString* shipmentInfoDeclaredValueUnits;

- (NSString*)shipmentInfoDeclaredValueUnits;
- (void)setShipmentInfoDeclaredValueUnits :(NSString*)newShipmentInfoDeclaredValueUnits;

@property (nonatomic,readwrite,assign,getter=shipmentInfoEmergencyContactPhone,setter=setShipmentInfoEmergencyContactPhone:) NSString* shipmentInfoEmergencyContactPhone;

- (NSString*)shipmentInfoEmergencyContactPhone;
- (void)setShipmentInfoEmergencyContactPhone :(NSString*)newShipmentInfoEmergencyContactPhone;

@property (nonatomic,readwrite,assign,getter=shipmentInfoHazardousMaterialsOfferor,setter=setShipmentInfoHazardousMaterialsOfferor:) NSString* shipmentInfoHazardousMaterialsOfferor;

- (NSString*)shipmentInfoHazardousMaterialsOfferor;
- (void)setShipmentInfoHazardousMaterialsOfferor :(NSString*)newShipmentInfoHazardousMaterialsOfferor;

@property (nonatomic,readwrite,assign,getter=shipmentInfoLiabilityCoverageAmount,setter=setShipmentInfoLiabilityCoverageAmount:) NSString* shipmentInfoLiabilityCoverageAmount;

- (NSString*)shipmentInfoLiabilityCoverageAmount;
- (void)setShipmentInfoLiabilityCoverageAmount :(NSString*)newShipmentInfoLiabilityCoverageAmount;

@property (nonatomic,readwrite,assign,getter=shipmentInfoLiabilityCoverageType,setter=setShipmentInfoLiabilityCoverageType:) int shipmentInfoLiabilityCoverageType;

- (int)shipmentInfoLiabilityCoverageType;
- (void)setShipmentInfoLiabilityCoverageType :(int)newShipmentInfoLiabilityCoverageType;

@property (nonatomic,readwrite,assign,getter=shipmentInfoPalletWeight,setter=setShipmentInfoPalletWeight:) NSString* shipmentInfoPalletWeight;

- (NSString*)shipmentInfoPalletWeight;
- (void)setShipmentInfoPalletWeight :(NSString*)newShipmentInfoPalletWeight;

@property (nonatomic,readwrite,assign,getter=shipmentInfoRole,setter=setShipmentInfoRole:) int shipmentInfoRole;

- (int)shipmentInfoRole;
- (void)setShipmentInfoRole :(int)newShipmentInfoRole;

@property (nonatomic,readwrite,assign,getter=shipmentInfoTotalHandlingUnits,setter=setShipmentInfoTotalHandlingUnits:) int shipmentInfoTotalHandlingUnits;

- (int)shipmentInfoTotalHandlingUnits;
- (void)setShipmentInfoTotalHandlingUnits :(int)newShipmentInfoTotalHandlingUnits;

@property (nonatomic,readwrite,assign,getter=shipmentInfoTotalHeight,setter=setShipmentInfoTotalHeight:) int shipmentInfoTotalHeight;

- (int)shipmentInfoTotalHeight;
- (void)setShipmentInfoTotalHeight :(int)newShipmentInfoTotalHeight;

@property (nonatomic,readwrite,assign,getter=shipmentInfoTotalLength,setter=setShipmentInfoTotalLength:) int shipmentInfoTotalLength;

- (int)shipmentInfoTotalLength;
- (void)setShipmentInfoTotalLength :(int)newShipmentInfoTotalLength;

@property (nonatomic,readwrite,assign,getter=shipmentInfoTotalWidth,setter=setShipmentInfoTotalWidth:) int shipmentInfoTotalWidth;

- (int)shipmentInfoTotalWidth;
- (void)setShipmentInfoTotalWidth :(int)newShipmentInfoTotalWidth;

 

Default Value

""

Remarks

This contains the details required to be sent when the ServiceType is set to either stFedExFreightEconomy or stFedExFeightPriority. When set, Commodities must also be set. The following properties are required to be set:

• ShipmentInfoAccountNumber
• ShipmentInfoBillingAddress1
• ShipmentInfoBillingCity
• ShipmentInfoBillingState
• ShipmentInfoBillingZipCode
• ShipmentInfoBillingCountryCode
• ShipmentInfoCollectTermsType
• ShipmentInfoRole
• ShipmentInfoTotalHandlingUnits

ShipmentSpecialServices Property (FedExFreightShip Module)

Contains the collection of special services offered by FedEx.

Syntax

• Swift
• Objective-C

public var shipmentSpecialServices: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipmentSpecialServices,setter=setShipmentSpecialServices:) long long shipmentSpecialServices;

- (long long)shipmentSpecialServices;
- (void)setShipmentSpecialServices :(long long)newShipmentSpecialServices;

Default Value

0

Remarks

To request any of the special services offered by FedEx, you must set the ShipmentSpecialServices to a set of flags as listed below, the following flags can be or-ed together in order to select multiple options:

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

• 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. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.

• COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. When set, the CODTotalAmount and CODType properties must be set. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx Freight Economy, and FedEx Freight Priority.
• Dangerous Goods: Indicates that the shipment contains dangerous goods. This service will affect shipping rates and service availability. When set, at least one CommoditiesHazardousMaterialsOptions must be selected and the ShipmentInfoEmergencyContactPhone must be set Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
• Do Not Break Down Pallets: Indicates that the pallets should not be broken down. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
• Do Not Stack Pallets: Indicates that the pallets should not be stacked. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.
• Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
• 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. Note: This is only valid for FedEx International Economy Freight and FedEx International Priority Freight.

• 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. Note that this is only valid for FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
• Extreme Length: This indicates that the pallet is longer than typically allowed. This requires prior clearance with FedEx.
• Food: This indicates that the shipment contains food items. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
• Freight Guarantee: This indicates that the freight shipment is guaranteed for a specific date and time. When set, the FreightGuarantee property should be set. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
• Hold At Location: 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, or when RecipientAddressAddressFlags is set to Residential (i.e., for residential delivery). When this service is requested HoldAtLocation is required to be provided in the request as well. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Economy Freight, and FedEx International Priority Freight.
• 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. Contact FedEx for current surcharge rates. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
• 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. Contact FedEx for current surcharge rates. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx First Overnight Freight, FedEx Freight Economy, and FedEx Freight Priority.
• 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. When set, the IntlExportControlledExportType, IntlExportEntryNumber, IntlExportForeignTradeZoneCode, and IntlExportLicenseNumberExpiration properties should be set. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
• 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. When set, the IntlExportControlledExportType, IntlExportEntryNumber, IntlExportForeignTradeZoneCode, and IntlExportLicenseNumberExpiration properties should be set. Note that this is only valid for FedEx International Economy Freight and FedEx International Priority Freight.
• Liftgate Delivery: This indicates that the liftgate delivery service is requested for this shipment. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
• Liftgate Pickup: This indicates that the liftgate pickup service is requested for this shipment. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
• Poison: This indicates that the shipment contains poisonous materials. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
• Protection From Freezing: This indicates that the shipment should be protected from freezing. Note that this is only valid for FedEx Freight Economy and FedEx Freight Priority.
• Saturday Delivery: Requests the shipment be delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and Saturday delivery is desired, the ground option and some express option will not be valid. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx International Priority Freight, and FedEx Freight Priority.
• Saturday Pickup: Requests that the shipment be picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. 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 Saturday pickup is desired, the ground option and some express option will not be valid. Note this is only valid for FedEx 1Day Freight, FedEx 2Day Freight, FedEx First Overnight Freight, FedEx International Priority Freight, FedEx Freight Economy, and FedEx Freight Priority.
• Top Load: This indicates that the pallets in this shipment should not have anything stacked on top of them. This might affect the shipping rates and/or service availability. Note this is only valid for FedEx Freight Economy, and FedEx Freight Priority.

SSLAcceptServerCertEncoded Property (FedExFreightShip Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (FedExFreightShip Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (FedExFreightShip Module)

This is the name of the certificate store for the client certificate.

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

SSLCertStorePassword Property (FedExFreightShip Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

SSLCertStoreType Property (FedExFreightShip Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: FedexfreightshipSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

SSLCertSubject Property (FedExFreightShip Module)

This is the subject of the certificate used for client authentication.

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (FedExFreightShip Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: FedexfreightshipSSLProviders {
  get {...}
  set {...}
}

public enum FedexfreightshipSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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 class 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 class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (FedExFreightShip Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

SubmittedBy Property (FedExFreightShip Module)

Identifies the person who submitted the pickup request.

Syntax

• Swift
• Objective-C

public var submittedBy: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=submittedByCompany,setter=setSubmittedByCompany:) NSString* submittedByCompany;

- (NSString*)submittedByCompany;
- (void)setSubmittedByCompany :(NSString*)newSubmittedByCompany;

@property (nonatomic,readwrite,assign,getter=submittedByEmail,setter=setSubmittedByEmail:) NSString* submittedByEmail;

- (NSString*)submittedByEmail;
- (void)setSubmittedByEmail :(NSString*)newSubmittedByEmail;

@property (nonatomic,readwrite,assign,getter=submittedByFax,setter=setSubmittedByFax:) NSString* submittedByFax;

- (NSString*)submittedByFax;
- (void)setSubmittedByFax :(NSString*)newSubmittedByFax;

@property (nonatomic,readwrite,assign,getter=submittedByFirstName,setter=setSubmittedByFirstName:) NSString* submittedByFirstName;

- (NSString*)submittedByFirstName;
- (void)setSubmittedByFirstName :(NSString*)newSubmittedByFirstName;

@property (nonatomic,readwrite,assign,getter=submittedByLastName,setter=setSubmittedByLastName:) NSString* submittedByLastName;

- (NSString*)submittedByLastName;
- (void)setSubmittedByLastName :(NSString*)newSubmittedByLastName;

@property (nonatomic,readwrite,assign,getter=submittedByMiddleInitial,setter=setSubmittedByMiddleInitial:) NSString* submittedByMiddleInitial;

- (NSString*)submittedByMiddleInitial;
- (void)setSubmittedByMiddleInitial :(NSString*)newSubmittedByMiddleInitial;

@property (nonatomic,readwrite,assign,getter=submittedByPhone,setter=setSubmittedByPhone:) NSString* submittedByPhone;

- (NSString*)submittedByPhone;
- (void)setSubmittedByPhone :(NSString*)newSubmittedByPhone;

 

Default Value

""

Remarks

This is only required when calling SchedulePickup and the ServiceType is either stFedExFreightEconomy or stFedExFreightPriority.

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.

Timeout Property (FedExFreightShip Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 class will wait for the operation to complete before returning control.

The class 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 class .

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.

TotalCustomsValue Property (FedExFreightShip Module)

Total customs value for the shipment.

Syntax

• Swift
• Objective-C

public var totalCustomsValue: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=totalCustomsValue,setter=setTotalCustomsValue:) NSString* totalCustomsValue;

- (NSString*)totalCustomsValue;
- (void)setTotalCustomsValue :(NSString*)newTotalCustomsValue;

Default Value

"0.00"

Remarks

The TotalCustomsValue is required to be provided in an international shipment request. It represents the sum of the values of all commodities, and may include freight, miscellaneous, and insurance charges.

Format: Two explicit decimal positions (e.g. 100.00) with a maximum length of 17 including the decimal.

The following countries require a minimum customs value of $1 USD for all shipment, including document shipments:

Note this only applies when shipping internationally.

TotalNetCharge Property (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var totalNetCharge: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=totalNetCharge) NSString* totalNetCharge;

- (NSString*)totalNetCharge;

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 PackagesNetCharge at index=0.

This property is read-only.

TotalWeight Property (FedExFreightShip Module)

Total shipment weight.

Syntax

• Swift
• Objective-C

public var totalWeight: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=totalWeight,setter=setTotalWeight:) NSString* totalWeight;

- (NSString*)totalWeight;
- (void)setTotalWeight :(NSString*)newTotalWeight;

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).

TrailerSize Property (FedExFreightShip Module)

The trailer size.

Syntax

• Swift
• Objective-C

public var trailerSize: FedexfreightshipTrailerSizes {
  get {...}
  set {...}
}

public enum FedexfreightshipTrailerSizes: Int32 {
  case ts28FT = 0
  case ts48FT = 1
  case ts53FT = 2
}

@property (nonatomic,readwrite,assign,getter=trailerSize,setter=setTrailerSize:) int trailerSize;

- (int)trailerSize;
- (void)setTrailerSize :(int)newTrailerSize;

Default Value

0

Remarks

The size of the trailer needed when calling SchedulePickup.

TransitTime Property (FedExFreightShip Module)

Expected number of days in transit from pickup to delivery.

Syntax

• Swift
• Objective-C

public var transitTime: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=transitTime) NSString* transitTime;

- (NSString*)transitTime;

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.

TruckType Property (FedExFreightShip Module)

The type of truck.

Syntax

• Swift
• Objective-C

public var truckType: FedexfreightshipTruckTypes {
  get {...}
  set {...}
}

public enum FedexfreightshipTruckTypes: Int32 {
  case ttDropTrailerAgreement = 0
  case ttLiftgate = 1
  case ttTractorTrailerAccess = 2
}

@property (nonatomic,readwrite,assign,getter=truckType,setter=setTruckType:) int truckType;

- (int)truckType;
- (void)setTruckType :(int)newTruckType;

Default Value

0

Remarks

This indicates the type of truck needed when SchedulePickup is called.

UploadDocumentDetails Property (FedExFreightShip Module)

Collection of documents to be uploaded to FedEx.

Syntax

• Swift
• Objective-C

public var uploadDocumentDetails: Array<UploadDocumentDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=uploadDocumentDetailCount,setter=setUploadDocumentDetailCount:) int uploadDocumentDetailCount;

- (int)uploadDocumentDetailCount;
- (void)setUploadDocumentDetailCount :(int)newUploadDocumentDetailCount;

- (int)uploadDocumentDetailDocType:(int)uploadDocumentDetailIndex;
- (void)setUploadDocumentDetailDocType:(int)uploadDocumentDetailIndex :(int)newUploadDocumentDetailDocType;

- (NSString*)uploadDocumentDetailDocumentId:(int)uploadDocumentDetailIndex;

- (NSString*)uploadDocumentDetailFileContent:(int)uploadDocumentDetailIndex;
- (void)setUploadDocumentDetailFileContent:(int)uploadDocumentDetailIndex :(NSString*)newUploadDocumentDetailFileContent;

- (NSString*)uploadDocumentDetailLocalFileName:(int)uploadDocumentDetailIndex;
- (void)setUploadDocumentDetailLocalFileName:(int)uploadDocumentDetailIndex :(NSString*)newUploadDocumentDetailLocalFileName;

- (BOOL)uploadDocumentDetailShipDocument:(int)uploadDocumentDetailIndex;
- (void)setUploadDocumentDetailShipDocument:(int)uploadDocumentDetailIndex :(BOOL)newUploadDocumentDetailShipDocument;

- (NSString*)uploadDocumentDetailUploadFileName:(int)uploadDocumentDetailIndex;
- (void)setUploadDocumentDetailUploadFileName:(int)uploadDocumentDetailIndex :(NSString*)newUploadDocumentDetailUploadFileName;

Default Value

""

Remarks

This contains a collection of the details of the documents to be uploaded to FedEx when UploadDocuments is called. If the ETD option (0x00000200L) is specified in the ShipmentSpecialServices property, the documents specified will be sent electronically with the shipment.

UploadImageDetails Property (FedExFreightShip Module)

Collection of images to be uploaded to FedEx.

Syntax

• Swift
• Objective-C

public var uploadImageDetails: Array<UploadImageDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=uploadImageDetailCount,setter=setUploadImageDetailCount:) int uploadImageDetailCount;

- (int)uploadImageDetailCount;
- (void)setUploadImageDetailCount :(int)newUploadImageDetailCount;

- (NSString*)uploadImageDetailFileContent:(int)uploadImageDetailIndex;
- (void)setUploadImageDetailFileContent:(int)uploadImageDetailIndex :(NSString*)newUploadImageDetailFileContent;

- (NSString*)uploadImageDetailImageIndex:(int)uploadImageDetailIndex;
- (void)setUploadImageDetailImageIndex:(int)uploadImageDetailIndex :(NSString*)newUploadImageDetailImageIndex;

- (int)uploadImageDetailImageType:(int)uploadImageDetailIndex;
- (void)setUploadImageDetailImageType:(int)uploadImageDetailIndex :(int)newUploadImageDetailImageType;

- (NSString*)uploadImageDetailLocalFileName:(int)uploadImageDetailIndex;
- (void)setUploadImageDetailLocalFileName:(int)uploadImageDetailIndex :(NSString*)newUploadImageDetailLocalFileName;

- (NSString*)uploadImageDetailReference:(int)uploadImageDetailIndex;
- (void)setUploadImageDetailReference:(int)uploadImageDetailIndex :(NSString*)newUploadImageDetailReference;

- (NSString*)uploadImageDetailStatus:(int)uploadImageDetailIndex;

- (NSString*)uploadImageDetailUploadFileName:(int)uploadImageDetailIndex;
- (void)setUploadImageDetailUploadFileName:(int)uploadImageDetailIndex :(NSString*)newUploadImageDetailUploadFileName;

Default Value

""

Remarks

This contains a collection of the details of the images to be uploaded to FedEx when UploadImages is called.

CancelPackage Method (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public func cancelPackage(trackingNumber: String) throws -> Void

- (void)cancelPackage:(NSString*)trackingNumber;

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 PackagesTrackingNumber 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:

• FedExAccountAccountNumber (required)
• SenderAddressCountryCode

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

CancelPickup Method (FedExFreightShip Module)

Cancels a scheduled Pickup request.

Syntax

• Swift
• Objective-C

public func cancelPickup(confirmationNumber: String, reason: String) throws -> String

- (NSString*)cancelPickup:(NSString*)confirmationNumber :(NSString*)reason;

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)
• Reason (required)
• FedExAccountAccountNumber (required)
• SenderContact (required)
• ShipDate (required)
• SpecialInstructions (optional)

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 (FedExFreightShip Module)

Cancels all packages within the shipment.

Syntax

• Swift
• Objective-C

public func cancelShipment(trackingNumber: String) throws -> Void

- (void)cancelShipment:(NSString*)trackingNumber;

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:

• FedExAccountAccountNumber (required)
• SenderAddressCountryCode

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

Config Method (FedExFreightShip Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (FedExFreightShip Module)

Generates a shipping label for the specified package.

Syntax

• Swift
• Objective-C

public func getPackageLabel(index: Int32) throws -> Void

- (void)getPackageLabel:(int)index;

Remarks

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

• FedExAccountAuthorizationToken (required)
• FedExAccountServer (optional)
• FedExAccountAccountNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackagesPackagingType (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)
• DutiesPayor (required for international shipments only)
• Packages (required)
• LabelImageType (required)
• CommercialInvoice (required if Documents is set to False; applicable to international shipments only)
• Commodities (required, regardless of the Documents value; applicable to international shipments only)
• ClearanceBrokerageType (optional)
• BrokerType (optional)
• BrokerContact (optional)
• BrokerAddress (optional)
• Documents (optional)
• BlockVisibility (optional)

In express international shipments, at least one commodity line item has to be included in the request. However, the customer has to print out its own Commercial Invoice (a required document for international shipments). The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the Commodities (required, regardless of the Documents value).

This method fills in the following properties:

• PackagesTrackingNumber for each package included in the shipment;
• PackagesShippingLabel for each package included in the shipment;
• PackagesNetCharge for each package included in the shipment;
• PackagesBaseCharge for each package included in the shipment;
• PackagesTotalDiscount for each package included in the shipment;
• PackagesTotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

GetShipmentLabels Method (FedExFreightShip Module)

Generates a shipping label for all packages in the shipment.

Syntax

• Swift
• Objective-C

public func getShipmentLabels() throws -> Void

- (void)getShipmentLabels;

Remarks

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

• FedExAccountAuthorizationToken (required)
• FedExAccountServer (optional)
• FedExAccountAccountNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackagesPackagingType (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)
• DutiesPayor (required for international shipments only)
• Packages (required)
• LabelImageType (required)
• CommercialInvoice (required if Documents is set to False; applicable to international shipments only)
• Commodities (required, regardless of the Documents value; applicable to international shipments only)
• ClearanceBrokerageType (optional)
• BrokerType (optional)
• BrokerContact (optional)
• BrokerAddress (optional)
• Documents (optional)
• BlockVisibility (optional)

In express international shipments, at least one commodity line item has to be included in the request. However, the customer has to print out its own Commercial Invoice (a required document for international shipments). The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the Commodities (required, regardless of the Documents value).

This method fills in the following properties:

• PackagesTrackingNumber for each package included in the shipment;
• PackagesShippingLabel for each package included in the shipment;
• PackagesNetCharge for each package included in the shipment;
• PackagesBaseCharge for each package included in the shipment;
• PackagesTotalDiscount for each package included in the shipment;
• PackagesTotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

PickupAvailability Method (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public func pickupAvailability() throws -> Void

- (void)pickupAvailability;

Remarks

The PickupAvailability method requires the values for the following properties:

• ServiceType (required)
• CarrierType (required)
• SenderAddressAddress1 (required)
• SenderAddressCity (optional)
• SenderAddressState (optional)
• SenderAddressZipCode (required)
• SenderAddressCountryCode (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 PackagesLength, PackagesWidth, and PackagesHeight.

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)

The PickupAvailability method requires the values for the following properties:

• ServiceType (required)
• SenderAddressAddress1 (required)
• SenderAddressCity (optional)
• SenderAddressState (optional)
• SenderAddressZipCode (required)
• SenderAddressCountryCode (required)
• ShipDate (optional)
• ShipTime (optional)
• CompanyCloseTime (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 PackagesLength, PackagesWidth, and PackagesHeight.

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:

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

ReprintDocuments Method (FedExFreightShip Module)

Reprints the requested document.

Syntax

• Swift
• Objective-C

public func reprintDocuments() throws -> Void

- (void)reprintDocuments;

Remarks

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

Reset Method (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

SchedulePickup Method (FedExFreightShip Module)

This method schedules a courier pickup.

Syntax

• Swift
• Objective-C

public func schedulePickup() throws -> String

- (NSString*)schedulePickup;

Remarks

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

The following properties are applicable:

• ApprovedByCompany (optional)
• ApprovedByEmail (optional)
• ApprovedByFax (optional)
• ApprovedByFirstName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• ApprovedByLastName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• ApprovedByMiddleInitial (optional)
• ApprovedByPhone (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• BookingNumber (required when ServiceType is set to stFedEx1DayFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
• CarrierType (required, should be set to ctFXFR only if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority, otherwise should be set to ctFDXE.)
• CommoditiesFreightPackagingType (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CommoditiesWeight (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CommoditiesHandlingUnits (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CommoditiesPONumber (optional, only applies if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CompanyCloseTime (required)
• PackageLocation (required)
• Packages (optional)
• PackageCount (required if Packages are not provided)
• PickupPaymentType (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientAddressAddress1 (optional)
• RecipientAddressAddress2 (optional)
• RecipientAddressCity(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientAddressState(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientAddressZipCode(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientAddressCountryCode (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• SenderAddressAddress1 (required when UseAccountAddress is false)
• SenderAddressAddress2 (optional)
• SenderAddressCity (required when UseAccountAddress is false)
• SenderAddressState (required when UseAccountAddress is false)
• SenderAddressZipCode (required when UseAccountAddress is false)
• SenderAddressCountryCode (required when UseAccountAddress is false)
• SenderContactCompany (required when UseAccountAddress is false)
• SenderContactEmail (optional)
• SenderContactFax (optional)
• SenderContactFirstName (required when UseAccountAddress is false)
• SenderContactLastName (required when UseAccountAddress is false)
• SenderContactMiddleInitial (optional)
• SenderContactPhone (required when UseAccountAddress is false)
• ServiceType (required)
• ShipDate (required)
• ShipTime (optional)
• SpecialInstructions (optional)
• SubmittedByCompany (optional)
• SubmittedByEmail (optional)
• SubmittedByFax (optional)
• SubmittedByFirstName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• SubmittedByLastName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• SubmittedByMiddleInitial (optional)
• SubmittedByPhone (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• TotalWeight (required)
• TruckType (required when ServiceType is set to an Express Freight type, such as stFedEx1DayFreight, stFedEx2DayFreight, stFedEx3DayFreight, stFedExFirstFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
• TrailerSize (required when ServiceType is set to an Express Freight type, such as stFedEx1DayFreight, stFedEx2DayFreight, stFedEx3DayFreight, stFedExFirstFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
• 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.

UploadDocuments Method (FedExFreightShip Module)

Uploads documents to FedEx.

Syntax

• Swift
• Objective-C

public func uploadDocuments() throws -> Void

- (void)uploadDocuments;

Remarks

When called this will upload any documents specified in UploadDocumentDetails to FedEx.

UploadImages Method (FedExFreightShip Module)

Uploads images to FedEx.

Syntax

• Swift
• Objective-C

public func uploadImages() throws -> Void

- (void)uploadImages;

Remarks

When called this will upload any images specified in UploadImageDetails to FedEx.

Error Event (FedExFreightShip Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

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 (FedExFreightShip Module)

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

Syntax

• Swift
• Objective-C

func onNotification(message: String)

- (void)onNotification:(NSString*)message;

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 (FedExFreightShip Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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 (FedExFreightShip Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

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 properties contained by this type are listed below.

Fields

Constructors

public init()

CommercialInvoiceDetail Type

Represents the commercial invoice (CI) information.

Remarks

This type contains descriptive data identifying the commercial invoice (CI) associating an international shipment that contains non-documents items.

Example: Setting the fields CommercialInvoiceDetail ci = new CommercialInvoiceDetail ci.Comments = "Anything" ci.FreightCharge = "100.00" ci.Insurance = "1000.00" ci.Purpose = CIP_SAMPLE ci.Terms = CIT_FOB_OR_FCA

The fields contained by this type are listed below.

Fields

Constructors

public init()

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

public init()

public init(firstName: , lastName: , phone: )

public init(firstName: , lastName: , phone: , email: )

public init(firstName: , lastName: , phone: , email: , company: )

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 properties contained by this type are listed below.

Fields

Constructors

public init()

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 and the .

Fields

Constructors

public init()

FreightCommodityDetail Type

Represents a single commodity line item.

Remarks

This type contains specific information about a commodity line item included in the shipment. It is used in the international shipping components when either the GetPackageLabel or GetShipmentLabels method is called. For UPS, it is applicable if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

Example: Setting the fields for a commodity line item FreightCommodityDetail commodity = new FreightCommodityDetail(); commodity.Description = "Computer software" commodity.Manufacturer = "US" commodity.Weight = "1.0" commodity.QuantityUnit = "EA" commodity.UnitPrice = "99.99" commodity.HarmonizedCode = "9031.80.90"

The fields contained by this type are listed below.

Fields