FedExFreightShip Class

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

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

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

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

Property List

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


ApprovedBy	Identifies the person the pickup was approved by.
BrokerAddress	Identifies the broker's address.
BrokerContact	Identifies the broker's contact info.
BrokerType	Identifies the broker type.
CarrierType	The carrier type.
ClearanceBrokerageType	Specifies the type of brokerage to be applied to a shipment.
CODLabel	The label that is returned.
CODLabelFile	The file the COD label should be written to.
CODTotalAmount	The total amount to be collected on delivery.
CODTrackingNumber	Contains the tracking number for the COD return shipment.
CODType	COD type.
CommercialInvoice	Contains the collection of commercial Invoice (CI) details.
Commodities	Collection of commodity line items in the fright shipment.
CompanyCloseTime	The time your company closes.
DeliveryDate	Date on which shipment is expected to be delivered.
DutiesPayor	Identifies how payment of duties for the shipment will be made.
FedExAccount	Login information for FedEx.
Firewall	A set of properties related to firewall access.
FreightGuarantee	Identifies the freight guarantee details.
HoldAtLocation	Identifies the FedEx location where you want to have your shipment held for pickup.
HoldAtLocationContact	The contact information for shipment when the Hold At Location service is used.
HoldAtLocationPhone	Phone number of the FedEx location where the shipment will be hold at.
InsuredValue	Total insured amount.
IntlExportControlledExportType	The controlled export type.
IntlExportEntryNumber	The entry number for the controlled export.
IntlExportForeignTradeZoneCode	The foreign trade zone code.
IntlExportLicenseNumber	The license or permit number.
IntlExportLicenseNumberExpiration	The license or permit number expiration date.
LabelImageType	Type of image or printer commands the label is to be formatted in.
Location	The FedEx location identifier that received the express dispatch request.
MasterTrackingNumber	Tracking number assigned to the whole MPS shipment.
Notify	Collection of recipients to get notified.
PackageLocation	The location of pickup.
Packages	A collection of packages contained in the shipment.
Payor	Identifies the payor of transportation charges for the requested shipment.
PickupPaymentType	The payment type for the pickup.
PickupType	Pickup type used for the shipment that rate is requested for.
Proxy	A set of properties related to proxy access.
RecipientAddress	Identifies the recipient's address.
RecipientContact	Identifies the recipient's contact info.
RequestedETDDocuments	Specifies which document type to request copies of when using Electronic Trade Document Special Service.
ReturnAddress	Identifies the return address to be printed on the label.
ReturnContact	Identifies the return contact info to be printed on the label.
SenderAddress	Identifies the sender's address.
SenderContact	Identifies the sender's contact info.
ServiceType	Identifies the FedEx domestic service to use in a ship request.
ShipDate	The date on which the package will be tendered to FedEx.
ShipmentInfo	The shipment info for the freight shipment.
ShipmentSpecialServices	Contains the collection of special services offered by FedEx.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
SubmittedBy	Identifies the person who submitted the pickup request.
Timeout	The timeout for the class.
TotalCustomsValue	Total customs value for the shipment.
TotalNetCharge	The total net charge applied to the whole shipment (specific to the AccountNumber ).
TotalWeight	Total shipment weight.
TrailerSize	The trailer size.
TransitTime	Expected number of days in transit from pickup to delivery.
TruckType	The type of truck.
UploadDocumentDetails	Collection of documents to be uploaded to FedEx.
UploadImageDetails	Collection of images to be uploaded to FedEx.

Method List

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


CancelPackage	Cancels a single package shipment by deleting it from the shipping log.
CancelPickup	Cancels a scheduled Pickup request.
CancelShipment	Cancels all packages within the shipment.
Config	Sets or retrieves a configuration setting.
GetPackageLabel	Generates a shipping label for the specified package.
GetShipmentLabels	Generates a shipping label for all packages in the shipment.
PickupAvailability	Checks the availability of the courier dispatch service for the given address.
ReprintDocuments	Reprints the requested document.
Reset	Resets the internal state of the class and all properties to their default values.
SchedulePickup	This method schedules a courier pickup.
UploadDocuments	Uploads documents to FedEx.
UploadImages	Uploads images to FedEx.

Event List

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


Error	Information about errors during data delivery.
Notification	Notification returned by the server upon successful request (if applicable).
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

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


AdmissibilityPackageType	Identifies the admissibility package type.
B13AFiling	Specifies which option is being exercised by the customer to file the B13A.
BlockVisibility	Whether the visibility of this shipment should be blocked from parties other than shipper/payor.
BookingNumber	Booking confirmation number.
CancelledShipment	Indicates whether the shipment has been cancelled or not.
CODRecipientAddress1	The primary street address of the COD recipient.
CODRecipientAddress2	The secondary street address of the COD recipient.
CODRecipientCity	The city of the COD recipient.
CODRecipientCompany	The company of the COD recipient.
CODRecipientCountryCode	The country code of the COD recipient.
CODRecipientName	The name of the COD recipient.
CODRecipientPhone	The phone number of the COD recipient.
CODRecipientResidential	The residential status of the COD recipient.
CODRecipientState	The state of the COD recipient.
CODRecipientZipCode	The zip code of the COD recipient.
CODReferenceIndicator	The reference information to be added to the COD return label.
CODType	COD type.
CurrencyCode	The currency code associated with the monetary values present in the request.
CustomerImageCount	The number of records in the CustomerImage arrays.
CustomerImageDocumentType[i]	Document type.
CustomerImageId[i]	The Image ID.
CustomerImageProvidedImageType[i]	The provided document image type.
CustomerImageType[i]	Document image type.
CustomerTransactionId	Customer transaction id.
DeclarationStatement	The declarations statement to be sent to the customs office.
DeliveryDay	Day of the week on which shipment is expected to be delivered.
DeliveryInstructions	Delivery instructions.
DocTabContent	Custom DocTab content set by the user when preparing a shipping label.
Documents	Whether an international shipment contains only documents or no documents.
DryIceCount	The number of packages which contain dry ice.
EstimateDelivery	Determines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
ExportCompliance	This is an export compliance statement.
InvoiceSpecialInstructions	Special instructions for commercial invoices.
LabelFormatType	Indicates the type of label to be returned.
LabelOrientationType	Indicates if the top or bottom of the label comes out of the printer.
LabelStockType	Indicates the size of the label and the location of the doc tab if present.
LoadAndCount	Shipper's Load and Count (SLAC) = total shipment pieces.
MaskedData	Specifies which data/sections to be masked on the shipping label.
Overwrite	Determines whether label files will be overwritten.
PackageDocumentFile	The file path for the additional package documents.
PackageDryIceWeight[i]	The weight of the dry ice for each package.
PackageFreightCommodityIds[i]	The Freight Commodity Line Item IDs associated with this package.
PackagePhysicalPackagingType[i]	Additional details about the physical packaging of the item in a FedEx Freight shipment.
PrintedReferenceBillOfLading	Shipper's Bill of Lading number to be printed on the label.
PrintedReferenceConsigneeId	Consignee Id to be printed on the label.
PrintedReferenceShipperId	Shipper Id to be printed on the label.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
RecipientTinNumber	Indicates the corresponding Id number for recipient TIN type.
RecipientTinType	Indicates the type of the recipient tax identification number (TIN).
RegulatoryControlType	Identifies the type of regulatory control.
ReturnDescription	Description for the return.
ReturnType	Identifies the reason for return.
SenderTinNumber	Indicates the corresponding Id number for shipper TIN type.
SenderTinType	Indicates the type of the shipper tax identification number (TIN).
ShipmentRatingAggregate	String representing the rating detail on shipment level.
ShippingDocumentFile	Identifies the location of the document file.
ShippingDocumentImageType	Specifies the image or printer commands format of the shipping document.
ShippingDocumentStockType	Indicates the size of the shipping document and the location of the doc tab if present.
ShippingDocumentTypes	Specifies which document type to get.
ShipTime	Local Time of shipment based on shipper's time zone.
SizeUnit	The dimension unit.
TESTMODE	This configuration setting will allow you to run test transactions.
Warning	Warning message returned by the server.
WeightUnit	Weight unit.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCount	The number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

ApprovedBy Property (FedExFreightShip Class)

Identifies the person the pickup was approved by.

Syntax

DShippingSDKContactDetail* GetApprovedBy();
int SetApprovedBy(DShippingSDKContactDetail* val);

char* dshippingsdk_fedexfreightship_getapprovedbycompany(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbycompany(void* lpObj, const char* lpszApprovedByCompany);

char* dshippingsdk_fedexfreightship_getapprovedbyemail(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyemail(void* lpObj, const char* lpszApprovedByEmail);

char* dshippingsdk_fedexfreightship_getapprovedbyfax(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyfax(void* lpObj, const char* lpszApprovedByFax);

char* dshippingsdk_fedexfreightship_getapprovedbyfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyfirstname(void* lpObj, const char* lpszApprovedByFirstName);

char* dshippingsdk_fedexfreightship_getapprovedbylastname(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbylastname(void* lpObj, const char* lpszApprovedByLastName);

char* dshippingsdk_fedexfreightship_getapprovedbymiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbymiddleinitial(void* lpObj, const char* lpszApprovedByMiddleInitial);

char* dshippingsdk_fedexfreightship_getapprovedbyphone(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyphone(void* lpObj, const char* lpszApprovedByPhone);

QString GetApprovedByCompany();
int SetApprovedByCompany(QString qsApprovedByCompany);

QString GetApprovedByEmail();
int SetApprovedByEmail(QString qsApprovedByEmail);

QString GetApprovedByFax();
int SetApprovedByFax(QString qsApprovedByFax);

QString GetApprovedByFirstName();
int SetApprovedByFirstName(QString qsApprovedByFirstName);

QString GetApprovedByLastName();
int SetApprovedByLastName(QString qsApprovedByLastName);

QString GetApprovedByMiddleInitial();
int SetApprovedByMiddleInitial(QString qsApprovedByMiddleInitial);

QString GetApprovedByPhone();
int SetApprovedByPhone(QString qsApprovedByPhone);

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.

Data Type

DShippingSDKContactDetail

BrokerAddress Property (FedExFreightShip Class)

Identifies the broker's address.

Syntax

DShippingSDKAddressDetail* GetBrokerAddress();
int SetBrokerAddress(DShippingSDKAddressDetail* val);

char* dshippingsdk_fedexfreightship_getbrokeraddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeraddress1(void* lpObj, const char* lpszBrokerAddress1);

char* dshippingsdk_fedexfreightship_getbrokeraddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeraddress2(void* lpObj, const char* lpszBrokerAddress2);

int dshippingsdk_fedexfreightship_getbrokeraddressflags(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeraddressflags(void* lpObj, int iBrokerAddressFlags);

char* dshippingsdk_fedexfreightship_getbrokercity(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokercity(void* lpObj, const char* lpszBrokerCity);

char* dshippingsdk_fedexfreightship_getbrokercountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokercountrycode(void* lpObj, const char* lpszBrokerCountryCode);

char* dshippingsdk_fedexfreightship_getbrokerstate(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerstate(void* lpObj, const char* lpszBrokerState);

char* dshippingsdk_fedexfreightship_getbrokerzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerzipcode(void* lpObj, const char* lpszBrokerZipCode);

QString GetBrokerAddress1();
int SetBrokerAddress1(QString qsBrokerAddress1);

QString GetBrokerAddress2();
int SetBrokerAddress2(QString qsBrokerAddress2);

int GetBrokerAddressFlags();
int SetBrokerAddressFlags(int iBrokerAddressFlags);

QString GetBrokerCity();
int SetBrokerCity(QString qsBrokerCity);

QString GetBrokerCountryCode();
int SetBrokerCountryCode(QString qsBrokerCountryCode);

QString GetBrokerState();
int SetBrokerState(QString qsBrokerState);

QString GetBrokerZipCode();
int SetBrokerZipCode(QString qsBrokerZipCode);

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.

Data Type

DShippingSDKAddressDetail

BrokerContact Property (FedExFreightShip Class)

Identifies the broker's contact info.

Syntax

DShippingSDKContactDetail* GetBrokerContact();
int SetBrokerContact(DShippingSDKContactDetail* val);

char* dshippingsdk_fedexfreightship_getbrokercompany(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokercompany(void* lpObj, const char* lpszBrokerCompany);

char* dshippingsdk_fedexfreightship_getbrokeremail(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeremail(void* lpObj, const char* lpszBrokerEmail);

char* dshippingsdk_fedexfreightship_getbrokerfax(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerfax(void* lpObj, const char* lpszBrokerFax);

char* dshippingsdk_fedexfreightship_getbrokerfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerfirstname(void* lpObj, const char* lpszBrokerFirstName);

char* dshippingsdk_fedexfreightship_getbrokerlastname(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerlastname(void* lpObj, const char* lpszBrokerLastName);

char* dshippingsdk_fedexfreightship_getbrokermiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokermiddleinitial(void* lpObj, const char* lpszBrokerMiddleInitial);

char* dshippingsdk_fedexfreightship_getbrokerphone(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerphone(void* lpObj, const char* lpszBrokerPhone);

QString GetBrokerCompany();
int SetBrokerCompany(QString qsBrokerCompany);

QString GetBrokerEmail();
int SetBrokerEmail(QString qsBrokerEmail);

QString GetBrokerFax();
int SetBrokerFax(QString qsBrokerFax);

QString GetBrokerFirstName();
int SetBrokerFirstName(QString qsBrokerFirstName);

QString GetBrokerLastName();
int SetBrokerLastName(QString qsBrokerLastName);

QString GetBrokerMiddleInitial();
int SetBrokerMiddleInitial(QString qsBrokerMiddleInitial);

QString GetBrokerPhone();
int SetBrokerPhone(QString qsBrokerPhone);

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.

Data Type

DShippingSDKContactDetail

BrokerType Property (FedExFreightShip Class)

Identifies the broker type.

Syntax

ANSI (Cross Platform)
int GetBrokerType();
int SetBrokerType(int iBrokerType);

Unicode (Windows)
INT GetBrokerType();
INT SetBrokerType(INT iBrokerType);

Possible Values

BT_UNASSIGNED(0), 
BT_EXPORT(1), 
BT_IMPORT(2)

int dshippingsdk_fedexfreightship_getbrokertype(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokertype(void* lpObj, int iBrokerType);

int GetBrokerType();
int SetBrokerType(int iBrokerType);

Default Value

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)

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.

Possible values are:


btUnassigned (0)
btExport (1)
btImport (2)

Note this only applies when shipping internationally.

Data Type

Integer

CarrierType Property (FedExFreightShip Class)

The carrier type.

Syntax

ANSI (Cross Platform)
int GetCarrierType();
int SetCarrierType(int iCarrierType);

Unicode (Windows)
INT GetCarrierType();
INT SetCarrierType(INT iCarrierType);

Possible Values

CT_FDXC(0), 
CT_FDXE(1), 
CT_FDXG(2), 
CT_FXCC(3), 
CT_FXFR(4), 
CT_FXSP(5)

int dshippingsdk_fedexfreightship_getcarriertype(void* lpObj);
int dshippingsdk_fedexfreightship_setcarriertype(void* lpObj, int iCarrierType);

int GetCarrierType();
int SetCarrierType(int iCarrierType);

Default Value

Remarks

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

The possible values are as follows:


Value	Description
ctFDXC (0)	FedEx Cargo
ctFDXE (1)	FedEx Express
ctFDXG (2)	FedEx Ground
ctFXCC (3)	FedEx Custom Critical
ctFXFR (4)	FedEx Freight
ctFXSP (5)	FedEx Smart Post

Data Type

Integer

ClearanceBrokerageType Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int GetClearanceBrokerageType();
int SetClearanceBrokerageType(int iClearanceBrokerageType);

Unicode (Windows)
INT GetClearanceBrokerageType();
INT SetClearanceBrokerageType(INT iClearanceBrokerageType);

Possible Values

CB_UNASSIGNED(0), 
CB_INCLUSIVE(1), 
CB_INCLUSIVE_NON_RESIDENT_IMPORTER(2), 
CB_SELECT(3), 
CB_SELECT_NON_RESIDENT_IMPORTER(4)

int dshippingsdk_fedexfreightship_getclearancebrokeragetype(void* lpObj);
int dshippingsdk_fedexfreightship_setclearancebrokeragetype(void* lpObj, int iClearanceBrokerageType);

int GetClearanceBrokerageType();
int SetClearanceBrokerageType(int iClearanceBrokerageType);

Default Value

Remarks

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:


cbUnassigned (0)
cbInclusive (1)
cbInclusiveNonResidentImporter (2)
cbSelect (3)
cbSelectNonResidentImporter (4)

Note this only applies when shipping internationally.

Data Type

Integer

CODLabel Property (FedExFreightShip Class)

The label that is returned.

Syntax

ANSI (Cross Platform)
char* GetCODLabel();

Unicode (Windows)
LPWSTR GetCODLabel();

char* dshippingsdk_fedexfreightship_getcodlabel(void* lpObj);

QString GetCODLabel();

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.

Data Type

String

CODLabelFile Property (FedExFreightShip Class)

The file the COD label should be written to.

Syntax

ANSI (Cross Platform)
char* GetCODLabelFile();
int SetCODLabelFile(const char* lpszCODLabelFile);

Unicode (Windows)
LPWSTR GetCODLabelFile();
INT SetCODLabelFile(LPCWSTR lpszCODLabelFile);

char* dshippingsdk_fedexfreightship_getcodlabelfile(void* lpObj);
int dshippingsdk_fedexfreightship_setcodlabelfile(void* lpObj, const char* lpszCODLabelFile);

QString GetCODLabelFile();
int SetCODLabelFile(QString qsCODLabelFile);

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.

Data Type

String

CODTotalAmount Property (FedExFreightShip Class)

The total amount to be collected on delivery.

Syntax

ANSI (Cross Platform)
char* GetCODTotalAmount();
int SetCODTotalAmount(const char* lpszCODTotalAmount);

Unicode (Windows)
LPWSTR GetCODTotalAmount();
INT SetCODTotalAmount(LPCWSTR lpszCODTotalAmount);

char* dshippingsdk_fedexfreightship_getcodtotalamount(void* lpObj);
int dshippingsdk_fedexfreightship_setcodtotalamount(void* lpObj, const char* lpszCODTotalAmount);

QString GetCODTotalAmount();
int SetCODTotalAmount(QString qsCODTotalAmount);

Default Value

Remarks

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

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

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

Data Type

String

CODTrackingNumber Property (FedExFreightShip Class)

Contains the tracking number for the COD return shipment.

Syntax

ANSI (Cross Platform)
char* GetCODTrackingNumber();

Unicode (Windows)
LPWSTR GetCODTrackingNumber();

char* dshippingsdk_fedexfreightship_getcodtrackingnumber(void* lpObj);

QString GetCODTrackingNumber();

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.

Data Type

String

CODType Property (FedExFreightShip Class)

COD type.

Syntax

ANSI (Cross Platform)
int GetCODType();
int SetCODType(int iCODType);

Unicode (Windows)
INT GetCODType();
INT SetCODType(INT iCODType);

Possible Values

CODT_ANY(0), 
CODT_CASH(1), 
CODT_GUARANTEED_FUNDS(2), 
CODT_COMPANY_CHECK(3), 
CODT_PERSONAL_CHECK(4)

int dshippingsdk_fedexfreightship_getcodtype(void* lpObj);
int dshippingsdk_fedexfreightship_setcodtype(void* lpObj, int iCODType);

int GetCODType();
int SetCODType(int iCODType);

Default Value

Remarks

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

Possible values are as follows:


Value	Description
codtAny (0)	Unsecured form of payment: personal check, certified check, cashier's check, official check, money order, or company check.
codtCash (1)	This is not available on the shipment level
codtGuaranteedFunds (2)	Secured form of payment: cashier's check, official check, or money order.
codtCompanyCheck (3)	Company check
codtPersonalCheck (4)	Personal check

Data Type

Integer

CommercialInvoice Property (FedExFreightShip Class)

Contains the collection of commercial Invoice (CI) details.

Syntax

DShippingSDKCommercialInvoiceDetail* GetCommercialInvoice();
int SetCommercialInvoice(DShippingSDKCommercialInvoiceDetail* val);

char* dshippingsdk_fedexfreightship_getcommercialinvoicecomments(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicecomments(void* lpObj, const char* lpszCommercialInvoiceComments);

char* dshippingsdk_fedexfreightship_getcommercialinvoicefreightcharge(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicefreightcharge(void* lpObj, const char* lpszCommercialInvoiceFreightCharge);

char* dshippingsdk_fedexfreightship_getcommercialinvoiceinsurance(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoiceinsurance(void* lpObj, const char* lpszCommercialInvoiceInsurance);

char* dshippingsdk_fedexfreightship_getcommercialinvoicenumber(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicenumber(void* lpObj, const char* lpszCommercialInvoiceNumber);

int dshippingsdk_fedexfreightship_getcommercialinvoicepurpose(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicepurpose(void* lpObj, int iCommercialInvoicePurpose);

int dshippingsdk_fedexfreightship_getcommercialinvoiceterms(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoiceterms(void* lpObj, int iCommercialInvoiceTerms);

QString GetCommercialInvoiceComments();
int SetCommercialInvoiceComments(QString qsCommercialInvoiceComments);

QString GetCommercialInvoiceFreightCharge();
int SetCommercialInvoiceFreightCharge(QString qsCommercialInvoiceFreightCharge);

QString GetCommercialInvoiceInsurance();
int SetCommercialInvoiceInsurance(QString qsCommercialInvoiceInsurance);

QString GetCommercialInvoiceNumber();
int SetCommercialInvoiceNumber(QString qsCommercialInvoiceNumber);

int GetCommercialInvoicePurpose();
int SetCommercialInvoicePurpose(int iCommercialInvoicePurpose);

int GetCommercialInvoiceTerms();
int SetCommercialInvoiceTerms(int iCommercialInvoiceTerms);

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.

Data Type

DShippingSDKCommercialInvoiceDetail

Commodities Property (FedExFreightShip Class)

Collection of commodity line items in the fright shipment.

Syntax

DShippingSDKList<DShippingSDKFreightCommodityDetail>* GetCommodities();
int SetCommodities(DShippingSDKList<DShippingSDKFreightCommodityDetail>* val);

int dshippingsdk_fedexfreightship_getcommoditycount(void* lpObj);
int dshippingsdk_fedexfreightship_setcommoditycount(void* lpObj, int iCommodityCount);

char* dshippingsdk_fedexfreightship_getcommoditydescription(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommoditydescription(void* lpObj, int commodityidx, const char* lpszCommodityDescription);

int dshippingsdk_fedexfreightship_getcommodityfreightclass(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityfreightclass(void* lpObj, int commodityidx, int iCommodityFreightClass);

int dshippingsdk_fedexfreightship_getcommodityfreightpackagingtype(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityfreightpackagingtype(void* lpObj, int commodityidx, int iCommodityFreightPackagingType);

int dshippingsdk_fedexfreightship_getcommodityhandlingunits(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityhandlingunits(void* lpObj, int commodityidx, int iCommodityHandlingUnits);

char* dshippingsdk_fedexfreightship_getcommodityharmonizedcode(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityharmonizedcode(void* lpObj, int commodityidx, const char* lpszCommodityHarmonizedCode);

int dshippingsdk_fedexfreightship_getcommodityhazardousmaterialsoptions(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityhazardousmaterialsoptions(void* lpObj, int commodityidx, int iCommodityHazardousMaterialsOptions);

int dshippingsdk_fedexfreightship_getcommodityheight(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityheight(void* lpObj, int commodityidx, int iCommodityHeight);

char* dshippingsdk_fedexfreightship_getcommodityid(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityid(void* lpObj, int commodityidx, const char* lpszCommodityId);

int dshippingsdk_fedexfreightship_getcommoditylength(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommoditylength(void* lpObj, int commodityidx, int iCommodityLength);

char* dshippingsdk_fedexfreightship_getcommoditymanufacturer(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommoditymanufacturer(void* lpObj, int commodityidx, const char* lpszCommodityManufacturer);

char* dshippingsdk_fedexfreightship_getcommoditynmfccode(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommoditynmfccode(void* lpObj, int commodityidx, const char* lpszCommodityNmfcCode);

int dshippingsdk_fedexfreightship_getcommoditynumberofpieces(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommoditynumberofpieces(void* lpObj, int commodityidx, int iCommodityNumberOfPieces);

char* dshippingsdk_fedexfreightship_getcommoditypartnumber(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommoditypartnumber(void* lpObj, int commodityidx, const char* lpszCommodityPartNumber);

char* dshippingsdk_fedexfreightship_getcommodityponumber(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityponumber(void* lpObj, int commodityidx, const char* lpszCommodityPONumber);

int dshippingsdk_fedexfreightship_getcommodityquantity(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityquantity(void* lpObj, int commodityidx, int iCommodityQuantity);

char* dshippingsdk_fedexfreightship_getcommodityquantityunit(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityquantityunit(void* lpObj, int commodityidx, const char* lpszCommodityQuantityUnit);

char* dshippingsdk_fedexfreightship_getcommodityunitprice(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityunitprice(void* lpObj, int commodityidx, const char* lpszCommodityUnitPrice);

char* dshippingsdk_fedexfreightship_getcommodityvalue(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityvalue(void* lpObj, int commodityidx, const char* lpszCommodityValue);

char* dshippingsdk_fedexfreightship_getcommodityvolume(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityvolume(void* lpObj, int commodityidx, const char* lpszCommodityVolume);

char* dshippingsdk_fedexfreightship_getcommodityweight(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommodityweight(void* lpObj, int commodityidx, const char* lpszCommodityWeight);

int dshippingsdk_fedexfreightship_getcommoditywidth(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_setcommoditywidth(void* lpObj, int commodityidx, int iCommodityWidth);

int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

QString GetCommodityDescription(int iCommodityIdx);
int SetCommodityDescription(int iCommodityIdx, QString qsCommodityDescription);

int GetCommodityFreightClass(int iCommodityIdx);
int SetCommodityFreightClass(int iCommodityIdx, int iCommodityFreightClass);

int GetCommodityFreightPackagingType(int iCommodityIdx);
int SetCommodityFreightPackagingType(int iCommodityIdx, int iCommodityFreightPackagingType);

int GetCommodityHandlingUnits(int iCommodityIdx);
int SetCommodityHandlingUnits(int iCommodityIdx, int iCommodityHandlingUnits);

QString GetCommodityHarmonizedCode(int iCommodityIdx);
int SetCommodityHarmonizedCode(int iCommodityIdx, QString qsCommodityHarmonizedCode);

int GetCommodityHazardousMaterialsOptions(int iCommodityIdx);
int SetCommodityHazardousMaterialsOptions(int iCommodityIdx, int iCommodityHazardousMaterialsOptions);

int GetCommodityHeight(int iCommodityIdx);
int SetCommodityHeight(int iCommodityIdx, int iCommodityHeight);

QString GetCommodityId(int iCommodityIdx);
int SetCommodityId(int iCommodityIdx, QString qsCommodityId);

int GetCommodityLength(int iCommodityIdx);
int SetCommodityLength(int iCommodityIdx, int iCommodityLength);

QString GetCommodityManufacturer(int iCommodityIdx);
int SetCommodityManufacturer(int iCommodityIdx, QString qsCommodityManufacturer);

QString GetCommodityNmfcCode(int iCommodityIdx);
int SetCommodityNmfcCode(int iCommodityIdx, QString qsCommodityNmfcCode);

int GetCommodityNumberOfPieces(int iCommodityIdx);
int SetCommodityNumberOfPieces(int iCommodityIdx, int iCommodityNumberOfPieces);

QString GetCommodityPartNumber(int iCommodityIdx);
int SetCommodityPartNumber(int iCommodityIdx, QString qsCommodityPartNumber);

QString GetCommodityPONumber(int iCommodityIdx);
int SetCommodityPONumber(int iCommodityIdx, QString qsCommodityPONumber);

int GetCommodityQuantity(int iCommodityIdx);
int SetCommodityQuantity(int iCommodityIdx, int iCommodityQuantity);

QString GetCommodityQuantityUnit(int iCommodityIdx);
int SetCommodityQuantityUnit(int iCommodityIdx, QString qsCommodityQuantityUnit);

QString GetCommodityUnitPrice(int iCommodityIdx);
int SetCommodityUnitPrice(int iCommodityIdx, QString qsCommodityUnitPrice);

QString GetCommodityValue(int iCommodityIdx);
int SetCommodityValue(int iCommodityIdx, QString qsCommodityValue);

QString GetCommodityVolume(int iCommodityIdx);
int SetCommodityVolume(int iCommodityIdx, QString qsCommodityVolume);

QString GetCommodityWeight(int iCommodityIdx);
int SetCommodityWeight(int iCommodityIdx, QString qsCommodityWeight);

int GetCommodityWidth(int iCommodityIdx);
int SetCommodityWidth(int iCommodityIdx, int iCommodityWidth);

Remarks

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

This property is not available at design time.

Data Type

DShippingSDKFreightCommodityDetail

CompanyCloseTime Property (FedExFreightShip Class)

The time your company closes.

Syntax

ANSI (Cross Platform)
char* GetCompanyCloseTime();
int SetCompanyCloseTime(const char* lpszCompanyCloseTime);

Unicode (Windows)
LPWSTR GetCompanyCloseTime();
INT SetCompanyCloseTime(LPCWSTR lpszCompanyCloseTime);

char* dshippingsdk_fedexfreightship_getcompanyclosetime(void* lpObj);
int dshippingsdk_fedexfreightship_setcompanyclosetime(void* lpObj, const char* lpszCompanyCloseTime);

QString GetCompanyCloseTime();
int SetCompanyCloseTime(QString qsCompanyCloseTime);

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.

Data Type

String

DeliveryDate Property (FedExFreightShip Class)

Date on which shipment is expected to be delivered.

Syntax

ANSI (Cross Platform)
char* GetDeliveryDate();

Unicode (Windows)
LPWSTR GetDeliveryDate();

char* dshippingsdk_fedexfreightship_getdeliverydate(void* lpObj);

QString GetDeliveryDate();

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.

Data Type

String

DutiesPayor Property (FedExFreightShip Class)

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

Syntax

DShippingSDKPayorDetail* GetDutiesPayor();
int SetDutiesPayor(DShippingSDKPayorDetail* val);

char* dshippingsdk_fedexfreightship_getdutiespayoraccountnumber(void* lpObj);
int dshippingsdk_fedexfreightship_setdutiespayoraccountnumber(void* lpObj, const char* lpszDutiesPayorAccountNumber);

char* dshippingsdk_fedexfreightship_getdutiespayorcountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setdutiespayorcountrycode(void* lpObj, const char* lpszDutiesPayorCountryCode);

int dshippingsdk_fedexfreightship_getdutiespayortype(void* lpObj);
int dshippingsdk_fedexfreightship_setdutiespayortype(void* lpObj, int iDutiesPayorType);

QString GetDutiesPayorAccountNumber();
int SetDutiesPayorAccountNumber(QString qsDutiesPayorAccountNumber);

QString GetDutiesPayorCountryCode();
int SetDutiesPayorCountryCode(QString qsDutiesPayorCountryCode);

int GetDutiesPayorType();
int SetDutiesPayorType(int iDutiesPayorType);

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.

Data Type

DShippingSDKPayorDetail

FedExAccount Property (FedExFreightShip Class)

Syntax

DShippingSDKFedExAccount* GetFedExAccount();
int SetFedExAccount(DShippingSDKFedExAccount* val);

char* dshippingsdk_fedexfreightship_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedexfreightship_setfedexaccountnumber(void* lpObj, const char* lpszFedExAccountNumber);

char* dshippingsdk_fedexfreightship_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedexfreightship_setfedexauthorizationtoken(void* lpObj, const char* lpszFedExAuthorizationToken);

char* dshippingsdk_fedexfreightship_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedexfreightship_setfedexlanguagecode(void* lpObj, const char* lpszFedExLanguageCode);

char* dshippingsdk_fedexfreightship_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedexfreightship_setfedexlocalecode(void* lpObj, const char* lpszFedExLocaleCode);

char* dshippingsdk_fedexfreightship_getfedexserver(void* lpObj);
int dshippingsdk_fedexfreightship_setfedexserver(void* lpObj, const char* lpszFedExServer);

QString GetFedExAccountNumber();
int SetFedExAccountNumber(QString qsFedExAccountNumber);

QString GetFedExAuthorizationToken();
int SetFedExAuthorizationToken(QString qsFedExAuthorizationToken);

QString GetFedExLanguageCode();
int SetFedExLanguageCode(QString qsFedExLanguageCode);

QString GetFedExLocaleCode();
int SetFedExLocaleCode(QString qsFedExLocaleCode);

QString GetFedExServer();
int SetFedExServer(QString qsFedExServer);

Remarks

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

Data Type

DShippingSDKFedExAccount

Firewall Property (FedExFreightShip Class)

A set of properties related to firewall access.

Syntax

DShippingSDKFirewall* GetFirewall();
int SetFirewall(DShippingSDKFirewall* val);

int dshippingsdk_fedexfreightship_getfirewallautodetect(void* lpObj);
int dshippingsdk_fedexfreightship_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int dshippingsdk_fedexfreightship_getfirewalltype(void* lpObj);
int dshippingsdk_fedexfreightship_setfirewalltype(void* lpObj, int iFirewallType);

char* dshippingsdk_fedexfreightship_getfirewallhost(void* lpObj);
int dshippingsdk_fedexfreightship_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* dshippingsdk_fedexfreightship_getfirewallpassword(void* lpObj);
int dshippingsdk_fedexfreightship_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int dshippingsdk_fedexfreightship_getfirewallport(void* lpObj);
int dshippingsdk_fedexfreightship_setfirewallport(void* lpObj, int iFirewallPort);

char* dshippingsdk_fedexfreightship_getfirewalluser(void* lpObj);
int dshippingsdk_fedexfreightship_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

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

Data Type

DShippingSDKFirewall

FreightGuarantee Property (FedExFreightShip Class)

Identifies the freight guarantee details.

Syntax

DShippingSDKFreightGuaranteeDetail* GetFreightGuarantee();
int SetFreightGuarantee(DShippingSDKFreightGuaranteeDetail* val);

char* dshippingsdk_fedexfreightship_getfreightguaranteedate(void* lpObj);
int dshippingsdk_fedexfreightship_setfreightguaranteedate(void* lpObj, const char* lpszFreightGuaranteeDate);

int dshippingsdk_fedexfreightship_getfreightguaranteetype(void* lpObj);
int dshippingsdk_fedexfreightship_setfreightguaranteetype(void* lpObj, int iFreightGuaranteeType);

QString GetFreightGuaranteeDate();
int SetFreightGuaranteeDate(QString qsFreightGuaranteeDate);

int GetFreightGuaranteeType();
int SetFreightGuaranteeType(int iFreightGuaranteeType);

Remarks

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

Data Type

DShippingSDKFreightGuaranteeDetail

HoldAtLocation Property (FedExFreightShip Class)

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

Syntax

DShippingSDKAddressDetail* GetHoldAtLocation();
int SetHoldAtLocation(DShippingSDKAddressDetail* val);

char* dshippingsdk_fedexfreightship_getholdatlocationaddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationaddress1(void* lpObj, const char* lpszHoldAtLocationAddress1);

char* dshippingsdk_fedexfreightship_getholdatlocationaddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationaddress2(void* lpObj, const char* lpszHoldAtLocationAddress2);

char* dshippingsdk_fedexfreightship_getholdatlocationcity(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcity(void* lpObj, const char* lpszHoldAtLocationCity);

char* dshippingsdk_fedexfreightship_getholdatlocationcountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcountrycode(void* lpObj, const char* lpszHoldAtLocationCountryCode);

char* dshippingsdk_fedexfreightship_getholdatlocationstate(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationstate(void* lpObj, const char* lpszHoldAtLocationState);

char* dshippingsdk_fedexfreightship_getholdatlocationzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationzipcode(void* lpObj, const char* lpszHoldAtLocationZipCode);

QString GetHoldAtLocationAddress1();
int SetHoldAtLocationAddress1(QString qsHoldAtLocationAddress1);

QString GetHoldAtLocationAddress2();
int SetHoldAtLocationAddress2(QString qsHoldAtLocationAddress2);

QString GetHoldAtLocationCity();
int SetHoldAtLocationCity(QString qsHoldAtLocationCity);

QString GetHoldAtLocationCountryCode();
int SetHoldAtLocationCountryCode(QString qsHoldAtLocationCountryCode);

QString GetHoldAtLocationState();
int SetHoldAtLocationState(QString qsHoldAtLocationState);

QString GetHoldAtLocationZipCode();
int SetHoldAtLocationZipCode(QString qsHoldAtLocationZipCode);

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.

Data Type

DShippingSDKAddressDetail

HoldAtLocationContact Property (FedExFreightShip Class)

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

Syntax

DShippingSDKContactDetail* GetHoldAtLocationContact();
int SetHoldAtLocationContact(DShippingSDKContactDetail* val);

char* dshippingsdk_fedexfreightship_getholdatlocationcontactcompany(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcontactcompany(void* lpObj, const char* lpszHoldAtLocationContactCompany);

char* dshippingsdk_fedexfreightship_getholdatlocationcontactemail(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcontactemail(void* lpObj, const char* lpszHoldAtLocationContactEmail);

char* dshippingsdk_fedexfreightship_getholdatlocationcontactfax(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcontactfax(void* lpObj, const char* lpszHoldAtLocationContactFax);

char* dshippingsdk_fedexfreightship_getholdatlocationcontactfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcontactfirstname(void* lpObj, const char* lpszHoldAtLocationContactFirstName);

char* dshippingsdk_fedexfreightship_getholdatlocationcontactlastname(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcontactlastname(void* lpObj, const char* lpszHoldAtLocationContactLastName);

char* dshippingsdk_fedexfreightship_getholdatlocationcontactmiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcontactmiddleinitial(void* lpObj, const char* lpszHoldAtLocationContactMiddleInitial);

char* dshippingsdk_fedexfreightship_getholdatlocationcontactphone(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationcontactphone(void* lpObj, const char* lpszHoldAtLocationContactPhone);

QString GetHoldAtLocationContactCompany();
int SetHoldAtLocationContactCompany(QString qsHoldAtLocationContactCompany);

QString GetHoldAtLocationContactEmail();
int SetHoldAtLocationContactEmail(QString qsHoldAtLocationContactEmail);

QString GetHoldAtLocationContactFax();
int SetHoldAtLocationContactFax(QString qsHoldAtLocationContactFax);

QString GetHoldAtLocationContactFirstName();
int SetHoldAtLocationContactFirstName(QString qsHoldAtLocationContactFirstName);

QString GetHoldAtLocationContactLastName();
int SetHoldAtLocationContactLastName(QString qsHoldAtLocationContactLastName);

QString GetHoldAtLocationContactMiddleInitial();
int SetHoldAtLocationContactMiddleInitial(QString qsHoldAtLocationContactMiddleInitial);

QString GetHoldAtLocationContactPhone();
int SetHoldAtLocationContactPhone(QString qsHoldAtLocationContactPhone);

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.

Data Type

DShippingSDKContactDetail

HoldAtLocationPhone Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
char* GetHoldAtLocationPhone();
int SetHoldAtLocationPhone(const char* lpszHoldAtLocationPhone);

Unicode (Windows)
LPWSTR GetHoldAtLocationPhone();
INT SetHoldAtLocationPhone(LPCWSTR lpszHoldAtLocationPhone);

char* dshippingsdk_fedexfreightship_getholdatlocationphone(void* lpObj);
int dshippingsdk_fedexfreightship_setholdatlocationphone(void* lpObj, const char* lpszHoldAtLocationPhone);

QString GetHoldAtLocationPhone();
int SetHoldAtLocationPhone(QString qsHoldAtLocationPhone);

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.

Data Type

String

InsuredValue Property (FedExFreightShip Class)

Total insured amount.

Syntax

ANSI (Cross Platform)
char* GetInsuredValue();
int SetInsuredValue(const char* lpszInsuredValue);

Unicode (Windows)
LPWSTR GetInsuredValue();
INT SetInsuredValue(LPCWSTR lpszInsuredValue);

char* dshippingsdk_fedexfreightship_getinsuredvalue(void* lpObj);
int dshippingsdk_fedexfreightship_setinsuredvalue(void* lpObj, const char* lpszInsuredValue);

QString GetInsuredValue();
int SetInsuredValue(QString qsInsuredValue);

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

Data Type

String

IntlExportControlledExportType Property (FedExFreightShip Class)

The controlled export type.

Syntax

ANSI (Cross Platform)
int GetIntlExportControlledExportType();
int SetIntlExportControlledExportType(int iIntlExportControlledExportType);

Unicode (Windows)
INT GetIntlExportControlledExportType();
INT SetIntlExportControlledExportType(INT iIntlExportControlledExportType);

Possible Values

CET_DEA036(0), 
CET_DEA236(1), 
CET_DEA486(2), 
CET_DSP05(3), 
CET_DSP61(4), 
CET_DSP73(5), 
CET_DSP85(6), 
CET_DSP94(7), 
CET_DSPLICENCE_AGREEMENT(8), 
CET_FROM_FOREIGN_TRADE_ZONE(9), 
CET_WAREHOUSE_WITHDRAWAL(10)

int dshippingsdk_fedexfreightship_getintlexportcontrolledexporttype(void* lpObj);
int dshippingsdk_fedexfreightship_setintlexportcontrolledexporttype(void* lpObj, int iIntlExportControlledExportType);

int GetIntlExportControlledExportType();
int SetIntlExportControlledExportType(int iIntlExportControlledExportType);

Default Value

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.

Data Type

Integer

IntlExportEntryNumber Property (FedExFreightShip Class)

The entry number for the controlled export.

Syntax

ANSI (Cross Platform)
char* GetIntlExportEntryNumber();
int SetIntlExportEntryNumber(const char* lpszIntlExportEntryNumber);

Unicode (Windows)
LPWSTR GetIntlExportEntryNumber();
INT SetIntlExportEntryNumber(LPCWSTR lpszIntlExportEntryNumber);

char* dshippingsdk_fedexfreightship_getintlexportentrynumber(void* lpObj);
int dshippingsdk_fedexfreightship_setintlexportentrynumber(void* lpObj, const char* lpszIntlExportEntryNumber);

QString GetIntlExportEntryNumber();
int SetIntlExportEntryNumber(QString qsIntlExportEntryNumber);

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.

Data Type

String

IntlExportForeignTradeZoneCode Property (FedExFreightShip Class)

The foreign trade zone code.

Syntax

ANSI (Cross Platform)
char* GetIntlExportForeignTradeZoneCode();
int SetIntlExportForeignTradeZoneCode(const char* lpszIntlExportForeignTradeZoneCode);

Unicode (Windows)
LPWSTR GetIntlExportForeignTradeZoneCode();
INT SetIntlExportForeignTradeZoneCode(LPCWSTR lpszIntlExportForeignTradeZoneCode);

char* dshippingsdk_fedexfreightship_getintlexportforeigntradezonecode(void* lpObj);
int dshippingsdk_fedexfreightship_setintlexportforeigntradezonecode(void* lpObj, const char* lpszIntlExportForeignTradeZoneCode);

QString GetIntlExportForeignTradeZoneCode();
int SetIntlExportForeignTradeZoneCode(QString qsIntlExportForeignTradeZoneCode);

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.

Data Type

String

IntlExportLicenseNumber Property (FedExFreightShip Class)

The license or permit number.

Syntax

ANSI (Cross Platform)
char* GetIntlExportLicenseNumber();
int SetIntlExportLicenseNumber(const char* lpszIntlExportLicenseNumber);

Unicode (Windows)
LPWSTR GetIntlExportLicenseNumber();
INT SetIntlExportLicenseNumber(LPCWSTR lpszIntlExportLicenseNumber);

char* dshippingsdk_fedexfreightship_getintlexportlicensenumber(void* lpObj);
int dshippingsdk_fedexfreightship_setintlexportlicensenumber(void* lpObj, const char* lpszIntlExportLicenseNumber);

QString GetIntlExportLicenseNumber();
int SetIntlExportLicenseNumber(QString qsIntlExportLicenseNumber);

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.

Data Type

String

IntlExportLicenseNumberExpiration Property (FedExFreightShip Class)

The license or permit number expiration date.

Syntax

ANSI (Cross Platform)
char* GetIntlExportLicenseNumberExpiration();
int SetIntlExportLicenseNumberExpiration(const char* lpszIntlExportLicenseNumberExpiration);

Unicode (Windows)
LPWSTR GetIntlExportLicenseNumberExpiration();
INT SetIntlExportLicenseNumberExpiration(LPCWSTR lpszIntlExportLicenseNumberExpiration);

char* dshippingsdk_fedexfreightship_getintlexportlicensenumberexpiration(void* lpObj);
int dshippingsdk_fedexfreightship_setintlexportlicensenumberexpiration(void* lpObj, const char* lpszIntlExportLicenseNumberExpiration);

QString GetIntlExportLicenseNumberExpiration();
int SetIntlExportLicenseNumberExpiration(QString qsIntlExportLicenseNumberExpiration);

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.

Data Type

String

LabelImageType Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Unicode (Windows)
INT GetLabelImageType();
INT SetLabelImageType(INT iLabelImageType);

Possible Values

FIT_PDF(0), 
FIT_PNG(1), 
FIT_ELTRON(2), 
FIT_ZEBRA(3), 
FIT_UNI_MARK(4)

int dshippingsdk_fedexfreightship_getlabelimagetype(void* lpObj);
int dshippingsdk_fedexfreightship_setlabelimagetype(void* lpObj, int iLabelImageType);

int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Default Value

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:


fitPDF (0)	PDF format (plain paper only - laser printer)
fitPNG (1)	PNG image (plain paper only - laser printer)
fitEltron (2)	Thermal only (to be used with Eltron Orion (EPL2) or Eltron Eclipse (EPL2) printers)
fitZebra (3)	Thermal only (to be used with Zebra ZPLII printer series)
fitUniMark (4)	Thermal only (to be used with Unimark printer series)

Note: To generate PDF labels, you will need Adobe Reader 6.0 or higher, and the printer driver configuration set to 'none' for print scaling.

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.

Data Type

Integer

Location Property (FedExFreightShip Class)

The FedEx location identifier that received the express dispatch request.

Syntax

ANSI (Cross Platform)
char* GetLocation();
int SetLocation(const char* lpszLocation);

Unicode (Windows)
LPWSTR GetLocation();
INT SetLocation(LPCWSTR lpszLocation);

char* dshippingsdk_fedexfreightship_getlocation(void* lpObj);
int dshippingsdk_fedexfreightship_setlocation(void* lpObj, const char* lpszLocation);

QString GetLocation();
int SetLocation(QString qsLocation);

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.

Data Type

String

MasterTrackingNumber Property (FedExFreightShip Class)

Tracking number assigned to the whole MPS shipment.

Syntax

ANSI (Cross Platform)
char* GetMasterTrackingNumber();

Unicode (Windows)
LPWSTR GetMasterTrackingNumber();

char* dshippingsdk_fedexfreightship_getmastertrackingnumber(void* lpObj);

QString GetMasterTrackingNumber();

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.

Data Type

String

Notify Property (FedExFreightShip Class)

Collection of recipients to get notified.

Syntax

DShippingSDKList<DShippingSDKNotifyDetail>* GetNotify();
int SetNotify(DShippingSDKList<DShippingSDKNotifyDetail>* val);

int dshippingsdk_fedexfreightship_getnotifycount(void* lpObj);
int dshippingsdk_fedexfreightship_setnotifycount(void* lpObj, int iNotifyCount);

char* dshippingsdk_fedexfreightship_getnotifyaggregate(void* lpObj, int notifyidx);
int dshippingsdk_fedexfreightship_setnotifyaggregate(void* lpObj, int notifyidx, const char* lpszNotifyAggregate);

char* dshippingsdk_fedexfreightship_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_fedexfreightship_setnotifyemail(void* lpObj, int notifyidx, const char* lpszNotifyEmail);

char* dshippingsdk_fedexfreightship_getnotifymessage(void* lpObj, int notifyidx);
int dshippingsdk_fedexfreightship_setnotifymessage(void* lpObj, int notifyidx, const char* lpszNotifyMessage);

char* dshippingsdk_fedexfreightship_getnotifyname(void* lpObj, int notifyidx);
int dshippingsdk_fedexfreightship_setnotifyname(void* lpObj, int notifyidx, const char* lpszNotifyName);

int dshippingsdk_fedexfreightship_getnotifyflags(void* lpObj, int notifyidx);
int dshippingsdk_fedexfreightship_setnotifyflags(void* lpObj, int notifyidx, int iNotifyFlags);

int dshippingsdk_fedexfreightship_getnotifytype(void* lpObj, int notifyidx);
int dshippingsdk_fedexfreightship_setnotifytype(void* lpObj, int notifyidx, int iNotifyType);

int GetNotifyCount();
int SetNotifyCount(int iNotifyCount);

QString GetNotifyAggregate(int iNotifyIdx);
int SetNotifyAggregate(int iNotifyIdx, QString qsNotifyAggregate);

QString GetNotifyEmail(int iNotifyIdx);
int SetNotifyEmail(int iNotifyIdx, QString qsNotifyEmail);

QString GetNotifyMessage(int iNotifyIdx);
int SetNotifyMessage(int iNotifyIdx, QString qsNotifyMessage);

QString GetNotifyName(int iNotifyIdx);
int SetNotifyName(int iNotifyIdx, QString qsNotifyName);

int GetNotifyFlags(int iNotifyIdx);
int SetNotifyFlags(int iNotifyIdx, int iNotifyFlags);

int GetNotifyType(int iNotifyIdx);
int SetNotifyType(int iNotifyIdx, int iNotifyType);

Remarks

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

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

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

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

For instance, if the 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)

This property is not available at design time.

Data Type

DShippingSDKNotifyDetail

PackageLocation Property (FedExFreightShip Class)

The location of pickup.

Syntax

ANSI (Cross Platform)
int GetPackageLocation();
int SetPackageLocation(int iPackageLocation);

Unicode (Windows)
INT GetPackageLocation();
INT SetPackageLocation(INT iPackageLocation);

Possible Values

PL_NONE(0), 
PL_FRONT(1), 
PL_SIDE(2), 
PL_REAR(3)

int dshippingsdk_fedexfreightship_getpackagelocation(void* lpObj);
int dshippingsdk_fedexfreightship_setpackagelocation(void* lpObj, int iPackageLocation);

int GetPackageLocation();
int SetPackageLocation(int iPackageLocation);

Default Value

Remarks

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

Data Type

Integer

Packages Property (FedExFreightShip Class)

A collection of packages contained in the shipment.

Syntax

DShippingSDKList<DShippingSDKPackageDetail>* GetPackages();
int SetPackages(DShippingSDKList<DShippingSDKPackageDetail>* val);

int dshippingsdk_fedexfreightship_getpackagecount(void* lpObj);
int dshippingsdk_fedexfreightship_setpackagecount(void* lpObj, int iPackageCount);

char* dshippingsdk_fedexfreightship_getpackagebasecharge(void* lpObj, int packageidx);

int dshippingsdk_fedexfreightship_getpackagedangerousgoodsaccessible(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagedangerousgoodsaccessible(void* lpObj, int packageidx, int bPackageDangerousGoodsAccessible);

int dshippingsdk_fedexfreightship_getpackagedangerousgoodsoptions(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagedangerousgoodsoptions(void* lpObj, int packageidx, int iPackageDangerousGoodsOptions);

char* dshippingsdk_fedexfreightship_getpackagedescription(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagedescription(void* lpObj, int packageidx, const char* lpszPackageDescription);

int dshippingsdk_fedexfreightship_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackageheight(void* lpObj, int packageidx, int iPackageHeight);

char* dshippingsdk_fedexfreightship_getpackageid(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackageid(void* lpObj, int packageidx, const char* lpszPackageId);

char* dshippingsdk_fedexfreightship_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackageinsuredvalue(void* lpObj, int packageidx, const char* lpszPackageInsuredValue);

int dshippingsdk_fedexfreightship_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagelength(void* lpObj, int packageidx, int iPackageLength);

char* dshippingsdk_fedexfreightship_getpackagenetcharge(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagenetcharge(void* lpObj, int packageidx, const char* lpszPackageNetCharge);

int dshippingsdk_fedexfreightship_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagetype(void* lpObj, int packageidx, int iPackageType);

char* dshippingsdk_fedexfreightship_getpackagereference(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagereference(void* lpObj, int packageidx, const char* lpszPackageReference);

int dshippingsdk_fedexfreightship_getpackageshippinglabel(void* lpObj, int packageidx, char** lpPackageShippingLabel, int* lenPackageShippingLabel);

char* dshippingsdk_fedexfreightship_getpackageshippinglabelfile(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackageshippinglabelfile(void* lpObj, int packageidx, const char* lpszPackageShippingLabelFile);

int dshippingsdk_fedexfreightship_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagesignaturetype(void* lpObj, int packageidx, int iPackageSignatureType);

int64 dshippingsdk_fedexfreightship_getpackagespecialservices(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagespecialservices(void* lpObj, int packageidx, int64 lPackageSpecialServices);

char* dshippingsdk_fedexfreightship_getpackagetotaldiscount(void* lpObj, int packageidx);

char* dshippingsdk_fedexfreightship_getpackagetotalsurcharges(void* lpObj, int packageidx);

char* dshippingsdk_fedexfreightship_getpackagetrackingnumber(void* lpObj, int packageidx);

char* dshippingsdk_fedexfreightship_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackageweight(void* lpObj, int packageidx, const char* lpszPackageWeight);

int dshippingsdk_fedexfreightship_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightship_setpackagewidth(void* lpObj, int packageidx, int iPackageWidth);

int GetPackageCount();
int SetPackageCount(int iPackageCount);

QString GetPackageBaseCharge(int iPackageIdx);

bool GetPackageDangerousGoodsAccessible(int iPackageIdx);
int SetPackageDangerousGoodsAccessible(int iPackageIdx, bool bPackageDangerousGoodsAccessible);

int GetPackageDangerousGoodsOptions(int iPackageIdx);
int SetPackageDangerousGoodsOptions(int iPackageIdx, int iPackageDangerousGoodsOptions);

QString GetPackageDescription(int iPackageIdx);
int SetPackageDescription(int iPackageIdx, QString qsPackageDescription);

int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

QString GetPackageId(int iPackageIdx);
int SetPackageId(int iPackageIdx, QString qsPackageId);

QString GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, QString qsPackageInsuredValue);

int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

QString GetPackageNetCharge(int iPackageIdx);
int SetPackageNetCharge(int iPackageIdx, QString qsPackageNetCharge);

int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

QString GetPackageReference(int iPackageIdx);
int SetPackageReference(int iPackageIdx, QString qsPackageReference);

QByteArray GetPackageShippingLabel(int iPackageIdx);

QString GetPackageShippingLabelFile(int iPackageIdx);
int SetPackageShippingLabelFile(int iPackageIdx, QString qsPackageShippingLabelFile);

int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

qint64 GetPackageSpecialServices(int iPackageIdx);
int SetPackageSpecialServices(int iPackageIdx, qint64 lPackageSpecialServices);

QString GetPackageTotalDiscount(int iPackageIdx);

QString GetPackageTotalSurcharges(int iPackageIdx);

QString GetPackageTrackingNumber(int iPackageIdx);

QString GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, QString qsPackageWeight);

int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

Remarks

At least one package must be specified.

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

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

This property is not available at design time.

Data Type

DShippingSDKPackageDetail

Payor Property (FedExFreightShip Class)

Identifies the payor of transportation charges for the requested shipment.

Syntax

DShippingSDKPayorDetail* GetPayor();
int SetPayor(DShippingSDKPayorDetail* val);

char* dshippingsdk_fedexfreightship_getpayoraccountnumber(void* lpObj);
int dshippingsdk_fedexfreightship_setpayoraccountnumber(void* lpObj, const char* lpszPayorAccountNumber);

char* dshippingsdk_fedexfreightship_getpayoraddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setpayoraddress1(void* lpObj, const char* lpszPayorAddress1);

char* dshippingsdk_fedexfreightship_getpayoraddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setpayoraddress2(void* lpObj, const char* lpszPayorAddress2);

char* dshippingsdk_fedexfreightship_getpayorcity(void* lpObj);
int dshippingsdk_fedexfreightship_setpayorcity(void* lpObj, const char* lpszPayorCity);

char* dshippingsdk_fedexfreightship_getpayorcountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setpayorcountrycode(void* lpObj, const char* lpszPayorCountryCode);

char* dshippingsdk_fedexfreightship_getpayorname(void* lpObj);
int dshippingsdk_fedexfreightship_setpayorname(void* lpObj, const char* lpszPayorName);

int dshippingsdk_fedexfreightship_getpayortype(void* lpObj);
int dshippingsdk_fedexfreightship_setpayortype(void* lpObj, int iPayorType);

char* dshippingsdk_fedexfreightship_getpayorstate(void* lpObj);
int dshippingsdk_fedexfreightship_setpayorstate(void* lpObj, const char* lpszPayorState);

char* dshippingsdk_fedexfreightship_getpayorzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setpayorzipcode(void* lpObj, const char* lpszPayorZipCode);

QString GetPayorAccountNumber();
int SetPayorAccountNumber(QString qsPayorAccountNumber);

QString GetPayorAddress1();
int SetPayorAddress1(QString qsPayorAddress1);

QString GetPayorAddress2();
int SetPayorAddress2(QString qsPayorAddress2);

QString GetPayorCity();
int SetPayorCity(QString qsPayorCity);

QString GetPayorCountryCode();
int SetPayorCountryCode(QString qsPayorCountryCode);

QString GetPayorName();
int SetPayorName(QString qsPayorName);

int GetPayorType();
int SetPayorType(int iPayorType);

QString GetPayorState();
int SetPayorState(QString qsPayorState);

QString GetPayorZipCode();
int SetPayorZipCode(QString qsPayorZipCode);

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.

Data Type

DShippingSDKPayorDetail

PickupPaymentType Property (FedExFreightShip Class)

The payment type for the pickup.

Syntax

ANSI (Cross Platform)
int GetPickupPaymentType();
int SetPickupPaymentType(int iPickupPaymentType);

Unicode (Windows)
INT GetPickupPaymentType();
INT SetPickupPaymentType(INT iPickupPaymentType);

Possible Values

PPT_SENDER(0), 
PPT_RECIPIENT(1), 
PPT_THIRD_PARTY(2), 
PPT_COLLECT(3), 
PPT_ACCOUNT(4), 
PPT_CASH(5), 
PPT_CREDIT_CARD(6)

int dshippingsdk_fedexfreightship_getpickuppaymenttype(void* lpObj);
int dshippingsdk_fedexfreightship_setpickuppaymenttype(void* lpObj, int iPickupPaymentType);

int GetPickupPaymentType();
int SetPickupPaymentType(int iPickupPaymentType);

Default Value

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 AccountNumber

Data Type

Integer

PickupType Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int GetPickupType();
int SetPickupType(int iPickupType);

Unicode (Windows)
INT GetPickupType();
INT SetPickupType(INT iPickupType);

Possible Values

FPT_DROPOFF_AT_FEDEX_LOCATION(0), 
FPT_CONTACT_FEDEX_TO_SCHEDULE(1), 
FPT_USE_SCHEDULED_PICKUP(2), 
FPT_ON_CALL(3), 
FPT_PACKAGE_RETURN_PROGRAM(4), 
FPT_REGULAR_STOP(5), 
FPT_TAG(6), 
FPT_NONE(7)

int dshippingsdk_fedexfreightship_getpickuptype(void* lpObj);
int dshippingsdk_fedexfreightship_setpickuptype(void* lpObj, int iPickupType);

int GetPickupType();
int SetPickupType(int iPickupType);

Default Value

Remarks

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

Valid values are:


Value	Description
fptDropoffAtFedexLocation (0)	Dropoff At Fedex Location (Default)	Ship
fptContactFedexToSchedule (1)	Contact Fedex To Schedule	Ship
fptUseScheduledPickup (2)	Use Scheduled Pickup	Ship
fptOnCall (3)	On Call	Pickup
fptPackageReturnProgram (4)	Package Return Program	Pickup
fptRegularStop (5)	RegularStop	Pickup
fptTag (6)	Tag	Ship, Pickup
fptNone (7)	None

Data Type

Integer

Proxy Property (FedExFreightShip Class)

A set of properties related to proxy access.

Syntax

DShippingSDKProxy* GetProxy();
int SetProxy(DShippingSDKProxy* val);

int dshippingsdk_fedexfreightship_getproxyauthscheme(void* lpObj);
int dshippingsdk_fedexfreightship_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int dshippingsdk_fedexfreightship_getproxyautodetect(void* lpObj);
int dshippingsdk_fedexfreightship_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* dshippingsdk_fedexfreightship_getproxypassword(void* lpObj);
int dshippingsdk_fedexfreightship_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int dshippingsdk_fedexfreightship_getproxyport(void* lpObj);
int dshippingsdk_fedexfreightship_setproxyport(void* lpObj, int iProxyPort);

char* dshippingsdk_fedexfreightship_getproxyserver(void* lpObj);
int dshippingsdk_fedexfreightship_setproxyserver(void* lpObj, const char* lpszProxyServer);

int dshippingsdk_fedexfreightship_getproxyssl(void* lpObj);
int dshippingsdk_fedexfreightship_setproxyssl(void* lpObj, int iProxySSL);

char* dshippingsdk_fedexfreightship_getproxyuser(void* lpObj);
int dshippingsdk_fedexfreightship_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

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

Data Type

DShippingSDKProxy

RecipientAddress Property (FedExFreightShip Class)

Identifies the recipient's address.

Syntax

DShippingSDKAddressDetail* GetRecipientAddress();
int SetRecipientAddress(DShippingSDKAddressDetail* val);

char* dshippingsdk_fedexfreightship_getrecipientaddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientaddress1(void* lpObj, const char* lpszRecipientAddress1);

char* dshippingsdk_fedexfreightship_getrecipientaddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientaddress2(void* lpObj, const char* lpszRecipientAddress2);

int dshippingsdk_fedexfreightship_getrecipientaddressflags(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientaddressflags(void* lpObj, int iRecipientAddressFlags);

char* dshippingsdk_fedexfreightship_getrecipientcity(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientcity(void* lpObj, const char* lpszRecipientCity);

char* dshippingsdk_fedexfreightship_getrecipientcountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientcountrycode(void* lpObj, const char* lpszRecipientCountryCode);

char* dshippingsdk_fedexfreightship_getrecipientstate(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientstate(void* lpObj, const char* lpszRecipientState);

char* dshippingsdk_fedexfreightship_getrecipientzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientzipcode(void* lpObj, const char* lpszRecipientZipCode);

QString GetRecipientAddress1();
int SetRecipientAddress1(QString qsRecipientAddress1);

QString GetRecipientAddress2();
int SetRecipientAddress2(QString qsRecipientAddress2);

int GetRecipientAddressFlags();
int SetRecipientAddressFlags(int iRecipientAddressFlags);

QString GetRecipientCity();
int SetRecipientCity(QString qsRecipientCity);

QString GetRecipientCountryCode();
int SetRecipientCountryCode(QString qsRecipientCountryCode);

QString GetRecipientState();
int SetRecipientState(QString qsRecipientState);

QString GetRecipientZipCode();
int SetRecipientZipCode(QString qsRecipientZipCode);

Remarks

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

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

Data Type

DShippingSDKAddressDetail

RecipientContact Property (FedExFreightShip Class)

Identifies the recipient's contact info.

Syntax

DShippingSDKContactDetail* GetRecipientContact();
int SetRecipientContact(DShippingSDKContactDetail* val);

char* dshippingsdk_fedexfreightship_getrecipientcompany(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientcompany(void* lpObj, const char* lpszRecipientCompany);

char* dshippingsdk_fedexfreightship_getrecipientemail(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientemail(void* lpObj, const char* lpszRecipientEmail);

char* dshippingsdk_fedexfreightship_getrecipientfax(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientfax(void* lpObj, const char* lpszRecipientFax);

char* dshippingsdk_fedexfreightship_getrecipientfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientfirstname(void* lpObj, const char* lpszRecipientFirstName);

char* dshippingsdk_fedexfreightship_getrecipientlastname(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientlastname(void* lpObj, const char* lpszRecipientLastName);

char* dshippingsdk_fedexfreightship_getrecipientmiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientmiddleinitial(void* lpObj, const char* lpszRecipientMiddleInitial);

char* dshippingsdk_fedexfreightship_getrecipientphone(void* lpObj);
int dshippingsdk_fedexfreightship_setrecipientphone(void* lpObj, const char* lpszRecipientPhone);

QString GetRecipientCompany();
int SetRecipientCompany(QString qsRecipientCompany);

QString GetRecipientEmail();
int SetRecipientEmail(QString qsRecipientEmail);

QString GetRecipientFax();
int SetRecipientFax(QString qsRecipientFax);

QString GetRecipientFirstName();
int SetRecipientFirstName(QString qsRecipientFirstName);

QString GetRecipientLastName();
int SetRecipientLastName(QString qsRecipientLastName);

QString GetRecipientMiddleInitial();
int SetRecipientMiddleInitial(QString qsRecipientMiddleInitial);

QString GetRecipientPhone();
int SetRecipientPhone(QString qsRecipientPhone);

Remarks

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

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

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

Data Type

DShippingSDKContactDetail

RequestedETDDocuments Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int GetRequestedETDDocuments();
int SetRequestedETDDocuments(int iRequestedETDDocuments);

Unicode (Windows)
INT GetRequestedETDDocuments();
INT SetRequestedETDDocuments(INT iRequestedETDDocuments);

int dshippingsdk_fedexfreightship_getrequestedetddocuments(void* lpObj);
int dshippingsdk_fedexfreightship_setrequestedetddocuments(void* lpObj, int iRequestedETDDocuments);

int GetRequestedETDDocuments();
int SetRequestedETDDocuments(int iRequestedETDDocuments);

Default Value

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:


Value	Description
0x0	None
0x1	Certificate of Origin
0x2	Commercial Invoice
0x4	NAFTA Certificate of Origin

Note this only applies when shipping internationally.

Data Type

Integer

ReturnAddress Property (FedExFreightShip Class)

Identifies the return address to be printed on the label.

Syntax

DShippingSDKAddressDetail* GetReturnAddress();
int SetReturnAddress(DShippingSDKAddressDetail* val);

char* dshippingsdk_fedexfreightship_getreturnaddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnaddress1(void* lpObj, const char* lpszReturnAddress1);

char* dshippingsdk_fedexfreightship_getreturnaddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnaddress2(void* lpObj, const char* lpszReturnAddress2);

int dshippingsdk_fedexfreightship_getreturnaddressflags(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnaddressflags(void* lpObj, int iReturnAddressFlags);

char* dshippingsdk_fedexfreightship_getreturncity(void* lpObj);
int dshippingsdk_fedexfreightship_setreturncity(void* lpObj, const char* lpszReturnCity);

char* dshippingsdk_fedexfreightship_getreturncountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setreturncountrycode(void* lpObj, const char* lpszReturnCountryCode);

char* dshippingsdk_fedexfreightship_getreturnstate(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnstate(void* lpObj, const char* lpszReturnState);

char* dshippingsdk_fedexfreightship_getreturnzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnzipcode(void* lpObj, const char* lpszReturnZipCode);

QString GetReturnAddress1();
int SetReturnAddress1(QString qsReturnAddress1);

QString GetReturnAddress2();
int SetReturnAddress2(QString qsReturnAddress2);

int GetReturnAddressFlags();
int SetReturnAddressFlags(int iReturnAddressFlags);

QString GetReturnCity();
int SetReturnCity(QString qsReturnCity);

QString GetReturnCountryCode();
int SetReturnCountryCode(QString qsReturnCountryCode);

QString GetReturnState();
int SetReturnState(QString qsReturnState);

QString GetReturnZipCode();
int SetReturnZipCode(QString qsReturnZipCode);

Remarks

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

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

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

Data Type

DShippingSDKAddressDetail

ReturnContact Property (FedExFreightShip Class)

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

Syntax

DShippingSDKContactDetail* GetReturnContact();
int SetReturnContact(DShippingSDKContactDetail* val);

char* dshippingsdk_fedexfreightship_getreturncompany(void* lpObj);
int dshippingsdk_fedexfreightship_setreturncompany(void* lpObj, const char* lpszReturnCompany);

char* dshippingsdk_fedexfreightship_getreturnemail(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnemail(void* lpObj, const char* lpszReturnEmail);

char* dshippingsdk_fedexfreightship_getreturnfax(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnfax(void* lpObj, const char* lpszReturnFax);

char* dshippingsdk_fedexfreightship_getreturnfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnfirstname(void* lpObj, const char* lpszReturnFirstName);

char* dshippingsdk_fedexfreightship_getreturnlastname(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnlastname(void* lpObj, const char* lpszReturnLastName);

char* dshippingsdk_fedexfreightship_getreturnmiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnmiddleinitial(void* lpObj, const char* lpszReturnMiddleInitial);

char* dshippingsdk_fedexfreightship_getreturnphone(void* lpObj);
int dshippingsdk_fedexfreightship_setreturnphone(void* lpObj, const char* lpszReturnPhone);

QString GetReturnCompany();
int SetReturnCompany(QString qsReturnCompany);

QString GetReturnEmail();
int SetReturnEmail(QString qsReturnEmail);

QString GetReturnFax();
int SetReturnFax(QString qsReturnFax);

QString GetReturnFirstName();
int SetReturnFirstName(QString qsReturnFirstName);

QString GetReturnLastName();
int SetReturnLastName(QString qsReturnLastName);

QString GetReturnMiddleInitial();
int SetReturnMiddleInitial(QString qsReturnMiddleInitial);

QString GetReturnPhone();
int SetReturnPhone(QString qsReturnPhone);

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.

Data Type

DShippingSDKContactDetail

SenderAddress Property (FedExFreightShip Class)

Identifies the sender's address.

Syntax

DShippingSDKAddressDetail* GetSenderAddress();
int SetSenderAddress(DShippingSDKAddressDetail* val);

char* dshippingsdk_fedexfreightship_getsenderaddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderaddress1(void* lpObj, const char* lpszSenderAddress1);

char* dshippingsdk_fedexfreightship_getsenderaddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderaddress2(void* lpObj, const char* lpszSenderAddress2);

int dshippingsdk_fedexfreightship_getsenderaddressflags(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderaddressflags(void* lpObj, int iSenderAddressFlags);

char* dshippingsdk_fedexfreightship_getsendercity(void* lpObj);
int dshippingsdk_fedexfreightship_setsendercity(void* lpObj, const char* lpszSenderCity);

char* dshippingsdk_fedexfreightship_getsendercountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setsendercountrycode(void* lpObj, const char* lpszSenderCountryCode);

char* dshippingsdk_fedexfreightship_getsenderstate(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderstate(void* lpObj, const char* lpszSenderState);

char* dshippingsdk_fedexfreightship_getsenderzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderzipcode(void* lpObj, const char* lpszSenderZipCode);

QString GetSenderAddress1();
int SetSenderAddress1(QString qsSenderAddress1);

QString GetSenderAddress2();
int SetSenderAddress2(QString qsSenderAddress2);

int GetSenderAddressFlags();
int SetSenderAddressFlags(int iSenderAddressFlags);

QString GetSenderCity();
int SetSenderCity(QString qsSenderCity);

QString GetSenderCountryCode();
int SetSenderCountryCode(QString qsSenderCountryCode);

QString GetSenderState();
int SetSenderState(QString qsSenderState);

QString GetSenderZipCode();
int SetSenderZipCode(QString qsSenderZipCode);

Remarks

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

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

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

Data Type

DShippingSDKAddressDetail

SenderContact Property (FedExFreightShip Class)

Identifies the sender's contact info.

Syntax

DShippingSDKContactDetail* GetSenderContact();
int SetSenderContact(DShippingSDKContactDetail* val);

char* dshippingsdk_fedexfreightship_getsendercompany(void* lpObj);
int dshippingsdk_fedexfreightship_setsendercompany(void* lpObj, const char* lpszSenderCompany);

char* dshippingsdk_fedexfreightship_getsenderemail(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderemail(void* lpObj, const char* lpszSenderEmail);

char* dshippingsdk_fedexfreightship_getsenderfax(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderfax(void* lpObj, const char* lpszSenderFax);

char* dshippingsdk_fedexfreightship_getsenderfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderfirstname(void* lpObj, const char* lpszSenderFirstName);

char* dshippingsdk_fedexfreightship_getsenderlastname(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderlastname(void* lpObj, const char* lpszSenderLastName);

char* dshippingsdk_fedexfreightship_getsendermiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setsendermiddleinitial(void* lpObj, const char* lpszSenderMiddleInitial);

char* dshippingsdk_fedexfreightship_getsenderphone(void* lpObj);
int dshippingsdk_fedexfreightship_setsenderphone(void* lpObj, const char* lpszSenderPhone);

QString GetSenderCompany();
int SetSenderCompany(QString qsSenderCompany);

QString GetSenderEmail();
int SetSenderEmail(QString qsSenderEmail);

QString GetSenderFax();
int SetSenderFax(QString qsSenderFax);

QString GetSenderFirstName();
int SetSenderFirstName(QString qsSenderFirstName);

QString GetSenderLastName();
int SetSenderLastName(QString qsSenderLastName);

QString GetSenderMiddleInitial();
int SetSenderMiddleInitial(QString qsSenderMiddleInitial);

QString GetSenderPhone();
int SetSenderPhone(QString qsSenderPhone);

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.

Data Type

DShippingSDKContactDetail

ServiceType Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int GetServiceType();
int SetServiceType(int iServiceType);

Unicode (Windows)
INT GetServiceType();
INT SetServiceType(INT iServiceType);

Possible Values

ST_UNSPECIFIED(0), 
ST_FED_EX_PRIORITY_OVERNIGHT(10), 
ST_FED_EX_STANDARD_OVERNIGHT(11), 
ST_FED_EX_FIRST_OVERNIGHT(12), 
ST_FED_EX_2DAY(13), 
ST_FED_EX_EXPRESS_SAVER(14), 
ST_FED_EX_GROUND(15), 
ST_FED_EX_GROUND_HOME_DELIVERY(16), 
ST_FED_EX_1DAY_FREIGHT(17), 
ST_FED_EX_2DAY_FREIGHT(18), 
ST_FED_EX_3DAY_FREIGHT(19), 
ST_FED_EX_INTERNATIONAL_PRIORITY(20), 
ST_FED_EX_INTERNATIONAL_ECONOMY(21), 
ST_FED_EX_INTERNATIONAL_FIRST(22), 
ST_FED_EX_INTERNATIONAL_PRIORITY_FREIGHT(23), 
ST_FED_EX_INTERNATIONAL_ECONOMY_FREIGHT(24), 
ST_FED_EX_EUROPE_FIRST_INTERNATIONAL_PRIORITY(25), 
ST_FED_EX_SMART_POST(26), 
ST_FED_EX_2DAY_AM(27), 
ST_FED_EX_FIRST_FREIGHT(28), 
ST_FED_EX_INTERNATIONAL_GROUND(29), 
ST_FED_EX_FREIGHT_ECONOMY(30), 
ST_FED_EX_FREIGHT_PRIORITY(31), 
ST_FED_EX_INTERNATIONAL_PRIORITY_EXPRESS(32), 
ST_FED_EX_INTERNATIONAL_CONNECT_PLUS(33), 
ST_UPSFIRST_CLASS(35), 
ST_UPSPRIORITY_MAIL(36), 
ST_UPSEXPEDITED_MAIL_INNOVATIONS(37), 
ST_UPSPRIORITY_MAIL_INNOVATIONS(38), 
ST_UPSECONOMY_MAIL_INNOVATIONS(39), 
ST_UPSNEXT_DAY_AIR(40), 
ST_UPSEXPRESS(41), 
ST_UPS2ND_DAY_AIR(42), 
ST_UPSGROUND(43), 
ST_UPSWORLDWIDE_EXPRESS(44), 
ST_UPSWORLDWIDE_EXPEDITED(45), 
ST_UPSEXPEDITED(46), 
ST_UPSSTANDARD(47), 
ST_UPS3DAY_SELECT(48), 
ST_UPSNEXT_DAY_AIR_SAVER(49), 
ST_UPSSAVER(50), 
ST_UPSNEXT_DAY_AIR_EARLY_AM(51), 
ST_UPSEXPRESS_EARLY_AM(52), 
ST_UPSWORLDWIDE_EXPRESS_PLUS(53), 
ST_UPSEXPRESS_PLUS(54), 
ST_UPS2ND_DAY_AIR_AM(55), 
ST_UPSTODAY_STANDARD(56), 
ST_UPSTODAY_COURRIER(57), 
ST_UPSTODAY_INTER_CITY(58), 
ST_UPSTODAY_EXPRESS(59), 
ST_UPSTODAY_EXPRESS_SAVER(60), 
ST_UPSWORLDWIDE_EXPRESS_FREIGHT(61), 
ST_UPSSURE_POST_LESS_THAN_1LB(62), 
ST_UPSSURE_POST_1LBOR_GREATER(63), 
ST_UPSSURE_POST_BPM(64), 
ST_UPSSURE_POST_MEDIA(65), 
ST_USPSEXPRESS(70), 
ST_USPSFIRST_CLASS(71), 
ST_USPSPRIORITY(72), 
ST_USPSPARCEL_POST(73), 
ST_USPSBPM(74), 
ST_USPSMEDIA(75), 
ST_USPSLIBRARY(76), 
ST_USPSONLINE(77), 
ST_USPSGLOBAL_EXPRESS(78), 
ST_USPSPARCEL_SELECT(79), 
ST_USPSCRITICAL_MAIL(80), 
ST_USPSSTANDARD_MAIL(81), 
ST_USPSEXPRESS_MAIL_INTERNATIONAL(82), 
ST_USPSFIRST_CLASS_MAIL_INTERNATIONAL(83), 
ST_USPSPRIORITY_MAIL_INTERNATIONAL(84), 
ST_USPSPRIORITY_EXPRESS(85), 
ST_USPSRETAIL_GROUND(86), 
ST_USPSFIRST_CLASS_PACKAGE_INTERNATIONAL_SERVICE(87), 
ST_USPSPRIORITY_MAIL_EXPRESS_INTERNATIONAL(88), 
ST_CANADA_REGULAR_PARCEL(90), 
ST_CANADA_EXPEDITED_PARCEL(91), 
ST_CANADA_XPRESSPOST(92), 
ST_CANADA_LIBRARY(93), 
ST_CANADA_PRIORITY(94), 
ST_CANADA_PRIORITY_ENVELOPE_USA(95), 
ST_CANADA_PRIORITY_PAK_USA(96), 
ST_CANADA_PRIORITY_PARCEL_USA(97), 
ST_CANADA_XPRESSPOST_USA(98), 
ST_CANADA_EXPEDITED_PARCEL_USA(99), 
ST_CANADA_SMALL_PACKET_AIR_USA(100), 
ST_CANADA_TRACKED_PACKET_USA(101), 
ST_CANADA_TRACKED_PACKET_LVMUSA(102), 
ST_CANADA_PRIORITY_ENVELOPE_INTERNATIONAL(103), 
ST_CANADA_PRIORITY_PAK_INTERNATIONAL(104), 
ST_CANADA_PRIORITY_PARCEL_INTERNATIONAL(105), 
ST_CANADA_XPRESSPOST_INTERNATIONAL(106), 
ST_CANADA_SMALL_PACKET_AIR_INTERNATIONAL(107), 
ST_CANADA_SMALL_PACKET_LAND_INTERNATIONAL(108), 
ST_CANADA_PARCEL_AIR_INTERNATIONAL(109), 
ST_CANADA_PARCEL_LAND_INTERNATIONAL(110), 
ST_CANADA_TRACKED_PACKET_INTERNATIONAL(111), 
ST_FED_EX_SAME_DAY(126), 
ST_FED_EX_SAME_DAY_CITY(127), 
ST_FED_EX_SAME_DAY_METRO_AFTERNOON(128), 
ST_FED_EX_SAME_DAY_METRO_MORNING(129), 
ST_FED_EX_SAME_DAY_METRO_RUSH(130), 
ST_UPSWORLDWIDE_ECONOMY_DDU(131), 
ST_UPSWORLDWIDE_ECONOMY_DDP(132), 
ST_USPSPARCEL_SELECT_GROUND(133), 
ST_USPSPRIORITY_MAIL_CUBIC(134), 
ST_USPSGROUND_ADVANTAGE(135), 
ST_USPSGROUND_ADVANTAGE_CUBIC(136), 
ST_FED_EX_FIRST(140), 
ST_FED_EX_PRIORITY(141), 
ST_FED_EX_PRIORITY_EXPRESS(142), 
ST_FED_EX_PRIORITY_EXPRESS_FREIGHT(143), 
ST_FED_EX_PRIORITY_FREIGHT(144), 
ST_FED_EX_ECONOMY_SELECT(145)

int dshippingsdk_fedexfreightship_getservicetype(void* lpObj);
int dshippingsdk_fedexfreightship_setservicetype(void* lpObj, int iServiceType);

int GetServiceType();
int SetServiceType(int iServiceType);

Default Value

Remarks

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

Possible values are:


stFedEx1DayFreight (17)	A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment.
stFedEx2DayFreight (18)
stFedEx3DayFreight (19)
stFedExInternationalPriorityFreight (23)	PackagingType should be set to Your Packaging. A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment.
stFedExInternationalEconomyFreight (24)	PackagingType should be set to Your Packaging. Advanced confirmation is required for this service. Call 1.800.332.0807 to book your freight shipment.
stFedExFirstFreight (28)	PackagingType should be set to Your Packaging. Also the maximum declared value for the shipment is $50,000 USD.
stFedExFreightEconomy (30)
stFedExFreightPriority (31)

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.

This property is not available at design time.

Data Type

Integer

ShipDate Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
char* GetShipDate();
int SetShipDate(const char* lpszShipDate);

Unicode (Windows)
LPWSTR GetShipDate();
INT SetShipDate(LPCWSTR lpszShipDate);

char* dshippingsdk_fedexfreightship_getshipdate(void* lpObj);
int dshippingsdk_fedexfreightship_setshipdate(void* lpObj, const char* lpszShipDate);

QString GetShipDate();
int SetShipDate(QString qsShipDate);

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

Data Type

String

ShipmentInfo Property (FedExFreightShip Class)

The shipment info for the freight shipment.

Syntax

DShippingSDKFreightShipmentDetail* GetShipmentInfo();
int SetShipmentInfo(DShippingSDKFreightShipmentDetail* val);

char* dshippingsdk_fedexfreightship_getshipmentinfoaccountnumber(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoaccountnumber(void* lpObj, const char* lpszShipmentInfoAccountNumber);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingaccountnumber(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingaccountnumber(void* lpObj, const char* lpszShipmentInfoAlternateBillingAccountNumber);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingcity(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingcity(void* lpObj, const char* lpszShipmentInfoAlternateBillingCity);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingcompanyname(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingcompanyname(void* lpObj, const char* lpszShipmentInfoAlternateBillingCompanyName);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingcountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingcountrycode(void* lpObj, const char* lpszShipmentInfoAlternateBillingCountryCode);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingpersonname(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingpersonname(void* lpObj, const char* lpszShipmentInfoAlternateBillingPersonName);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingphone(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingphone(void* lpObj, const char* lpszShipmentInfoAlternateBillingPhone);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingstate(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingstate(void* lpObj, const char* lpszShipmentInfoAlternateBillingState);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingstreetaddress(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingstreetaddress(void* lpObj, const char* lpszShipmentInfoAlternateBillingStreetAddress);

char* dshippingsdk_fedexfreightship_getshipmentinfoalternatebillingzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoalternatebillingzipcode(void* lpObj, const char* lpszShipmentInfoAlternateBillingZipCode);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingaddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingaddress1(void* lpObj, const char* lpszShipmentInfoBillingAddress1);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingaddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingaddress2(void* lpObj, const char* lpszShipmentInfoBillingAddress2);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingcity(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingcity(void* lpObj, const char* lpszShipmentInfoBillingCity);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingcompanyname(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingcompanyname(void* lpObj, const char* lpszShipmentInfoBillingCompanyName);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingcountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingcountrycode(void* lpObj, const char* lpszShipmentInfoBillingCountryCode);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingemail(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingemail(void* lpObj, const char* lpszShipmentInfoBillingEmail);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingfax(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingfax(void* lpObj, const char* lpszShipmentInfoBillingFax);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingpersonname(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingpersonname(void* lpObj, const char* lpszShipmentInfoBillingPersonName);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingphone(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingphone(void* lpObj, const char* lpszShipmentInfoBillingPhone);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingstate(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingstate(void* lpObj, const char* lpszShipmentInfoBillingState);

char* dshippingsdk_fedexfreightship_getshipmentinfobillingzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfobillingzipcode(void* lpObj, const char* lpszShipmentInfoBillingZipCode);

char* dshippingsdk_fedexfreightship_getshipmentinfoclientdiscountpercent(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoclientdiscountpercent(void* lpObj, const char* lpszShipmentInfoClientDiscountPercent);

int dshippingsdk_fedexfreightship_getshipmentinfocollecttermstype(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfocollecttermstype(void* lpObj, int iShipmentInfoCollectTermsType);

char* dshippingsdk_fedexfreightship_getshipmentinfocomments(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfocomments(void* lpObj, const char* lpszShipmentInfoComments);

char* dshippingsdk_fedexfreightship_getshipmentinfocoupons(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfocoupons(void* lpObj, const char* lpszShipmentInfoCoupons);

char* dshippingsdk_fedexfreightship_getshipmentinfodeclaredvalue(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfodeclaredvalue(void* lpObj, const char* lpszShipmentInfoDeclaredValue);

char* dshippingsdk_fedexfreightship_getshipmentinfodeclaredvalueunits(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfodeclaredvalueunits(void* lpObj, const char* lpszShipmentInfoDeclaredValueUnits);

char* dshippingsdk_fedexfreightship_getshipmentinfoemergencycontactphone(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoemergencycontactphone(void* lpObj, const char* lpszShipmentInfoEmergencyContactPhone);

char* dshippingsdk_fedexfreightship_getshipmentinfohazardousmaterialsofferor(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfohazardousmaterialsofferor(void* lpObj, const char* lpszShipmentInfoHazardousMaterialsOfferor);

char* dshippingsdk_fedexfreightship_getshipmentinfoliabilitycoverageamount(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoliabilitycoverageamount(void* lpObj, const char* lpszShipmentInfoLiabilityCoverageAmount);

int dshippingsdk_fedexfreightship_getshipmentinfoliabilitycoveragetype(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfoliabilitycoveragetype(void* lpObj, int iShipmentInfoLiabilityCoverageType);

char* dshippingsdk_fedexfreightship_getshipmentinfopalletweight(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfopalletweight(void* lpObj, const char* lpszShipmentInfoPalletWeight);

int dshippingsdk_fedexfreightship_getshipmentinforole(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinforole(void* lpObj, int iShipmentInfoRole);

int dshippingsdk_fedexfreightship_getshipmentinfototalhandlingunits(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfototalhandlingunits(void* lpObj, int iShipmentInfoTotalHandlingUnits);

int dshippingsdk_fedexfreightship_getshipmentinfototalheight(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfototalheight(void* lpObj, int iShipmentInfoTotalHeight);

int dshippingsdk_fedexfreightship_getshipmentinfototallength(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfototallength(void* lpObj, int iShipmentInfoTotalLength);

int dshippingsdk_fedexfreightship_getshipmentinfototalwidth(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentinfototalwidth(void* lpObj, int iShipmentInfoTotalWidth);

QString GetShipmentInfoAccountNumber();
int SetShipmentInfoAccountNumber(QString qsShipmentInfoAccountNumber);

QString GetShipmentInfoAlternateBillingAccountNumber();
int SetShipmentInfoAlternateBillingAccountNumber(QString qsShipmentInfoAlternateBillingAccountNumber);

QString GetShipmentInfoAlternateBillingCity();
int SetShipmentInfoAlternateBillingCity(QString qsShipmentInfoAlternateBillingCity);

QString GetShipmentInfoAlternateBillingCompanyName();
int SetShipmentInfoAlternateBillingCompanyName(QString qsShipmentInfoAlternateBillingCompanyName);

QString GetShipmentInfoAlternateBillingCountryCode();
int SetShipmentInfoAlternateBillingCountryCode(QString qsShipmentInfoAlternateBillingCountryCode);

QString GetShipmentInfoAlternateBillingPersonName();
int SetShipmentInfoAlternateBillingPersonName(QString qsShipmentInfoAlternateBillingPersonName);

QString GetShipmentInfoAlternateBillingPhone();
int SetShipmentInfoAlternateBillingPhone(QString qsShipmentInfoAlternateBillingPhone);

QString GetShipmentInfoAlternateBillingState();
int SetShipmentInfoAlternateBillingState(QString qsShipmentInfoAlternateBillingState);

QString GetShipmentInfoAlternateBillingStreetAddress();
int SetShipmentInfoAlternateBillingStreetAddress(QString qsShipmentInfoAlternateBillingStreetAddress);

QString GetShipmentInfoAlternateBillingZipCode();
int SetShipmentInfoAlternateBillingZipCode(QString qsShipmentInfoAlternateBillingZipCode);

QString GetShipmentInfoBillingAddress1();
int SetShipmentInfoBillingAddress1(QString qsShipmentInfoBillingAddress1);

QString GetShipmentInfoBillingAddress2();
int SetShipmentInfoBillingAddress2(QString qsShipmentInfoBillingAddress2);

QString GetShipmentInfoBillingCity();
int SetShipmentInfoBillingCity(QString qsShipmentInfoBillingCity);

QString GetShipmentInfoBillingCompanyName();
int SetShipmentInfoBillingCompanyName(QString qsShipmentInfoBillingCompanyName);

QString GetShipmentInfoBillingCountryCode();
int SetShipmentInfoBillingCountryCode(QString qsShipmentInfoBillingCountryCode);

QString GetShipmentInfoBillingEmail();
int SetShipmentInfoBillingEmail(QString qsShipmentInfoBillingEmail);

QString GetShipmentInfoBillingFax();
int SetShipmentInfoBillingFax(QString qsShipmentInfoBillingFax);

QString GetShipmentInfoBillingPersonName();
int SetShipmentInfoBillingPersonName(QString qsShipmentInfoBillingPersonName);

QString GetShipmentInfoBillingPhone();
int SetShipmentInfoBillingPhone(QString qsShipmentInfoBillingPhone);

QString GetShipmentInfoBillingState();
int SetShipmentInfoBillingState(QString qsShipmentInfoBillingState);

QString GetShipmentInfoBillingZipCode();
int SetShipmentInfoBillingZipCode(QString qsShipmentInfoBillingZipCode);

QString GetShipmentInfoClientDiscountPercent();
int SetShipmentInfoClientDiscountPercent(QString qsShipmentInfoClientDiscountPercent);

int GetShipmentInfoCollectTermsType();
int SetShipmentInfoCollectTermsType(int iShipmentInfoCollectTermsType);

QString GetShipmentInfoComments();
int SetShipmentInfoComments(QString qsShipmentInfoComments);

QString GetShipmentInfoCoupons();
int SetShipmentInfoCoupons(QString qsShipmentInfoCoupons);

QString GetShipmentInfoDeclaredValue();
int SetShipmentInfoDeclaredValue(QString qsShipmentInfoDeclaredValue);

QString GetShipmentInfoDeclaredValueUnits();
int SetShipmentInfoDeclaredValueUnits(QString qsShipmentInfoDeclaredValueUnits);

QString GetShipmentInfoEmergencyContactPhone();
int SetShipmentInfoEmergencyContactPhone(QString qsShipmentInfoEmergencyContactPhone);

QString GetShipmentInfoHazardousMaterialsOfferor();
int SetShipmentInfoHazardousMaterialsOfferor(QString qsShipmentInfoHazardousMaterialsOfferor);

QString GetShipmentInfoLiabilityCoverageAmount();
int SetShipmentInfoLiabilityCoverageAmount(QString qsShipmentInfoLiabilityCoverageAmount);

int GetShipmentInfoLiabilityCoverageType();
int SetShipmentInfoLiabilityCoverageType(int iShipmentInfoLiabilityCoverageType);

QString GetShipmentInfoPalletWeight();
int SetShipmentInfoPalletWeight(QString qsShipmentInfoPalletWeight);

int GetShipmentInfoRole();
int SetShipmentInfoRole(int iShipmentInfoRole);

int GetShipmentInfoTotalHandlingUnits();
int SetShipmentInfoTotalHandlingUnits(int iShipmentInfoTotalHandlingUnits);

int GetShipmentInfoTotalHeight();
int SetShipmentInfoTotalHeight(int iShipmentInfoTotalHeight);

int GetShipmentInfoTotalLength();
int SetShipmentInfoTotalLength(int iShipmentInfoTotalLength);

int GetShipmentInfoTotalWidth();
int SetShipmentInfoTotalWidth(int iShipmentInfoTotalWidth);

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 fields are required to be set:

AccountNumber
BillingAddress1
BillingCity
BillingState
BillingZipCode
BillingCountryCode
CollectTermsType
Role
TotalHandlingUnits

Data Type

DShippingSDKFreightShipmentDetail

ShipmentSpecialServices Property (FedExFreightShip Class)

Contains the collection of special services offered by FedEx.

Syntax

ANSI (Cross Platform)
int64 GetShipmentSpecialServices();
int SetShipmentSpecialServices(int64 lShipmentSpecialServices);

Unicode (Windows)
LONG64 GetShipmentSpecialServices();
INT SetShipmentSpecialServices(LONG64 lShipmentSpecialServices);

int64 dshippingsdk_fedexfreightship_getshipmentspecialservices(void* lpObj);
int dshippingsdk_fedexfreightship_setshipmentspecialservices(void* lpObj, int64 lShipmentSpecialServices);

qint64 GetShipmentSpecialServices();
int SetShipmentSpecialServices(qint64 lShipmentSpecialServices);

Default Value

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:


Value	Meaning
0x00000001L	Broker Select
0x00000004L	COD
0x00000010L	Dangerous Goods
0x00000020L	Do Not Break Down Pallets
0x00000040L	Do Not Stack Pallets
0x00000080L	Dry Ice
0x00000200L	Electronic Trade Documents
0x00000400L	Event Notification
0x00000800L	Extreme Length
0x00001000L	Food
0x00002000L	Freight Guarantee
0x00008000L	Hold At Location
0x00010000L	International Controlled Export Service
0x00040000L	Inside Delivery
0x00080000L	Inside Pickup
0x00100000L	Liftgate Delivery
0x00200000L	Liftgate Pickup
0x02000000L	Poison
0x04000000L	Protection From Freezing
0x10000000L	Saturday Delivery
0x20000000L	Saturday Pickup
0x40000000L	Top Load
0x10000000000L	International Traffic in Arms Regulations

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 HazardousMaterialsOptions must be selected and the EmergencyContactPhone 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 AddressFlags 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.

Data Type

Long64

SSLAcceptServerCert Property (FedExFreightShip Class)

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

Syntax

DShippingSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DShippingSDKCertificate* val);

char* dshippingsdk_fedexfreightship_getsslacceptservercerteffectivedate(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertexpirationdate(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertfingerprint(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertissuer(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertprivatekey(void* lpObj);

int dshippingsdk_fedexfreightship_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertpublickey(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dshippingsdk_fedexfreightship_getsslacceptservercertpublickeylength(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertserialnumber(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dshippingsdk_fedexfreightship_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dshippingsdk_fedexfreightship_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dshippingsdk_fedexfreightship_getsslacceptservercertstorepassword(void* lpObj);
int dshippingsdk_fedexfreightship_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dshippingsdk_fedexfreightship_getsslacceptservercertstoretype(void* lpObj);
int dshippingsdk_fedexfreightship_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dshippingsdk_fedexfreightship_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertusage(void* lpObj);

int dshippingsdk_fedexfreightship_getsslacceptservercertusageflags(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertversion(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslacceptservercertsubject(void* lpObj);
int dshippingsdk_fedexfreightship_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int dshippingsdk_fedexfreightship_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dshippingsdk_fedexfreightship_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

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

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

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

Data Type

DShippingSDKCertificate

SSLCert Property (FedExFreightShip Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

DShippingSDKCertificate* GetSSLCert();
int SetSSLCert(DShippingSDKCertificate* val);

char* dshippingsdk_fedexfreightship_getsslcerteffectivedate(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertexpirationdate(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertextendedkeyusage(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertfingerprint(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertfingerprintsha1(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertfingerprintsha256(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertissuer(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertprivatekey(void* lpObj);

int dshippingsdk_fedexfreightship_getsslcertprivatekeyavailable(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertprivatekeycontainer(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertpublickey(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertpublickeyalgorithm(void* lpObj);

int dshippingsdk_fedexfreightship_getsslcertpublickeylength(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertserialnumber(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertsignaturealgorithm(void* lpObj);

int dshippingsdk_fedexfreightship_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dshippingsdk_fedexfreightship_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* dshippingsdk_fedexfreightship_getsslcertstorepassword(void* lpObj);
int dshippingsdk_fedexfreightship_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int dshippingsdk_fedexfreightship_getsslcertstoretype(void* lpObj);
int dshippingsdk_fedexfreightship_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* dshippingsdk_fedexfreightship_getsslcertsubjectaltnames(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertthumbprintmd5(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertthumbprintsha1(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertthumbprintsha256(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertusage(void* lpObj);

int dshippingsdk_fedexfreightship_getsslcertusageflags(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertversion(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslcertsubject(void* lpObj);
int dshippingsdk_fedexfreightship_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int dshippingsdk_fedexfreightship_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dshippingsdk_fedexfreightship_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

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

Data Type

DShippingSDKCertificate

SSLProvider Property (FedExFreightShip Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dshippingsdk_fedexfreightship_getsslprovider(void* lpObj);
int dshippingsdk_fedexfreightship_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

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 as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (FedExFreightShip Class)

The server certificate for the last established connection.

Syntax

DShippingSDKCertificate* GetSSLServerCert();

char* dshippingsdk_fedexfreightship_getsslservercerteffectivedate(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertexpirationdate(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertextendedkeyusage(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertfingerprint(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertfingerprintsha1(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertfingerprintsha256(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertissuer(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertprivatekey(void* lpObj);

int dshippingsdk_fedexfreightship_getsslservercertprivatekeyavailable(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertprivatekeycontainer(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertpublickey(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertpublickeyalgorithm(void* lpObj);

int dshippingsdk_fedexfreightship_getsslservercertpublickeylength(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertserialnumber(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertsignaturealgorithm(void* lpObj);

int dshippingsdk_fedexfreightship_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dshippingsdk_fedexfreightship_getsslservercertstorepassword(void* lpObj);

int dshippingsdk_fedexfreightship_getsslservercertstoretype(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertsubjectaltnames(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertthumbprintmd5(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertthumbprintsha1(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertthumbprintsha256(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertusage(void* lpObj);

int dshippingsdk_fedexfreightship_getsslservercertusageflags(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertversion(void* lpObj);

char* dshippingsdk_fedexfreightship_getsslservercertsubject(void* lpObj);

int dshippingsdk_fedexfreightship_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DShippingSDKCertificate

SubmittedBy Property (FedExFreightShip Class)

Identifies the person who submitted the pickup request.

Syntax

DShippingSDKContactDetail* GetSubmittedBy();
int SetSubmittedBy(DShippingSDKContactDetail* val);

char* dshippingsdk_fedexfreightship_getsubmittedbycompany(void* lpObj);
int dshippingsdk_fedexfreightship_setsubmittedbycompany(void* lpObj, const char* lpszSubmittedByCompany);

char* dshippingsdk_fedexfreightship_getsubmittedbyemail(void* lpObj);
int dshippingsdk_fedexfreightship_setsubmittedbyemail(void* lpObj, const char* lpszSubmittedByEmail);

char* dshippingsdk_fedexfreightship_getsubmittedbyfax(void* lpObj);
int dshippingsdk_fedexfreightship_setsubmittedbyfax(void* lpObj, const char* lpszSubmittedByFax);

char* dshippingsdk_fedexfreightship_getsubmittedbyfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setsubmittedbyfirstname(void* lpObj, const char* lpszSubmittedByFirstName);

char* dshippingsdk_fedexfreightship_getsubmittedbylastname(void* lpObj);
int dshippingsdk_fedexfreightship_setsubmittedbylastname(void* lpObj, const char* lpszSubmittedByLastName);

char* dshippingsdk_fedexfreightship_getsubmittedbymiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setsubmittedbymiddleinitial(void* lpObj, const char* lpszSubmittedByMiddleInitial);

char* dshippingsdk_fedexfreightship_getsubmittedbyphone(void* lpObj);
int dshippingsdk_fedexfreightship_setsubmittedbyphone(void* lpObj, const char* lpszSubmittedByPhone);

QString GetSubmittedByCompany();
int SetSubmittedByCompany(QString qsSubmittedByCompany);

QString GetSubmittedByEmail();
int SetSubmittedByEmail(QString qsSubmittedByEmail);

QString GetSubmittedByFax();
int SetSubmittedByFax(QString qsSubmittedByFax);

QString GetSubmittedByFirstName();
int SetSubmittedByFirstName(QString qsSubmittedByFirstName);

QString GetSubmittedByLastName();
int SetSubmittedByLastName(QString qsSubmittedByLastName);

QString GetSubmittedByMiddleInitial();
int SetSubmittedByMiddleInitial(QString qsSubmittedByMiddleInitial);

QString GetSubmittedByPhone();
int SetSubmittedByPhone(QString qsSubmittedByPhone);

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.

Data Type

DShippingSDKContactDetail

Timeout Property (FedExFreightShip Class)

The timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dshippingsdk_fedexfreightship_gettimeout(void* lpObj);
int dshippingsdk_fedexfreightship_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

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 fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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.

Data Type

Integer

TotalCustomsValue Property (FedExFreightShip Class)

Total customs value for the shipment.

Syntax

ANSI (Cross Platform)
char* GetTotalCustomsValue();
int SetTotalCustomsValue(const char* lpszTotalCustomsValue);

Unicode (Windows)
LPWSTR GetTotalCustomsValue();
INT SetTotalCustomsValue(LPCWSTR lpszTotalCustomsValue);

char* dshippingsdk_fedexfreightship_gettotalcustomsvalue(void* lpObj);
int dshippingsdk_fedexfreightship_settotalcustomsvalue(void* lpObj, const char* lpszTotalCustomsValue);

QString GetTotalCustomsValue();
int SetTotalCustomsValue(QString qsTotalCustomsValue);

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:


Country Name
Algeria
Australia
Belarus
Canada
China
Serbia and Montenegro
Georgia
Indonesia
Japan
Kyrgyzstan
South Korea
Kuwait
Libya
Moldova
Montenegro
Mongolia
Nepal
New Zealand
Papua New Guinea
Romania
Serbia
Russian
Slovenia
Slovak Republic
El Salvador
Turkmenistan
Tonga
Uzbekistan
Samoa
Montenegro

Note this only applies when shipping internationally.

Data Type

String

TotalNetCharge Property (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
char* GetTotalNetCharge();

Unicode (Windows)
LPWSTR GetTotalNetCharge();

char* dshippingsdk_fedexfreightship_gettotalnetcharge(void* lpObj);

QString GetTotalNetCharge();

Default Value

Remarks

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

This property is read-only.

Data Type

String

TotalWeight Property (FedExFreightShip Class)

Total shipment weight.

Syntax

ANSI (Cross Platform)
char* GetTotalWeight();
int SetTotalWeight(const char* lpszTotalWeight);

Unicode (Windows)
LPWSTR GetTotalWeight();
INT SetTotalWeight(LPCWSTR lpszTotalWeight);

char* dshippingsdk_fedexfreightship_gettotalweight(void* lpObj);
int dshippingsdk_fedexfreightship_settotalweight(void* lpObj, const char* lpszTotalWeight);

QString GetTotalWeight();
int SetTotalWeight(QString qsTotalWeight);

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

Data Type

String

TrailerSize Property (FedExFreightShip Class)

The trailer size.

Syntax

ANSI (Cross Platform)
int GetTrailerSize();
int SetTrailerSize(int iTrailerSize);

Unicode (Windows)
INT GetTrailerSize();
INT SetTrailerSize(INT iTrailerSize);

Possible Values

TS_28FT(0), 
TS_48FT(1), 
TS_53FT(2)

int dshippingsdk_fedexfreightship_gettrailersize(void* lpObj);
int dshippingsdk_fedexfreightship_settrailersize(void* lpObj, int iTrailerSize);

int GetTrailerSize();
int SetTrailerSize(int iTrailerSize);

Default Value

Remarks

The size of the trailer needed when calling SchedulePickup.

Data Type

Integer

TransitTime Property (FedExFreightShip Class)

Expected number of days in transit from pickup to delivery.

Syntax

ANSI (Cross Platform)
char* GetTransitTime();

Unicode (Windows)
LPWSTR GetTransitTime();

char* dshippingsdk_fedexfreightship_gettransittime(void* lpObj);

QString GetTransitTime();

Default Value

Remarks

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

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

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

Data Type

String

TruckType Property (FedExFreightShip Class)

The type of truck.

Syntax

ANSI (Cross Platform)
int GetTruckType();
int SetTruckType(int iTruckType);

Unicode (Windows)
INT GetTruckType();
INT SetTruckType(INT iTruckType);

Possible Values

TT_DROP_TRAILER_AGREEMENT(0), 
TT_LIFTGATE(1), 
TT_TRACTOR_TRAILER_ACCESS(2)

int dshippingsdk_fedexfreightship_gettrucktype(void* lpObj);
int dshippingsdk_fedexfreightship_settrucktype(void* lpObj, int iTruckType);

int GetTruckType();
int SetTruckType(int iTruckType);

Default Value

Remarks

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

Data Type

Integer

UploadDocumentDetails Property (FedExFreightShip Class)

Collection of documents to be uploaded to FedEx.

Syntax

DShippingSDKList<DShippingSDKUploadDocumentDetail>* GetUploadDocumentDetails();
int SetUploadDocumentDetails(DShippingSDKList<DShippingSDKUploadDocumentDetail>* val);

int dshippingsdk_fedexfreightship_getuploaddocumentdetailcount(void* lpObj);
int dshippingsdk_fedexfreightship_setuploaddocumentdetailcount(void* lpObj, int iUploadDocumentDetailCount);

int dshippingsdk_fedexfreightship_getuploaddocumentdetaildoctype(void* lpObj, int uploaddocumentdetailindex);
int dshippingsdk_fedexfreightship_setuploaddocumentdetaildoctype(void* lpObj, int uploaddocumentdetailindex, int iUploadDocumentDetailDocType);

char* dshippingsdk_fedexfreightship_getuploaddocumentdetaildocumentid(void* lpObj, int uploaddocumentdetailindex);

char* dshippingsdk_fedexfreightship_getuploaddocumentdetailfilecontent(void* lpObj, int uploaddocumentdetailindex);
int dshippingsdk_fedexfreightship_setuploaddocumentdetailfilecontent(void* lpObj, int uploaddocumentdetailindex, const char* lpszUploadDocumentDetailFileContent);

char* dshippingsdk_fedexfreightship_getuploaddocumentdetaillocalfilename(void* lpObj, int uploaddocumentdetailindex);
int dshippingsdk_fedexfreightship_setuploaddocumentdetaillocalfilename(void* lpObj, int uploaddocumentdetailindex, const char* lpszUploadDocumentDetailLocalFileName);

int dshippingsdk_fedexfreightship_getuploaddocumentdetailshipdocument(void* lpObj, int uploaddocumentdetailindex);
int dshippingsdk_fedexfreightship_setuploaddocumentdetailshipdocument(void* lpObj, int uploaddocumentdetailindex, int bUploadDocumentDetailShipDocument);

char* dshippingsdk_fedexfreightship_getuploaddocumentdetailuploadfilename(void* lpObj, int uploaddocumentdetailindex);
int dshippingsdk_fedexfreightship_setuploaddocumentdetailuploadfilename(void* lpObj, int uploaddocumentdetailindex, const char* lpszUploadDocumentDetailUploadFileName);

int GetUploadDocumentDetailCount();
int SetUploadDocumentDetailCount(int iUploadDocumentDetailCount);

int GetUploadDocumentDetailDocType(int iUploadDocumentDetailIndex);
int SetUploadDocumentDetailDocType(int iUploadDocumentDetailIndex, int iUploadDocumentDetailDocType);

QString GetUploadDocumentDetailDocumentId(int iUploadDocumentDetailIndex);

QString GetUploadDocumentDetailFileContent(int iUploadDocumentDetailIndex);
int SetUploadDocumentDetailFileContent(int iUploadDocumentDetailIndex, QString qsUploadDocumentDetailFileContent);

QString GetUploadDocumentDetailLocalFileName(int iUploadDocumentDetailIndex);
int SetUploadDocumentDetailLocalFileName(int iUploadDocumentDetailIndex, QString qsUploadDocumentDetailLocalFileName);

bool GetUploadDocumentDetailShipDocument(int iUploadDocumentDetailIndex);
int SetUploadDocumentDetailShipDocument(int iUploadDocumentDetailIndex, bool bUploadDocumentDetailShipDocument);

QString GetUploadDocumentDetailUploadFileName(int iUploadDocumentDetailIndex);
int SetUploadDocumentDetailUploadFileName(int iUploadDocumentDetailIndex, QString qsUploadDocumentDetailUploadFileName);

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.

This property is not available at design time.

Data Type

DShippingSDKUploadDocumentDetail

UploadImageDetails Property (FedExFreightShip Class)

Collection of images to be uploaded to FedEx.

Syntax

DShippingSDKList<DShippingSDKUploadImageDetail>* GetUploadImageDetails();
int SetUploadImageDetails(DShippingSDKList<DShippingSDKUploadImageDetail>* val);

int dshippingsdk_fedexfreightship_getuploadimagedetailcount(void* lpObj);
int dshippingsdk_fedexfreightship_setuploadimagedetailcount(void* lpObj, int iUploadImageDetailCount);

char* dshippingsdk_fedexfreightship_getuploadimagedetailfilecontent(void* lpObj, int uploadimagedetailindex);
int dshippingsdk_fedexfreightship_setuploadimagedetailfilecontent(void* lpObj, int uploadimagedetailindex, const char* lpszUploadImageDetailFileContent);

char* dshippingsdk_fedexfreightship_getuploadimagedetailimageindex(void* lpObj, int uploadimagedetailindex);
int dshippingsdk_fedexfreightship_setuploadimagedetailimageindex(void* lpObj, int uploadimagedetailindex, const char* lpszUploadImageDetailImageIndex);

int dshippingsdk_fedexfreightship_getuploadimagedetailimagetype(void* lpObj, int uploadimagedetailindex);
int dshippingsdk_fedexfreightship_setuploadimagedetailimagetype(void* lpObj, int uploadimagedetailindex, int iUploadImageDetailImageType);

char* dshippingsdk_fedexfreightship_getuploadimagedetaillocalfilename(void* lpObj, int uploadimagedetailindex);
int dshippingsdk_fedexfreightship_setuploadimagedetaillocalfilename(void* lpObj, int uploadimagedetailindex, const char* lpszUploadImageDetailLocalFileName);

char* dshippingsdk_fedexfreightship_getuploadimagedetailreference(void* lpObj, int uploadimagedetailindex);
int dshippingsdk_fedexfreightship_setuploadimagedetailreference(void* lpObj, int uploadimagedetailindex, const char* lpszUploadImageDetailReference);

char* dshippingsdk_fedexfreightship_getuploadimagedetailstatus(void* lpObj, int uploadimagedetailindex);

char* dshippingsdk_fedexfreightship_getuploadimagedetailuploadfilename(void* lpObj, int uploadimagedetailindex);
int dshippingsdk_fedexfreightship_setuploadimagedetailuploadfilename(void* lpObj, int uploadimagedetailindex, const char* lpszUploadImageDetailUploadFileName);

int GetUploadImageDetailCount();
int SetUploadImageDetailCount(int iUploadImageDetailCount);

QString GetUploadImageDetailFileContent(int iUploadImageDetailIndex);
int SetUploadImageDetailFileContent(int iUploadImageDetailIndex, QString qsUploadImageDetailFileContent);

QString GetUploadImageDetailImageIndex(int iUploadImageDetailIndex);
int SetUploadImageDetailImageIndex(int iUploadImageDetailIndex, QString qsUploadImageDetailImageIndex);

int GetUploadImageDetailImageType(int iUploadImageDetailIndex);
int SetUploadImageDetailImageType(int iUploadImageDetailIndex, int iUploadImageDetailImageType);

QString GetUploadImageDetailLocalFileName(int iUploadImageDetailIndex);
int SetUploadImageDetailLocalFileName(int iUploadImageDetailIndex, QString qsUploadImageDetailLocalFileName);

QString GetUploadImageDetailReference(int iUploadImageDetailIndex);
int SetUploadImageDetailReference(int iUploadImageDetailIndex, QString qsUploadImageDetailReference);

QString GetUploadImageDetailStatus(int iUploadImageDetailIndex);

QString GetUploadImageDetailUploadFileName(int iUploadImageDetailIndex);
int SetUploadImageDetailUploadFileName(int iUploadImageDetailIndex, QString qsUploadImageDetailUploadFileName);

Remarks

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

This property is not available at design time.

Data Type

DShippingSDKUploadImageDetail

CancelPackage Method (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int CancelPackage(const char* lpszTrackingNumber);

Unicode (Windows)
INT CancelPackage(LPCWSTR lpszTrackingNumber);

int dshippingsdk_fedexfreightship_cancelpackage(void* lpObj, const char* lpszTrackingNumber);

int CancelPackage(const QString& qsTrackingNumber);

Remarks

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

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

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

AccountNumber (required)
CountryCode

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CancelPickup Method (FedExFreightShip Class)

Cancels a scheduled Pickup request.

Syntax

ANSI (Cross Platform)
char* CancelPickup(const char* lpszConfirmationNumber, const char* lpszReason);

Unicode (Windows)
LPWSTR CancelPickup(LPCWSTR lpszConfirmationNumber, LPCWSTR lpszReason);

char* dshippingsdk_fedexfreightship_cancelpickup(void* lpObj, const char* lpszConfirmationNumber, const char* lpszReason);

QString CancelPickup(const QString& qsConfirmationNumber, const QString& qsReason);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CancelShipment Method (FedExFreightShip Class)

Cancels all packages within the shipment.

Syntax

ANSI (Cross Platform)
int CancelShipment(const char* lpszTrackingNumber);

Unicode (Windows)
INT CancelShipment(LPCWSTR lpszTrackingNumber);

int dshippingsdk_fedexfreightship_cancelshipment(void* lpObj, const char* lpszTrackingNumber);

int CancelShipment(const QString& qsTrackingNumber);

Remarks

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

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

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

AccountNumber (required)
CountryCode

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

Error Handling (C++)

Config Method (FedExFreightShip Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dshippingsdk_fedexfreightship_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

GetPackageLabel Method (FedExFreightShip Class)

Generates a shipping label for the specified package.

Syntax

ANSI (Cross Platform)
int GetPackageLabel(int iIndex);

Unicode (Windows)
INT GetPackageLabel(INT iIndex);

int dshippingsdk_fedexfreightship_getpackagelabel(void* lpObj, int iIndex);

int GetPackageLabel(int iIndex);

Remarks

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

AuthorizationToken (required)
Server (optional)
AccountNumber (required)
ShipDate (required)
ShipTime (optional)
ServiceType (required)
PackagingType (required)
TotalWeight (optional; applicable to international shipments only)
WeightUnit (required; defaults to LB)
SizeUnit (required; defaults to IN)
InsuredValue (optional)
SenderContact (required)
SenderAddress (required)
RecipientContact (required)
RecipientAddress (required)
Payor (required)
ShipmentSpecialServices (optional)
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 fields:

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

To print out the ShippingLabel, you can save it to the ShippingLabelFile file in LabelImageType format.

Error Handling (C++)

GetShipmentLabels Method (FedExFreightShip Class)

Generates a shipping label for all packages in the shipment.

Syntax

ANSI (Cross Platform)
int GetShipmentLabels();

Unicode (Windows)
INT GetShipmentLabels();

int dshippingsdk_fedexfreightship_getshipmentlabels(void* lpObj);

int GetShipmentLabels();

Remarks

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

AuthorizationToken (required)
Server (optional)
AccountNumber (required)
ShipDate (required)
ShipTime (optional)
ServiceType (required)
PackagingType (required)
TotalWeight (optional; applicable to international shipments only)
WeightUnit (required; defaults to LB)
SizeUnit (required; defaults to IN)
InsuredValue (optional)
SenderContact (required)
SenderAddress (required)
RecipientContact (required)
RecipientAddress (required)
Payor (required)
ShipmentSpecialServices (optional)
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)

This method fills in the following fields:

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

To print out the ShippingLabel, you can save it to the ShippingLabelFile file in LabelImageType format.

Error Handling (C++)

PickupAvailability Method (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int PickupAvailability();

Unicode (Windows)
INT PickupAvailability();

int dshippingsdk_fedexfreightship_pickupavailability(void* lpObj);

int PickupAvailability();

Remarks

The PickupAvailability method requires the values for the following properties:

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

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

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

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

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

The PickupAvailability method requires the values for the following properties:

ServiceType (required)
Address1 (required)
City (optional)
State (optional)
ZipCode (required)
CountryCode (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 Length, Width, and Height.

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

Error Handling (C++)

ReprintDocuments Method (FedExFreightShip Class)

Reprints the requested document.

Syntax

ANSI (Cross Platform)
int ReprintDocuments();

Unicode (Windows)
INT ReprintDocuments();

int dshippingsdk_fedexfreightship_reprintdocuments(void* lpObj);

int ReprintDocuments();

Remarks

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

Error Handling (C++)

Reset Method (FedExFreightShip Class)

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

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dshippingsdk_fedexfreightship_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

SchedulePickup Method (FedExFreightShip Class)

This method schedules a courier pickup.

Syntax

ANSI (Cross Platform)
char* SchedulePickup();

Unicode (Windows)
LPWSTR SchedulePickup();

char* dshippingsdk_fedexfreightship_schedulepickup(void* lpObj);

QString SchedulePickup();

Remarks

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

The following properties are applicable:

Company (optional)
Email (optional)
Fax (optional)
FirstName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
LastName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
MiddleInitial (optional)
Phone (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.)
FreightPackagingType (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
Weight (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
HandlingUnits (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
PONumber (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)
Address1 (optional)
Address2 (optional)
City(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
State(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
ZipCode(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
CountryCode (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
Address1 (required when UseAccountAddress is false)
Address2 (optional)
City (required when UseAccountAddress is false)
State (required when UseAccountAddress is false)
ZipCode (required when UseAccountAddress is false)
CountryCode (required when UseAccountAddress is false)
Company (required when UseAccountAddress is false)
Email (optional)
Fax (optional)
FirstName (required when UseAccountAddress is false)
LastName (required when UseAccountAddress is false)
MiddleInitial (optional)
Phone (required when UseAccountAddress is false)
ServiceType (required)
ShipDate (required)
ShipTime (optional)
SpecialInstructions (optional)
Company (optional)
Email (optional)
Fax (optional)
FirstName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
LastName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
MiddleInitial (optional)
Phone (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.

Error Handling (C++)

UploadDocuments Method (FedExFreightShip Class)

Uploads documents to FedEx.

Syntax

ANSI (Cross Platform)
int UploadDocuments();

Unicode (Windows)
INT UploadDocuments();

int dshippingsdk_fedexfreightship_uploaddocuments(void* lpObj);

int UploadDocuments();

Remarks

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

Error Handling (C++)

UploadImages Method (FedExFreightShip Class)

Uploads images to FedEx.

Syntax

ANSI (Cross Platform)
int UploadImages();

Unicode (Windows)
INT UploadImages();

int dshippingsdk_fedexfreightship_uploadimages(void* lpObj);

int UploadImages();

Remarks

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

Error Handling (C++)

Error Event (FedExFreightShip Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(FedExFreightShipErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FedExFreightShipErrorEventParams;


Unicode (Windows)
virtual INT FireError(FedExFreightShipErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FedExFreightShipErrorEventParams;

#define EID_FEDEXFREIGHTSHIP_ERROR 1

virtual INT DSHIPPINGSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FedExFreightShipErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FedExFreightShipErrorEventParams *e);

// Or, subclass FedExFreightShip and override this emitter function.
virtual int FireError(FedExFreightShipErrorEventParams *e) {...}

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

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(FedExFreightShipNotificationEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FedExFreightShipNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(FedExFreightShipNotificationEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FedExFreightShipNotificationEventParams;

#define EID_FEDEXFREIGHTSHIP_NOTIFICATION 2

virtual INT DSHIPPINGSDK_CALL FireNotification(LPSTR &lpszMessage);

class FedExFreightShipNotificationEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(FedExFreightShipNotificationEventParams *e);

// Or, subclass FedExFreightShip and override this emitter function.
virtual int FireNotification(FedExFreightShipNotificationEventParams *e) {...}

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

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FedExFreightShipSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} FedExFreightShipSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(FedExFreightShipSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} FedExFreightShipSSLServerAuthenticationEventParams;

#define EID_FEDEXFREIGHTSHIP_SSLSERVERAUTHENTICATION 3

virtual INT DSHIPPINGSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class FedExFreightShipSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(FedExFreightShipSSLServerAuthenticationEventParams *e);

// Or, subclass FedExFreightShip and override this emitter function.
virtual int FireSSLServerAuthentication(FedExFreightShipSSLServerAuthenticationEventParams *e) {...}

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

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(FedExFreightShipSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FedExFreightShipSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(FedExFreightShipSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FedExFreightShipSSLStatusEventParams;

#define EID_FEDEXFREIGHTSHIP_SSLSTATUS 4

virtual INT DSHIPPINGSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class FedExFreightShipSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(FedExFreightShipSSLStatusEventParams *e);

// Or, subclass FedExFreightShip and override this emitter function.
virtual int FireSSLStatus(FedExFreightShipSSLStatusEventParams *e) {...}

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.

Syntax

DShippingSDKAddressDetail (declared in dshippingsdk.h)

Remarks

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

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

The fields contained by this type are listed below.

The following fields are available:

Address1
Address2
AddressFlags
City
CountryCode
State
ZipCode

Fields

Address1
char*
Default Value: ""

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS Address1 should not exceed 35 characters.

Address2
char*
Default Value: ""

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS Address2 should not exceed 35 characters.

AddressFlags
int
Default Value: 0

Various flags that denote information about the address.


Value	Meaning
0x00000001	POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses.
0x00000002	Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial.

City
char*
Default Value: ""

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

CountryCode
char*
Default Value: "US"

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.


Country Name	Country Code
Afghanistan	AF
Albania	AL
American Samoa	AS
Andorra	AD
Angola	AO
Anguilla	AI
Antigua	AG*
Argentina	AR
Armenia	AM
Aruba	AW
Australia	AU
Austria	AT
Azerbaijan	AZ
Bahamas	BS
Bahrain	BH
Bangladesh	BD
Barbados	BB
Barbuda	AG*
Belarus	BY
Belgium	BE
Belize	BZ
Benin	BJ
Bermuda	BM
Bhutan	BT
Bolivia	BO
Bonaire	AN**
Bosnia-Herzegovina	BA
Botswana	BW
Brazil	BR
British Virgin Islands	VG*
Brunei	BN
Bulgaria	BG
Burkina Faso	BF
Burundi	BI
Cambodia	KH
Cameroon	CM
Canada	CA
Canary Islands	ES**
Cape Verde	CV
Cayman Islands	KY**
Chad	TD
Channel Islands	GB**
Chile	CL
China	CN
Colombia	CO
Congo	CG
Congo Dem. Rep. Of	CD
Cook Islands	CK
Costa Rica	CR
Croatia	HR
Curacao	AN**
Cyprus	CY
Czech Republic	CZ
Denmark	DK
Djibouti	DJ
Dominica	DM
Dominican Republic	DO
East Timor	TL
Ecuador	EC
Egypt	EG
El Salvador	SV
England	GB**
Equatorial Guinea	GQ
Eritrea	ER
Estonia	EE
Ethiopia	ET
Faeroe Islands	FO*
Fiji	FJ
Finland	FI
France	FR
French Guiana	GF
French Polynesia	PF**
Gabon	GA
Gambia	GM
Georgia	GE
Germany	DE
Ghana	GH
Gibraltar	GI
Grand Cayman	KY**
Great Britain	GB**
Great Thatch Island	VG*
Great Tobago Islands	VG*
Greece	GR
Greenland	GL
Grenada	GD
Guadeloupe	GP**
Guam	GU
Guatemala	GT
Guinea	GN
Guyana	GY
Haiti	HT
Holland	NL**
Honduras	HN
Hong Kong	HK
Hungary	HU
Iceland	IS
India	IN
Indonesia	ID
Iraq	IQ
Ireland	IE
Israel	IL
Italy	IT**
Ivory Coast	CI
Jamaica	JM
Japan	JP
Jordan	JO
Jost Van Dyke Islands	VG*
Kazakhstan	KZ
Kenya	KE
Kuwait	KW
Kyrgyzstan	KG
Laos	LA
Latvia	LV
Lebanon	LB
Lesotho	LS
Liberia	LR
Liechtenstein	LI
Lithuania	LT
Luxembourg	LU
Macau	MO
Macedonia	MK
Madagascar	MG
Malawi	MW
Malaysia	MY
Maldives	MV
Mali	ML
Malta	MT
Marshall Islands	MH
Martinique	MQ
Mauritania	MR
Mauritius	MU
Mexico	MX
Micronesia	FM
Moldova	MD
Monaco	MC
Mongolia	MN
Montserrat	MS
Morocco	MA
Mozambique	MZ
Namibia	NA
Nepal	NP
Netherlands	NL**
Netherlands Antilles	AN**
New Caledonia	NC
New Zealand	NZ
Nicaragua	NI
Niger	NE
Nigeria	NG
Norman Island	VG*
Northern Ireland	GB**
Northern Mariana Islands	MP**
Norway	NO
Oman	OM
Pakistan	PK
Palau	PW
Palestine	PS*
Panama	PA
Papua New Guinea	PG
Paraguay	PY
Peru	PE
Philippines	PH
Poland	PL
Portugal	PT
Puerto Rico	PR
Qatar	QA
Reunion	RE
Romania	RO
Rota	MP**
Russia	RU
Rwanda	RW
Saba	AN**
Saipan	MP**
Samoa	WS
San Marino	IT**
Saudi Arabia	SA
Scotland	GB**
Senegal	SN
Serbia & Montenegro	CS
Seychelles	SC
Singapore	SG
Slovak Republic	SK
Slovenia	SI
South Africa	ZA
South Korea	KR
Spain	ES**
Sri Lanka	LK
St. Barthelemy	GP**
St. Christopher	KN**
St. Croix Island	VI**
St. Eustatius	AN**
St. John	VI**
St. Kitts and Nevis	KN**
St. Lucia	LC
St. Maarten	AN**
St. Thomas	VI**
St. Vincent	VC**
Suriname	SR
Swaziland	SZ
Sweden	SE
Switzerland	CH
Tahiti	PF**
Taiwan	TW
Tanzania	TZ
Thailand	TH
Tinian	MP**
Togo	TG
Tonga	TO
Tortola Island	VG*
Trinidad & Tobago	TT
Tunisia	TN
Turkey	TR
Turkmenistan	TM
Turks & Caicos Islands	TC
U.S. Virgin Islands	VI**
Uganda	UG
Ukraine	UA
Union Island	VC**
United Arab Emirates	AE
United Kingdom	GB**
United States	US
Uruguay	UY
Uzbekistan	UZ
Vanuatu	VU
Vatican City	IT**
Venezuela	VE
Vietnam	VN
Wales	GB**
Wallis & Futuna Islands	WF
Yemen	YE
Zambia	ZM
Zimbabwe	ZW

* Not supported by USPS

** Has multiple values, the values used for USPS are below


Country Name	Country Code
Cayman Islands	KY
French Polynesia	PF
Guadeloupe	GP
Italy	IT
Netherlands	NL
Netherlands Antilles	AN
Northern Mariana Islands	MP
Spain	ES
St. Kitts and Nevis	KN
St. Vincent	VC
United Kingdom	GB
U.S. Virgin Islands	VI

State
char*
Default Value: ""

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

ZipCode
char*
Default Value: ""

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both City and State are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Constructors

AddressDetail()

Certificate Type

This is the digital certificate being used.

Syntax

DShippingSDKCertificate (declared in dshippingsdk.h)

Remarks

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

The following fields are available:

Fields

EffectiveDate
char* (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
char* (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
char* (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
char* (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
char* (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
char* (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
int (read-only)
Default Value: FALSE

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
char* (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
char* (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
char* (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
char* (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
char* (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
char*
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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

StorePassword
char*
Default Value: ""

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

StoreType
int
Default Value: 0

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 field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
char* (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
char* (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
char* (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
char* (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
char* (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
char*
Default Value: ""

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


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Encoded
char*
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

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

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

CommercialInvoiceDetail Type

Represents the commercial invoice (CI) information.

Syntax

DShippingSDKCommercialInvoiceDetail (declared in dshippingsdk.h)

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.

The following fields are available:

Comments
Date
FreightCharge
Insurance
Number
Purpose
Terms

Fields

Comments
char*
Default Value: ""

Commercial Invoice comments to be uploaded to customs. This can be any extra information about the current shipment and is optional.

Date
char*
Default Value: ""

Date when the Invoice is created. This is optional for Partial Invoice, but required for Invoice form for forward shipments. For shipment with return service, the user input will be ignored, and the field will be blank on the invoice.

If not set, it will default to the ship date. Format is YYYYMMDD.

NOTE: This field is only valid for UPS.

FreightCharge
char*
Default Value: "0.00"

Cost to transport the shipment. This is required if Terms is set to Cfr, Cpt, Cif, or Cip. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

Insurance
char*
Default Value: "0.00"

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. This is required if Terms is set to Cif or Cip.. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

Number
char*
Default Value: ""

Customer's assigned invoice number. This is optional. If included in the request, this element prints on the shipping label and commercial invoice.

Purpose
int
Default Value: 0

Reason to export the current international shipment

Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.

Valid values are:


Value	FedEx	UPS
cipSold (0)	X	X
cipGift (1)	X	X
cipNotSold (2)	X
cipPersonalEffects (3)	X
cipReturn (4)		X
cipRepair (5)		X
cipRepairAndReturn (6)	X
cipSample (7)	X	X
cipInterCompanyData (8)		X

Terms
int
Default Value: 0

Indicates the rights to the seller from the buyer.

Valid values are:


Value	Meaning	FedEx	UPS
citFca (0)	Free Carrier	X	X
citFob (1)	Free On Board/Free Carrier	X	X
citFas (2)	Free Alongside Ship		X
citCfr (3)	Cost and Freight	X	X
citCif (4)	Cost, Insurance and Freight	X	X
citCip (5)	Carriage and Insurance Paid	X	X
citCpt (6)	Carriage Paid To	X	X
citDaf (7)	Delivered at Frontier		X
citDdp (8)	Delivery Duty Paid	X	X
citDdu (9)	Delivery Duty Unpaid	X	X
citDeq (10)	Delivered Ex Quay		X
citDes (11)	Delivered Ex Ship		X
citExw (12)	Ex Works	X	X

Constructors

CommercialInvoiceDetail()

CommercialInvoiceDetail(const char* lpszComments, const char* lpszFreightCharge, const char* lpszInsurance, int iPurpose, const char* lpszNumber, int iTerms)

ContactDetail Type

Represents the contact information.

Syntax

DShippingSDKContactDetail (declared in dshippingsdk.h)

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.

The following fields are available:

Company
Email
Fax
FirstName
LastName
MiddleInitial
Phone

Fields

Company
char*
Default Value: ""

Identifies the contact person's company name. In a ship request, either FirstName and LastName or Company are required to be provided.

Email
char*
Default Value: ""

Identifies the contact person's email address. Maximum length: 120.

Fax
char*
Default Value: ""

Recipient's fax number. The value of this field is optional. No format checking is done on international fax numbers.

FirstName
char*
Default Value: ""

Sender's first name. The value of this property is required. Values for either FirstName and LastName or Company must be sent.

LastName
char*
Default Value: ""

Person's last name. The value of this field is required. Values for either FirstName and LastName or Company must be sent. Maximum length: 45 characters for both names or company name.

MiddleInitial
char*
Default Value: ""

Middle initial. The value of this field is optional.

Phone
char*
Default Value: ""

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Constructors

ContactDetail()

ContactDetail(const char* lpszFirstName, const char* lpszLastName, const char* lpszPhone)

ContactDetail(const char* lpszFirstName, const char* lpszLastName, const char* lpszPhone, const char* lpszEmail)

ContactDetail(const char* lpszFirstName, const char* lpszLastName, const char* lpszPhone, const char* lpszEmail, const char* lpszCompany)

FedExAccount Type

Represents the details of a FedEx account.

Syntax

DShippingSDKFedExAccount (declared in dshippingsdk.h)

Remarks

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

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

The fields contained by this type are listed below.

The following fields are available:

AccountNumber
AuthorizationToken
LanguageCode
LocaleCode
Server

Fields

AccountNumber
char*
Default Value: ""

The account number associated with the shipment.

The AccountNumber is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

AuthorizationToken
char*
Default Value: ""

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

LanguageCode
char*
Default Value: "en"

Two-letter code for the language (e.g. en, fr, etc.).

This field allows you to assign the language code. Default value is en.

LocaleCode
char*
Default Value: "US"

Two-letter code for the region (e.g. US, CA, etc.).

Some languages require a locale code to further identify the language. Default value is US.

Server
char*
Default Value: ""

URL for the FedEx Server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

Constructors

FedExAccount()

Firewall Type

The firewall the component will connect through.

Syntax

DShippingSDKFirewall (declared in dshippingsdk.h)

Remarks

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

The following fields are available:

AutoDetect
FirewallType
Host
Password
Port
User

Fields

AutoDetect
int
Default Value: FALSE

Whether to automatically detect and use firewall system settings, if available.

FirewallType
int
Default Value: 0

The type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
char*
Default Value: ""

The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.

Password
char*
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Port
int
Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
char*
Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Constructors

Firewall()

FreightCommodityDetail Type

Represents a single commodity line item.

Syntax

DShippingSDKFreightCommodityDetail (declared in dshippingsdk.h)

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.

The following fields are available:

Fields

Description
char*
Default Value: ""

Complete and accurate description of this commodity line item.

It is applicable to all international forms and freight shipments. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

If the shipment contains documents only (i.e., Documents is set to True), then the Description has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.


Description
Correspondence/No Commercial Value	Leases
Accounting Documents	Legal Documents
Analysis Reports	Letters and Cards
Applications (Completed)	Letter of Credit Packets
Bank Statements	Loan Documents
Bid Quotations	Marriage Certificates
Birth Certificates	Medical Records
Bills of Sale	Office Records
Bonds	Operating Agreements
Business Correspondence	Patent Applications
Checks (Completed)	Permits
Claim Files	Photocopies
Closing Statements	Proposals
Conference Reports	Prospectuses
Contracts	Purchase Orders
Cost Estimates	Quotations
Court Transcripts	Reservation Confirmation
Credit Applications	Resumes
Data Sheets	Sales Agreements
Deeds	Sales Reports
Employment Papers	Shipping Documents
Escrow Instructions	Statements/Reports
Export Papers	Statistical Data
Financial Statements	Stock Information
Immigration Papers	Tax Papers
Income Statements	Trade Confirmation
Insurance Documents	Transcripts
Interoffice Memos	Warranty Deeds
Inventory Reports
Invoices (Completed)

FreightClass
int
Default Value: 0

Indicates the freight class of the commodity.

The following table lists freight classes available from FedEx freight services.


Freight Class
50
55
60
65
70
77.5
85
92.5
100
110
125
150
175
200
250
300
400
500

FreightPackagingType
int
Default Value: 0

Identifies the Commodity item's packaging type. Possible values are:


fcptNone (0)
fcptBag (1)
fcptBarrel (2)
fcptBasket (3)
fcptBox (4)
fcptBucket (5)
fcptBundle (6)
fcptCage (7)
fcptCarton (8)
fcptCase (9)
fcptChest (10)
fcptContainer (11)
fcptCrate (12)
fcptCylinder (13)
fcptDrum (14)
fcptEnvelope (15)
fcptHamper (16)
fcptOther (17)
fcptPackage (18)
fcptPail (19)
fcptPallet (20)
fcptParcel (21)
fcptPiece (22)
fcptReel (23)
fcptRoll (24)
fcptSack (25)
fcptShrinkwrapped (26)
fcptSkid (27)
fcptTank (28)
fcptTotebin (29)
fcptTube (30)
fcptUnit (31)

HandlingUnits
int
Default Value: 1

Number of individual handling units to which this commodity applies. (NOTE: Total of commodity-level handling units may not balance to shipment-level total handling units.)

HarmonizedCode
char*
Default Value: ""

Unique code representing this commodity line item (for imports only).

The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.

It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in Description, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the HarmonizedCode is required for each commodity line item for shipments to EU countries.

At least one occurrence is required for U.S. Export shipments if the TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required.

HazardousMaterialsOptions
int
Default Value: 0

Indicates the kind of hazardous material content in this commodity.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple options:


Value	Meaning
0x00000001	Hazardous Materials
0x00000002	Battery
0x00000004	Other Regulated Materials - Domestic (ORM-D)
0x00000008	Reportable Quantities
0x00000010	Small Quantity Exception
0x00000020	Limited Quantities Commodities

Height
int
Default Value: 1

The height of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Id
char*
Default Value: ""

A unique identifier assigned to this line item.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Length
int
Default Value: 1

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Manufacturer
char*
Default Value: "US"

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the Manufacturer is required to be entered.

In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the Manufacturer and Description are required to be provided in the request. If the Manufacturer is not provided, it defaults to US.

When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The Manufacturer has to be provided for each commodity item included in that international shipment.

In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice.

Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.

Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.


Country Name	Country Code	Currency Code	Max Weight	Address Validation Supported	Postal Code Req.	Euro Country
Albania	AL	ALL	70 KGS	No	No	No
Algeria	DZ	DZD	70 KGS	No	No	No
Andorra	AD	PTS	70 KGS	No	No	No
Angola	AO	AOK	70 KGS	No	No	No
Anguilla	AI	XCD	150 LBS	No	No	No
Antigua & Barbuda	AG	XCD	150 LBS	No	No	No
Argentina	AR	ARP	70 KGS	Yes	Yes	No
Armenia	AM	USD	70 KGS	No	Yes	No
Aruba	AW	AWG	150 LBS	No	No	No
Australia	AU	AUD	70 KGS	Yes	Yes	No
Austria (EU Member)	AT	EUR	70 KGS	No	Yes	Yes
Azerbaijan	AZ	RUR	70 KGS	No	Yes	No
Bahamas	BS	BSD	150 LBS	No	No	No
Bahrain	BH	BHD	70 KGS	No	No	No
Bangladesh	BD	BDT	70 KGS	No	Yes	No
Barbados	BB	BBD	150 LBS	No	No	No
Belarus	BY	RUR	70 KGS	No	Yes	No
Belgium (EU Member)	BE	EUR	70 KGS	No	Yes	Yes
Belize	BZ	BZD	150 LBS	No	No	No
Benin	BJ	XOF	70 KGS	No	No	No
Bermuda	BM	BMD	150 LBS	No	No	No
Bolivia	BO	BOP	70 KGS	No	No	No
Bosnia-Herzegovina	BA	BAD	70 KGS	No	Yes	No
Botswana	BW	BWP	70 KGS	No	No	No
Brazil	BR	BRC	70 KGS	Yes	Yes	No
British Virgin Islands	VG	USD	150 LBS	No	No	No
Brunei	BN	BND	70 KGS	No	No	No
Bulgaria	BG	BGL	70 KGS	No	Yes	No
Burkina Faso	BF	XOF	70 KGS	No	No	No
Burundi	BI	BIF	70 KGS	No	No	No
Cambodia	KH	USD	70 KGS	No	No	No
Cameroon	CM	XAF	70 KGS	No	No	No
Canada	CA	CAD	150 LBS	Yes	Yes	No
Cape Verde	CV	USD	70 KGS	No	No	No
Cayman Islands	KY	KYD	150 LBS	No	No	No
Central African Rep	CF	XAF	70 KGS	No	No	No
Chad	TD	XAF	70 KGS	No	No	No
Channel Islands	CD	GBP	70 KGS	No	Yes	No
Chile	CL	CLP	70 KGS	Yes	No	No
China	CN	CNY	70 KGS	Yes	Yes	No
Colombia	CO	COP	70 KGS	Yes	No	No
Congo	CG	XAF	70 KGS	No	No	No
Cook Islands	CK	NZD	70 KGS	No	No	No
Costa Rica	CR	CRC	70 KGS	No	No	No
Croatia	HR	YUD	70 KGS	No	Yes	No
Cyprus	CY	CYP	70 KGS	No	No	No
Czech Republic	CZ	CZK	70 KGS	No	Yes	No
Dem Rep of Congo (Zaire)	ZR	ZRZ	70 KGS	No	No	No
Denmark (EU Member)	DK	DKK	70 KGS	Yes	Yes	Yes
Djibouti	DJ	DJF	70 KGS	No	No	No
Dominica	DM	XCD	150 LBS	No	No	No
Dominican Republic	DO	DOP	150 LBS	No	No	No
Ecuador	EC	ECS	70 KGS	No	No	No
Egypt	EG	EGP	70 KGS	No	No	No
El Salvador	SV	SVC	70 KGS	No	No	No
Equatorial Guinea	GQ	XAF	70 KGS	No	No	No
Eritrea	ER	DKK	70 KGS	No	No	No
Estonia	EE	EEK	70 KGS	No	Yes	No
Ethiopia	ET	ETB	70 KGS	No	No	No
Faeroe Islands	FO	DKK	70 KGS	No	Yes	No
Fiji	FJ	FJD	70 KGS	No	No	No
Finland (EU Member)	FI	EUR	70 KGS	No	Yes	Yes
France (EU Member)	FR	EUR	70 KGS	Yes	Yes	Yes
French Guiana	GF	FRF	70 KGS	No	No	No
French Polynesia	PF	XPF	70 KGS	No	No	No
Gabon	GA	XAF	70 KGS	No	No	No
Gambia	GM	GMD	70 KGS	No	No	No
Georgia	GE	RUR	70 KGS	No	Yes	No
Germany (EU Member)	DE	EUR	70 KGS	Yes	Yes	Yes
Ghana	GH	GHC	70 KGS	No	No	No
Gibraltar	GI	GIP	70 KGS	No	No	No
Greece (EU Member)	GR	EUR	70 KGS	No	Yes	Yes
Greenland	GL	DKK	70 KGS	No	Yes	No
Grenada	GD	XCD	150 LBS	No	No	No
Guadeloupe	GP	FRF	150 LBS	No	No	No
Guam	GU	USD	150 LBS	No	No	No
Guatemala	GT	GTO	70 KGS	No	No	No
Guinea	GN	GNS	70 KGS	No	No	No
Guinea-Bissau	GW	GWP	70 KGS	No	No	No
Guyana	GY	GYD	70 KGS	No	No	No
Haiti	HT	HTG	150 LBS	No	No	No
Honduras	HN	HNL	70 KGS	No	No	No
Hong Kong	HK	HKD	70 KGS	No	No	No
Hungary	HU	HUF	70 KGS	No	Yes	Yes
Iceland	IS	ISK	70 KGS	No	Yes	Yes
India	IN	INR	70 KGS	Yes	Yes	No
Indonesia	ID	IDR	70 KGS	No	Yes	No
Iran	IR	IRR	70 KGS	No	No	No
Iraq	IQ	IQD	70 KGS	No	No	No
Ireland (EU Member)	IE	EUR	70 KGS	Yes	No	Yes
Israel	IL	ILS	70 KGS	No	Yes	Yes
Italy (EU Member)	IT	EUR	70 KGS	Yes	Yes	Yes
Ivory Coast	CI	XOF	70 KGS	No	No	No
Jamaica	JM	KMD	70 KGS	No	No	No
Japan	JP	JPY	70 KGS	Yes	Yes	No
Jordan	JO	JOD	70 KGS	No	No	No
Kazakhstan	KZ	RUR	70 KGS	No	Yes	No
Kenya	KE	KES	70 KGS	No	No	No
Kiribati	KI	AUD	70 KGS	No	No	No
Kuwait	KW	KWD	70 KGS	No	No	No
Kyrgyzstan	KG	RUR	70 KGS	No	Yes	No
Laos	LA	USD	70 KGS	No	No	No
Latvia	LV	RUR	70 KGS	No	Yes	No
Lebanon	LB	LBP	70 KGS	No	No	No
Lesotho	LS	ZAR	70 KGS	No	No	No
Liberia	LR	LRD	70 KGS	No	No	No
Libya	LY	LYD	70 KGS	No	No	No
Liechtenstein	LI	CHF	70 KGS	No	Yes	No
Lithuania	LT	LTL	70 KGS	No	Yes	No
Luxembourg	LU	LUF	70 KGS	No	Yes	Yes
Macau	MO	MOP	70 KGS	No	No	No
Macedonia (FYROM)	MK	USD	70 KGS	No	Yes	Yes
Madagascar	MG	MGF	70 KGS	No	No	No
Malawi	MW	MWK	70 KGS	No	No	No
Malaysia	MY	MYR	70 KGS	Yes	Yes	No
Maldives	MV	MVR	70 KGS	No	No	No
Mali	ML	MLF	70 KGS	No	No	No
Malta	MT	MTP	70 KGS	No	No	No
Marshall Islands	MH	USD	70 KGS	No	Yes	No
Martinique	MQ	FRF	150 LBS	No	Yes	No
Mauritania	MR	MRO	70 KGS	No	No	No
Mauritius	MU	MUR	70 KGS	No	No	No
Mexico	MX	MXP	70 KGS	Yes	Yes	No
Micronesia	FM	USD	70 KGS	No	Yes	No
Moldova	MD	EUR	70 KGS	No	Yes	Yes
Monaco (EU Member)	MC	EUR	70 KGS	No	Yes	Yes
Mongolia	MN	USD	70 KGS	No	Yes	No
Montserrat	MS	XCD	150 LBS	No	No	No
Morocco	MA	MAD	70 KGS	No	No	No
Mozambique	MZ	MZM	70 KGS	No	No	No
Myanmar	MM	USD	70 KGS	No	No	No
N. Mariana Islands	MP	USD	150 LBS	No	No	No
Namibia	NA	ZAR	70 KGS	No	No	No
Nepal	NP	NPR	70 KGS	No	Yes	No
Netherlands (EU Member)	NL	EUR	70 KGS	Yes	Yes	Yes
Netherlands Antilles	AN	ANG	150 LBS	No	No	No
New Caledonia	NC	XPF	70 KGS	No	No	No
New Zealand	NZ	NZD	70 KGS	Yes	Yes	No
Nicaragua	NI	NIC	70 KGS	No	No	No
Niger	NE	XOF	70 KGS	No	No	No
Nigeria	NG	NGN	70 KGS	No	No	No
Norfolk Island	NF	AUD	70 KGS	No	No	No
Norway	NO	NOK	70 KGS	No	Yes	Yes
Oman	OM	OMR	70 KGS	No	No	No
Pakistan	PK	PKR	70 KGS	No	Yes	No
Palau	PW	USD	70 KGS	No	Yes	No
Panama	PA	PAB	70 KGS	No	No	No
Papua New Guinea	PG	PGK	70 KGS	No	No	No
Paraguay	PY	PYG	70 KGS	No	No	No
Peru	PE	PES	70 KGS	Yes	No	No
Philippines	PH	PHP	70 KGS	Yes	Yes	No
Poland	PL	PLZ	70 KGS	No	Yes	Yes
Portugal(EU Member)	PT	EUR	70 KGS	No	Yes	Yes
Puerto Rico	PR	USD	150 LBS	Yes	Yes	No
Qatar	QA	QAR	70 KGS	No	No	No
Reunion Is.	RE	FRF	70 KGS	No	Yes	No
Romania	RO	ROL	70 KGS	No	Yes	Yes
Russia	RU	RUR	70 KGS	No	Yes	No
Rwanda	RW	RWF	70 KGS	No	No	No
Samoa (Amer.)	AS	USD	70 KGS	No	No	No
Samoa (Western)	WS	NZD	70 KGS	No	No	No
San Marino	IT	ITL	70 KGS	No	Yes	Yes
Saudi Arabia	SA	SAR	70 KGS	No	Yes	No
Senegal	SN	XOF	70 KGS	No	No	No
Serbia & Montenegro	CS	YUD	70 KGS	No	Yes	Yes
Seychelles	SC	SCR	70 KGS	No	No	No
Sierra Leone	SL	SLL	70 KGS	No	No	No
Singapore	SG	SGD	70 KGS	Yes	Yes	No
Slovak Republic	SK	SKK	70 KGS	No	Yes	Yes
Slovenia	SI	SIT	70 KGS	No	Yes	Yes
Solomon Islands	SB	SBD	70 KGS	No	No	No
South Africa	ZA	GBP	70 KGS	Yes	Yes	No
South Korea	KR	KRW	70 KGS	No	Yes	No
Spain (EU Member)	ES	EUR	70 KGS	Yes	Yes	Yes
Sri Lanka	LK	LKR	70 KGS	No	Yes	No
St. Christopher	KN	XCD	150 LBS	No	No	No
St. Lucia	LC	XCD	150 LBS	No	No	No
St. Vincent/Grenadines	VC	XCD	150 LBS	No	No	No
Sudan	SD	SDP	70 KGS	No	No	No
Suriname	SR	SRG	70 KGS	No	No	No
Swaziland	SZ	SZL	70 KGS	No	No	No
Sweden (EU Member)	SE	SEK	70 KGS	No	Yes	Yes
Switzerland	CH	CHF	70 KGS	Yes	Yes	Yes
Syria	SY	SYP	70 KGS	No	No	No
Taiwan	TW	NTD	70 KGS	No	Yes	No
Tajikistan	TJ	RUR	70 KGS	No	Yes	No
Tanzania	TZ	TZS	70 KGS	No	No	No
Thailand	TH	THB	70 KGS	No	Yes	No
Togo	TG	XOF	70 KGS	No	No	No
Tonga	TO	TOP	70 KGS	No	No	No
Trinidad & Tobago	TT	TTD	150 LBS	No	No	No
Tunisia	TN	TND	70 KGS	No	No	No
Turkey	TR	TRL	70 KGS	No	Yes	Yes
Turkmenistan	TM	RUR	70 KGS	No	Yes	No
Turks & Caicos Islands	TC	USD	150 LBS	No	No	No
Tuvalu	TV	AUD	70 KGS	No	No	No
Uganda	UG	UGS	70 KGS	No	No	No
Ukraine	UA	UAK	70 KGS	No	Yes	No
United Arab Emirates	AE	AED	70 KGS	No	No	No
United Kingdom(EU Member)	GB	GBP	70 KGS	Yes	Yes	Yes
United States	US	USD	150 LBS	Yes	Yes	No
Uruguay	UY	UYP	70 KGS	No	Yes	No
US Virgin Islands	VI	USD	150 LBS	No	Yes	No
Uzbekistan	UZ	RUR	70 KGS	No	Yes	No
Vanuatu	VU	VUV	70 KGS	No	No	No
Venezuela	VE	VEB	70 KGS	Yes	No	No
Vietnam	VN	USD	70 KGS	No	Yes	No
Wake Island	WK	USD	70 KGS	No	No	No
Wallis & Futuna Isle	WF	XPF	70 KGS	No	No	No
Yemen	YE	YER	70 KGS	No	No	No
Zambia	ZM	ZMK	70 KGS	No	No	No
Zimbabwe	ZW	ZWD	70 KGS	No	No	No

NmfcCode
char*
Default Value: ""

NMFC Code for commodity.

NumberOfPieces
int
Default Value: 1

The total number of packages, cartons, or containers for the commodity line item.

If the Documents is set to False in ship request, the NumberOfPieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

PartNumber
char*
Default Value: ""

The part number of this commodity line item.

PONumber
char*
Default Value: ""

The PO Number for printed reference per commodity.

Quantity
int
Default Value: 1

Number of units contained in this commodity line item measured in units specified by the QuantityUnit. This is used in conjunction with the QuantityUnit and UnitPrice.

If the Documents is set to False in ship request, the Quantity is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

QuantityUnit
char*
Default Value: "EA"

Unit of measure used to express the Quantity of this commodity line item.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the QuantityUnit is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Here is a list of possible values for FedEx:


Value	Description
AR	Carat
CG	Centigram
CM	Centimeters
CM3	Cubic Centimeters
CFT	Cubic Feet
M3	Cubic Meters
DOZ	Dozen
DPR	Dozen Pair
EA	Each
GAL	Gallon
G	Grams
GR	Gross
KGM	Kilogram
KG	Kilograms
LFT	Linear Foot
LNM	Linear Meters
LYD	Linear Yard
L	Liter
LTR	Liters
M	Meters
MG	Milligram
ML	Milliliter
NO	Number
OZ	Ounces
PR	Pair
PRS	Pairs
PCS	Pieces
LB	Pound
CM2	Square centimeters
SFT	Square feet
SQI	Square inches
M2	Square meters
SYD	Square yards
YD	Yard

UnitPrice
char*
Default Value: "1.00"

Value of each QuantityUnit in Quantity of this commodity line item. This is used in conjunction with the QuantityUnit and Quantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

When the shipment contains non-documents item(s) (i.e., the Documents is set to False), the UnitPrice is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

Value
char*
Default Value: ""

The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.

Volume
char*
Default Value: "0.0"

This should contain the volume of the freight item. This should be specified in cubic feet if SizeUnit is set to IN and cubic meters if SizeUnit is set to CM.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Weight
char*
Default Value: "0.00"

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the Weight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Width
int
Default Value: 1

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Constructors

FreightCommodityDetail()

FreightCommodityDetail(const char* lpszDescription, int iFreightClass, int iFreightPackagingType, int iHandlingUnits, const char* lpszHarmonizedCode, const char* lpszManufacturer, int iNumberOfPieces, int iQuantity, const char* lpszQuantityUnit, const char* lpszUnitPrice, const char* lpszWeight, int iLength, int iWidth, int iHeight, const char* lpszVolume)

FreightCommodityDetail(const char* lpszDescription, int iFreightClass, int iFreightPackagingType, int iHandlingUnits, const char* lpszWeight, int iLength, int iWidth, int iHeight, const char* lpszVolume)

FreightCommodityDetail(const char* lpszDescription, const char* lpszHarmonizedCode, const char* lpszManufacturer, int iNumberOfPieces, int iQuantity, const char* lpszQuantityUnit, const char* lpszUnitPrice, const char* lpszWeight)

FreightCommodityDetail(const char* lpszDescription, const char* lpszHarmonizedCode, const char* lpszManufacturer, int iQuantity, const char* lpszQuantityUnit, const char* lpszUnitPrice, const char* lpszWeight)

FreightCommodityDetail(const char* lpszDescription, const char* lpszHarmonizedCode, const char* lpszManufacturer, int iQuantity, const char* lpszQuantityUnit, const char* lpszUnitPrice)

FreightCommodityDetail(const char* lpszDescription, const char* lpszManufacturer, const char* lpszWeight)

FreightGuaranteeDetail Type

Indicates the freight guarantee details.

Syntax

DShippingSDKFreightGuaranteeDetail (declared in dshippingsdk.h)

Remarks

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

Example: Setting the fields for the freight guarantee details

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

The following fields are available:

Date
Type

Fields

Date
char*
Default Value: ""

The date the freight shipment is guaranteed for.

The valid format for the date is YYYY-MM-DD

Type
int
Default Value: 0

Specifies what type of freight guarantee is requested.

The valid values are:


Value	Description
fgtGuaranteedDate (0)	Guaranteed to arrive on date specified
fgtGuaranteedMorning (1)	Guaranteed to arrive the morning of the date specified

Constructors

FreightGuaranteeDetail()

FreightShipmentDetail Type

Indicates the freight shipment details.

Syntax

DShippingSDKFreightShipmentDetail (declared in dshippingsdk.h)

Remarks

This contains the details necessary when sending a freight shipment when the ServiceType is set to either stFedExFreightEconomy or stFedExFreightPriority.

The following fields are available:

Fields

AccountNumber
char*
Default Value: ""

This is the account number to be used with a freight shipment. This is required when submitting a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingAccountNumber
char*
Default Value: ""

This should be set to the alternate account number to be billed. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingCity
char*
Default Value: ""

This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingCompanyName
char*
Default Value: ""

This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingCountryCode
char*
Default Value: ""

This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingPersonName
char*
Default Value: ""

This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingPhone
char*
Default Value: ""

This should be set to the phone associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingState
char*
Default Value: ""

This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingStreetAddress
char*
Default Value: ""

This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

AlternateBillingZipCode
char*
Default Value: ""

This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber. This is used in connection with Send Bill To (SBT) identification of customer's account used for billing.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingAddress1
char*
Default Value: ""

This should be set to the first address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingAddress2
char*
Default Value: ""

This should be set to the second address line listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingCity
char*
Default Value: ""

This should be set to the city listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingCompanyName
char*
Default Value: ""

This should be set to the name of the company listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingCountryCode
char*
Default Value: ""

This should be set to the country code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingEmail
char*
Default Value: ""

This should be set to the email address listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingFax
char*
Default Value: ""

This should be set to the fax number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingPersonName
char*
Default Value: ""

This should be set to the name of the person listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingPhone
char*
Default Value: ""

This should be set to the phone number listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingState
char*
Default Value: ""

This should be set to the state listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

BillingZipCode
char*
Default Value: ""

This should be set to the zip code listed on the account associated with the FreightAccountNumber. This is used for validating FedEx Freight account number and (optionally) identifying third party payment on the bill of lading.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

ClientDiscountPercent
char*
Default Value: ""

The estimated client discount rate for a freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

CollectTermsType
int
Default Value: 0

This sets the terms for how to collect payment for this freight shipment. Default value is 0.

Valid values are as follows:


Value	Meaning
0	Standard
1	Non-Recourse Shipper Signed

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Comments
char*
Default Value: ""

The description for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Coupons
char*
Default Value: ""

This contains a semicolon delimited list of identifiers for promotional discounts offered to customers. For example: coupon1; coupon2; coupon3.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

DeclaredValue
char*
Default Value: ""

The total declared value per unit for this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

DeclaredValueUnits
char*
Default Value: ""

Identifies the declared value units corresponding to the above defined declared value.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

EmergencyContactPhone
char*
Default Value: ""

The phone number for the emergency contact. This is required if any of the Commodities line items contain hazardous materials.

HazardousMaterialsOfferor
char*
Default Value: ""

If this shipment contains hazardous materials, this should contain the offeror of the hazardous materials.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

LiabilityCoverageAmount
char*
Default Value: ""

This should be set to the total value of the liability coverage.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

LiabilityCoverageType
int
Default Value: 0

This should be set to the type of liability coverage offered.

Valid values are as follows:


Value	Meaning
0	New
1	Used or Reconditioned

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

PalletWeight
char*
Default Value: ""

This should contain the total weight of all pallets used in this freight shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Role
int
Default Value: 0

This indicates the role of the party is submitting the transaction for this freight shipment.

Valid values are as follows:


Value	Meaning
0	Shipper
1	Consignee

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalHandlingUnits
int
Default Value: 1

Total number of individual handling units in the entire shipment (for unit pricing).

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalHeight
int
Default Value: 0

This should be set to the total height of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalLength
int
Default Value: 0

This should be set to the total length of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

TotalWidth
int
Default Value: 0

This should be set to the total width of the shipment.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Constructors

FreightShipmentDetail()

NotifyDetail Type

Represents a single recipient to be notified via email.

Syntax

DShippingSDKNotifyDetail (declared in dshippingsdk.h)

Remarks

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

The fields contained by this type are listed below.

The following fields are available:

Aggregate
Email
Message
Name
NotificationFlags
RecipientType

Fields

Aggregate
char*
Default Value: ""

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows: <EMailNotificationDetail> <PersonalMessage>personal_message</PersonalMessage> <Recipients> (this aggregate can be entered up to six times) <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType> <EMailAddress>recipient_email</EMailAddress> <NotifyOnShipment>true_or_false</NotifyOnShipment> <NotifyOnException>true_or_false</NotifyOnException> <NotifyOnDelivery>true_or_false</NotifyOnDelivery> <Format>format_type</Format> <Localization> <LanguageCode>language_code</LanguageCode> </Localization> </Recipients> </EMailNotificationDetail>

In this aggregate, you can specify:

a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
the recipient's email address (via the EMailAddress element). This is required.
whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients field can have up to 6 recipient emails).

This setting is optional. If Aggregate is not set it will be automatically created by the class.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

In this aggregate, you can specify:

a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
the recipient's email address (via the EMailAddress element). This is required.
the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
an optional from name.
a message text to be sent in the email notification (via the Memo element). This is optional.

Note that this field does not apply for USPS and CanadaPost.

Email
char*
Default Value: ""

Email address of the recipient to be notified. This is required to be provided for each recipient.

Message
char*
Default Value: ""

User defined text that will be included in the email to be sent to Email. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This field is not used by USPS or Canada Post.

Name
char*
Default Value: ""

The name associated with the notification.

For USPS, this name will appear in the text of the Signature Confirmation e-mail message.

This field is not applicable to FedEx, UPS, or Canada Post.

NotificationFlags
int
Default Value: 0

Identifies the type of notification requested. Valid values are:


Value	Meaning
0x00000001 (On Shipment)	An email notification is requested to be sent to the Email when the package is shipped.
0x00000002 (On Exception)	An email notification should be sent to the Email when an exception occurs during package movement from origin to destination.
0x00000004 (On Delivery)	An email notification is requested to be sent to the Email when the package is delivered.
0x00000008 (On Tender)	An email notification is requested to be sent to the Email when the package is tendered.
0x00000010 (On Return)	An email notification is requested to be sent to the Email when the package is returned.
0x00000020 (HTML)	The email should be sent in HTML format.
0x00000040 (Text)	The email should be sent in Text format.
0x00000080 (Wireless)	The email should be sent in Wireless format.
0x00000200 (In Transit)	An email notification is requested to be sent to the Email when the package is in transit.
0x00000400 (ADL)	Alternate Delivery Location
0x00000800 (UAP)	UAP Shipper.
0x00001000 (On Estimated Delivery)	An email notification is requested to be sent to Email when the package was estimated to be delivered.

For FedEx notifications, the following flags apply:

On Shipment
On Exception
On Delivery
On Tender
On Estimated Delivery
HTML
Text

To use Estimated Delivery with FedEx, the APIVersion configuration setting must be set to 19 or higher.

For UPS notifications, the following flags apply:

On Shipment
On Exception
On Delivery
On Return
In Transit
ADL
UAP

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

RecipientType
int
Default Value: 0

Identifies the set of valid email notification recipient types. Valid values are:


rtUnspecified (0)
rtRecipient (1)
rtShipper (2)
rtBroker (3)
rtOther (4)
rtThirdParty (5)

For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the Email specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

This field does not apply to UPS or Canada Post notifications.

Constructors

NotifyDetail()

NotifyDetail(int iNotificationFlags, const char* lpszEmail, const char* lpszMessage)

NotifyDetail(int iNotificationFlags, const char* lpszEmail)

NotifyDetail(int iNotificationFlags, int iRecipientType, const char* lpszEmail)

NotifyDetail(const char* lpszName)

PackageDetail Type

Represents a single package contained in shipment.

Syntax

DShippingSDKPackageDetail (declared in dshippingsdk.h)

Remarks

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

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

The fields contained by this type are listed below.

The following fields are available:

Fields

BaseCharge
char* (read-only)
Default Value: ""

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

CODAmount
char*
Default Value: ""

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in CODLabel).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the CODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the CODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackagingType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by SignatureType) and COD cannot coexist on a single package.

This field is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

CODFile
char*
Default Value: ""

Filename and location to save the CODLabel of this package to. This is applicable for package(s) that use the COD service.

When the CODFile is set to a valid path and filename, the contents of the CODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then CODFile has to have .pdf extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

This field is only applicable to FedEx shipments.

CODLabel
char* (read-only)
Default Value: ""

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This field is only applicable to FedEx.

CODType
int
Default Value: 0

The code that indicates the type of funds that will be used for the COD payment for this package.

This field is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., CODAmount is set to a value other than "0.00").

Valid values are:


Value	Description
codtpAny (0)	Company check, personal check, cashier's check or money order - UPS no cash allowed. Not applicable for Canada Post
codtpCash (1)	Cash - FedEx only, only valid for Ground shipments
codtpGuaranteedFunds (2)	Cashier's check or money order
codtpCompanyCheck (3)	Company check - FedEx and Canada Post only
codtpPersonalCheck (4)	Personal check - FedEx and Canada Post only

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

DangerousGoodsAccessible
int
Default Value: FALSE

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

This field is only applicable to FedEx shipments, and is required to be specified when the SpecialServices contains the corresponding flag for Dangerous Goods.

There are two types of dangerous goods:

Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The DangerousGoodsAccessible should be set to True.
Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The DangerousGoodsAccessible should be set to False.

The accessibility type affects the service availability and rates.

Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services.

DangerousGoodsOptions
int
Default Value: 0

Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:


Value	Meaning
0x00000001	Hazardous Materials
0x00000002	Battery
0x00000004	Other Regulated Materials - Domestic (ORM-D)
0x00000008	Reportable Quantities
0x00000010	Small Quantity Exception
0x00000020	Limited Quantities Commodities

Note: This is only valid when using FedEx.

Description
char*
Default Value: ""

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

Girth
int
Default Value: 0

Measurement around the widest part of the package, perpendicular to the Length.

This field is only applicable when requesting rates for USPS packages.

Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Height
int
Default Value: 0

The height of the package to be shipped.

For FedEx, the Height is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Width are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

Id
char*
Default Value: ""

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This field is optional, and only applies to USPS return labels.

InsuredValue
char*
Default Value: ""

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

Length
int
Default Value: 0

The length of the package to be shipped.

For FedEx, the Length is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Width and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Note: For parcels, the Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

NetCharge
char*
Default Value: ""

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment.

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

PackagingType
int
Default Value: 0

The packaging type of the package being rated and/or shipped.

Possible values are:


Value	FedEx	UPS	USPS	USPS (Endicia)	USPS (Stamps.com)	Canada Post
ptNone (0)		X	X			X
ptPostcards (1)			X	X	X
ptLetter (2)	X	X		X	X
ptLargeEnvelope (3)			X	X	X
ptFlatRateEnvelope (4)			X	X	X
ptFlatRateLegalEnvelope (5)			X	X	X
ptFlatRatePaddedEnvelope (6)			X	X	X
ptFlatRateGiftCardEnvelope (7)			X	X
ptFlatRateWindowEnvelope (8)			X	X
ptFlatRateCardboardEnvelope (9)				X
ptSmallFlatRateEnvelope (10)			X	X
ptPak (11)	X	X
ptBox (12)	X	X
pt10kgBox (13)	X	X
pt25kgBox (14)	X	X
ptSmallExpressBox (15)		X
ptMediumExpressBox (16)		X
ptLargeExpressBox (17)		X
ptFlatRateBox (18)			X		X
ptSmallFlatRateBox (19)			X	X	X
ptMediumFlatRateBox (20)			X	X	X
ptLargeFlatRateBox (21)			X	X	X
ptDVDFlatRateBox (22)				X
ptLargeVideoFlatRateBox (23)				X
ptRegionalRateBoxA (24)			X	X	X
ptRegionalRateBoxB (25)			X	X	X
ptRectangular (26)			X
ptNonRectangular (27)			X
ptTube (28)	X	X				X
ptMatterForTheBlind (29)			X
ptPallet (30)		X
ptYourPackaging (31)	X	X	X	X	X	X
ptDocument (32)						X
ptFlats (33)		X
ptParcels (34)		X
ptBPM (35)		X
ptFirstClass (36)		X
ptPriority (37)		X
ptMachinables (38)		X
ptIrregulars (39)		X
ptParcelPost (40)		X
ptBPMParcel (41)		X
ptMediaMail (42)		X
ptBPMFlat (43)		X
ptStandardFlat (44)		X
ptRegionalRateBoxC (45)			X	X	X
ptThickEnvelope (46)			X	X	X
ptSmallBox (47)	X
ptMediumBox (48)	X
ptLargeBox (49)	X
ptExtraLargeBox (50)	X
ptPackageService (51)			X
ptCubicParcels (52)			X
ptCubicSoftPack (53)			X

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagingType for the first package is used in label requests.

If the PackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: Length, Width, and Height.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagingType will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting PackagingType make sure this is valid for all the following: CountryCode, CountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:


ServiceType	PackagingType	Weight
stFirstClass (35)	ptFirstClass (36)	1 to 13 OZS
stPriorityMail (36)	ptPriority (37)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptMachinables (38)	6 to <16 OZS
stExpeditedMailInnovations (37)	ptIrregulars (39)	1 to <16 OZS
stExpeditedMailInnovations (37)	ptParcelPost (40)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMParcel (41)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptMediaMail (42)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMFlat (43)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptStandardFlat (44)	1 to <16 OZS
stPriorityMailInnovations (38)	ptFlats (33)	1 to 70 LBS
stPriorityMailInnovations (38)	ptParcels (34)	1 to 70 LBS
stPriorityMailInnovations (38)	ptBPM (35)	1 to 70 LBS
stEconomyMailInnovations (39)	ptFlats (33)	1 to 70 LBS
stEconomyMailInnovations (39)	ptParcels (34)	1 to 70 LBS
stEconomyMailInnovations (39)	ptBPM (35)	1 to 70 LBS

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

RatingAggregate
char* (read-only)
Default Value: ""

Rating aggregate applicable to this package.

Reference
char*
Default Value: ""

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:


Type value	Meaning
CR	Customer Reference - this gets printed on shipping label and invoice.
BL	Bill Of Lading - this gets printed on shipping label, Ground shipping reports, and in the Customer Reference element on the invoice.
IN	Invoice Number - this gets printed on shipping label and invoice.
PO	Purchase Order Number - this gets printed on shipping label and invoice.
DN	Department Number - this gets printed on shipping label and invoice.
SI	Shipment Integrity - this gets printed on invoice only.
SN	Store Number - this gets printed on shipping label and invoice.
IR	Intracountry Reglatory Reference
EPC	Electronic Product Code
RMA	RMA Number

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the Reference should be set to: CN:123456; IN:123; SN:12;.

Reference information may also be used to track packages by reference.

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:


Code	Reference Number Type
AJ	Accounts Receivable Customer Account
AT	Appropriation Number
BM	Bill of Lading Number
9V	Collect on Delivery (COD) Number
ON	Dealer Order Number
DP	Department Number
3Q	Food and Drug Administration (FDA) Product Code
IK	Invoice Number
MK	Manifest Key Number
MJ	Model Number
PM	Part Number
PC	Production Code
PO	Purchase Order Number
RQ	Purchase Request Number
RZ	Return Authorization Number
SA	Salesperson Number
SE	Serial Number
ST	Store Number
TN	Transaction Reference Number
EI	Employer ID Number
TJ	Federal Taxpayer ID No.
SY	Social Security Number

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the Reference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track packages by reference.

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

ReturnReceipt
char* (read-only)
Default Value: ""

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

ReturnReceiptFile
char*
Default Value: ""

Filename and location to save the ReturnReceipt of this package to. This is applicable only if using UPS.

When the ReturnReceiptFile is set to a valid path and filename, the contents of the ReturnReceipt are written to disk upon successful response (if a return shipment).

The ReturnReceiptFile has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

ShippingLabel
char* (read-only)
Default Value: ""

Image of the shipping label for this package returned by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

ShippingLabelFile
char*
Default Value: ""

Filename and location to save the ShippingLabel of this package to. When the ShippingLabelFile is set to a valid path and filename, the contents of the ShippingLabel are written to disk upon successful response.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then ShippingLabelFile has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

ShippingLabelPart2
char* (read-only)
Default Value: ""

Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS.

This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format.

For instance, if the ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via ShippingLabel field whereas Part 2 can be accessed via ShippingLabelPart2 field.

SignatureType
int
Default Value: 0

Specifies one of the Delivery Signature Options requested for this package. Possible values are:


stServiceDefault (0)	The default value for the requested service.
stAdult (1)	Available for both residential and nonresidential deliveries.
stDirect (2)	Available for both residential and nonresidential deliveries.
stIndirect (3)	Available for residential deliveries only.
stNoSignatureRequired (4)	Not available for Ground services.
stUSPSDeliveryConfirmation (5)	Available for UPS Mail Innovations only.
stAdult19 (6)	Available for Canada Post only.

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the SignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

Size
int
Default Value: 0

Size of the package being mailed.

This field is only used by USPS and is required for the GetRates method call.

See below for valid entries:


Package Size	Description	ServiceType
psRegular	For Priority Mail: Package is less than one cubic foot in size. For all other ServiceTypes: Package length plus girth is 84 inches or less.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
psLarge	For Priority Mail: Package is greater than one cubic foot in size. For all other ServiceTypes: Package length plus girth measure more than 84 inches but not more than 108 inches. This tag does not affect the rate for Express Mail, Bound Printed Mater, Media Mail or Library Mail.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
dsOversize	Package length plus girth is more than 108 but not more than 130 inches. Parcel Post packages that measure more than 108 inches but not more than 130 inches in combined length and girth are charged the oversized Parcel Post rate regardless of the weight of the package.	Parcel Post only.

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the Length, Height, Width and optionally Girth (irregular shaped packages only) fields to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

SpecialServices
int64
Default Value: 0

Contains the collection of special services offered on the package level. Valid values are:


Value	Meaning	FedEx	FedEx Freight	UPS
0x00000001	Appointment Delivery	X
0x00000002	Dangerous Goods	X	X	X
0x00000004	Dry Ice	X
0x00000008	Priority Alert	X
0x00000010	Non Standard Container	X		X
0x00000020	COD	X	X
0x00000040	Additional Handling			X
0x00000080	Signature Option	X
0x00000100	Alcohol	X

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the SpecialServices of that package to a set of valid flags.

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

Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
Dangerous Goods: Indicates that this package contains dangerous goods. When the SpecialServices contains this flag, then the DangerousGoodsAccessible is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the CODAmount and CODType must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the SpecialServices of that package to a set of valid flags.

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

Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the CODAmount and CODType, SignatureType, and InsuredValue.

This field is not applicable to USPS or Canada Post.

TotalDiscount
char* (read-only)
Default Value: ""

Total Actual Discount applicable to this package.

This is normally specific to the FedEx AccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

TotalSurcharges
char* (read-only)
Default Value: ""

Total Actual Surcharges applicable to this package.

For FedEx, this is normally specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

TrackingNumber
char* (read-only)
Default Value: ""

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

Weight
char*
Default Value: "0.0"

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if PackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

Width
int
Default Value: 0

The width of the package to be shipped.

For FedEx, the Width is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

Constructors

PackageDetail()

PackageDetail(int iPackagingType, const char* lpszWeight)

PackageDetail(int iLength, int iWidth, int iHeight)

PackageDetail(int iPackagingType, int iLength, int iWidth, int iHeight)

PackageDetail(int iPackagingType, const char* lpszWeight, int iLength, int iWidth, int iHeight)

PackageDetail(int iPackagingType, const char* lpszWeight, int iLength, int iWidth, int iHeight, int iSpecialServices, const char* lpszInsuredValue, const char* lpszCODAmount, int iCODType, int iSignatureType)

PackageDetail(const char* lpszWeight, int iLength, int iWidth, int iHeight, int iSpecialServices, const char* lpszInsuredValue, const char* lpszCODAmount, int bDangerousGoodsAccessible, int iSignatureType)

PackageDetail(const char* lpszWeight, int iLength, int iWidth, int iHeight, const char* lpszDescription, const char* lpszReference, int iSpecialServices, const char* lpszInsuredValue, const char* lpszCODAmount, int bDangerousGoodsAccessible, int iSignatureType, const char* lpszShippingLabelFile, const char* lpszCODFile)

PackageDetail(int iPackagingType, const char* lpszWeight, int iLength, int iWidth, int iHeight, const char* lpszDescription, const char* lpszReference, int iSpecialServices, const char* lpszInsuredValue, const char* lpszCODAmount, int iCODType, int iSignatureType, const char* lpszShippingLabelFile, const char* lpszReturnReceiptFile)

PayorDetail Type

Represents the payor details responsible for payment.

Syntax

DShippingSDKPayorDetail (declared in dshippingsdk.h)

Remarks

This type contains data of the responsible party for payment of shipping charges, or duties and taxes. This is used in a ship request.

Example: Setting the fields PayorDetail payor = new PayorDetail payor.Type = PT_RECIPIENT payor.AccountNumber = "123456789" payor.CountryCode = "US"

The fields contained by this type are listed below.

The following fields are available:

AccountNumber
Address1
Address2
City
CountryCode
Name
PayorType
State
ZipCode

Fields

AccountNumber
char*
Default Value: ""

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to AccountNumber.

Address1
char*
Default Value: ""

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. Combination of Address1 and Address2 should not exceed 35 characters.

Address2
char*
Default Value: ""

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. Combination of Address1 and Address2 should not exceed 35 characters.

City
char*
Default Value: ""

Name of city, town, etc.

CountryCode
char*
Default Value: "US"

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the CountryCode is required to be provided in the ship request only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the CountryCode is required only if PayorType is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

Name
char*
Default Value: ""

Identifies the payor's name.

Name is required only if PayorType is set to 'THIRDPARTY'.

Note: This field is only applicable to UPSFreightRates and UPSFreightShip.

PayorType
int
Default Value: 0

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:


ptSender (0)
ptRecipient (1)
ptThirdParty (2)
ptCollect (3)
ptConsignee (4)

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this field is set to a value other than 0 (ptSender), the AccountNumber and CountryCode are required to be provided in the request as well. Otherwise, those will default to AccountNumber and CountryCode.

For UPS, when set to ptSender, the AccountNumber is automatically set to AccountNumber. When ptRecipient is specified, AccountNumber and ZipCode are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the AccountNumber, ZipCode and CountryCode are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

State
char*
Default Value: ""

ZipCode
char*
Default Value: ""

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS AccountNumber's pickup address. This should be the same as it was entered in the UPS system when this account was set up.

It can be provided in a ship request only if the PayorType is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

Constructors

PayorDetail()

PayorDetail(int iPayorType, const char* lpszAccountNumber, const char* lpszCountryCode)

Proxy Type

The proxy the component will connect to.

Syntax

DShippingSDKProxy (declared in dshippingsdk.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

The following fields are available:

AuthScheme
AutoDetect
Password
Port
Server
SSL
User

Fields

AuthScheme
int
Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
int
Default Value: FALSE

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Password
char*
Default Value: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default Value: 80

The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.

Server
char*
Default Value: ""

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
int
Default Value: 0

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

User
char*
Default Value: ""

A username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

UploadDocumentDetail Type

Indicates the details for a document to be uploaded.

Syntax

DShippingSDKUploadDocumentDetail (declared in dshippingsdk.h)

Remarks

This type contains data describing a document to be uploaded.

Example: Setting the fields of the upload document UploadDocumentDetail uploadDocDetail = new UploadDocumentDetail uploadDocDetail.DocType = FedExDocumentTypes.fdtCertificateOfOrigin uploadDocDetail.LocalFileName = "..\\..\\files\\CertificateOfOrigin.pdf" uploadDocDetail.UploadFileName = "CertificateOfOrigin.pdf"

The following fields are available:

DocType
DocumentId
FileContent
LocalFileName
ShipDocument
UploadFileName

Fields

DocType
int
Default Value: 0

This specifies the document type of the document being uploaded.

The valid values are as follows:


Value	Description
fdtCommercialInvoice (0)	Commercial Invoice
fdtCertificateOfOrigin (1)	Certificate of Origin
fdtNAFTACertificateOfOrigin (2)	NAFTA Certificate of Origin
fdtProFormaInvoice (3)	Pro Forma Invoice
fdtOther (4)	Other document type

DocumentId
char* (read-only)
Default Value: ""

Upon a successful request, this is returned in the server reply for each uploaded document.

FileContent
char*
Default Value: ""

If LocalFileName is not set, this will be used to specify the contents of the file to be uploaded.

LocalFileName
char*
Default Value: ""

This contains the path to the file on the local system. If this is not set, FileContent will be used instead.

ShipDocument
int
Default Value: FALSE

This indicates if the document will be sent in a subsequent call to GetShipmentLabels or GetPackageLabel.

UploadFileName
char*
Default Value: ""

This contains the name of file to be uploaded to FedEx.

Constructors

UploadDocumentDetail()

UploadImageDetail Type

Indicates the details for an image to be uploaded.

Syntax

DShippingSDKUploadImageDetail (declared in dshippingsdk.h)

Remarks

This type contains data describing an image to be uploaded.

Example: Setting the fields of the upload image UploadImageDetail uploadImgDetail = new UploadImageDetail uploadImgDetail.ImageType = FedExUploadImageTypes.uitSignature uploadImgDetail.ImageIndex = "IMAGE_1" uploadImgDetail.LocalFileName = "..\\..\\files\\Signature.png" uploadImgDetail.UploadFileName = "Signature.png"

The following fields are available:

FileContent
ImageIndex
ImageType
LocalFileName
Reference
Status
UploadFileName

Fields

FileContent
char*
Default Value: ""

If LocalFileName is not set, this will be used to specify the contents of the file to be uploaded.

ImageIndex
char*
Default Value: ""

Specifies the index for the uploaded image. Valid Values are: IMAGE_1, IMAGE_2, IMAGE_3, IMAGE_4, IMAGE_5.

ImageType
int
Default Value: 0

This specifies the image type of the image being uploaded.

The valid values are as follows:


Value	Description
uitSignature (0)	SIGNATURE
uitLetterhead (1)	LETTERHEAD

LocalFileName
char*
Default Value: ""

This contains the path to the file on the local system. If this is not set, FileContent will be used instead.

Reference
char*
Default Value: ""

This is an optional field to specify the customer reference for the image to be uploaded (Example: SIGNA202403).

Status
char* (read-only)
Default Value: ""

Upon a successful request, this is returned in the server reply for each uploaded image.

Possible values are:


SUCCESS
FAILURE
ERROR

UploadFileName
char*
Default Value: ""

This contains the name of file to be uploaded to FedEx (Example: Signature.PNG).

Constructors

UploadImageDetail()

DShippingSDKList Type

Syntax

DShippingSDKList<T> (declared in dshippingsdk.h)

Remarks

DShippingSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the FedExFreightShip class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (FedExFreightShip Class)

The class accepts one or more of the following configuration settings. Configuration 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.

FedExFreightShip Config Settings

AdmissibilityPackageType: Identifies the admissibility package type.

If you set the PackagingType to YOUR_PACKAGING, the AdmissibilityPackageType is required for packages traveling to and from the U.S., Canada, and Puerto Rico, in order to designate the package description.

Possible values are:


BAG
BBL
BDL
BOX
BSK
BXT
CAG
CAS
CHS
CNT
CRT
CTN
CYL
DRM
ENV
PAL
PCL
PCS
PKG
PLT
REL
ROL
SAK
SHW
SKD
TBE
TBN
TNK
UNT

B13AFiling: Specifies which option is being exercised by the customer to file the B13A.

The B13A is an export declaration form filed with Canada Customs by the Canadian exporter. Canadian shippers are required to submit a B13A Canada Export Declaration for shipments of commodities or documents (which value exceeds $1,999.99 CAD, $999.00 USD, or $0.00 for any other currency type), or for shipments of controlled commodities, as defined by Revenue Canada Customs and related agencies, regardless of the value of the shipment. This is not needed for outbound shipments consigned to countries other than the United States (US), U.S. Virgin Islands (VI), or Puerto Rico (PR).

The B13AFiling is required to be provided in the ship request for all FedEx Express International non-document shipments outbound from Canada that are not destined to above listed countries, and :

Possible values are: 'NOT_REQUIRED', 'MANUALLY_ATTACHED', 'FILED_ELECTRONICALLY', 'SUMMARY_REPORTING', and 'FEDEX_TO_STAMP'.

If 'NOT_REQUIRED' is specified, the B13A Exemption Number should be provided in the request (via the ExportCompliance).

If 'MANUALLY_ATTACHED' is specified, your manually filed B13A must be time/date stamped at a Canada Customs office before you ship. The shipment tracking number must be indicated on the stamped B13A. One original copy of the stamped B13A must be attached to the shipping documentation. You are not required to enter the 21-character B13A transaction number at the time of shipping.

If 'FILED_ELECTRONICALLY' is specified, your B13A authorization code must be obtained by submitting your B13A information using the CAED software (and be provided in the ship request via the ExportCompliance). To add the required shipment tracking number to your B13A declaration, return to the CAED software after you create your shipping label and update your original B13A declaration with this information.

If 'SUMMARY_REPORTING' is specified, a prior written authorization from Canada Customs is required.

Note: If you have questions regarding B13A shipping requirements, see fedex.com/ca_english/international/regulatorynews/b13afaqs.html for more information.

BlockVisibility: Whether the visibility of this shipment should be blocked from parties other than shipper/payor.

If True, only the shipper/payor will have visibility of this shipment.

BookingNumber: Booking confirmation number.

It is required and applicable only for the following international freight services: International Priority Freight (IPFS) and International Economy Freight (IEFS) (i.e., when the ServiceType is set to either ST_INTERNATIONALPRIORITY_FREIGHT (14) or ST_INTERNATIONALECONOMY_FREIGHT (15)).

Values must be 8-12 characters in length.

CancelledShipment: Indicates whether the shipment has been cancelled or not.

This read only configuration setting is populated from the server when CancelShipment or CancelPackage methods are called. If the value is True, then it indicates that the shipment has been cancelled.

CODRecipientAddress1: The primary street address of the COD recipient.

This specifies the primary address of the COD Recipient, which will be printed on the COD label.

CODRecipientAddress2: The secondary street address of the COD recipient.

This specifies the secondary address of the COD Recipient, which will be printed on the COD label.

CODRecipientCity: The city of the COD recipient.

This specifies the city of the COD Recipient, which will be printed on the COD label.

CODRecipientCompany: The company of the COD recipient.

This specifies the company of the COD Recipient, which will be printed on the COD label.

CODRecipientCountryCode: The country code of the COD recipient.

This specifies the country code of the COD Recipient, which will be printed on the COD label.

CODRecipientName: The name of the COD recipient.

This specifies the name of the COD Recipient, which will be printed on the COD label.

CODRecipientPhone: The phone number of the COD recipient.

This specifies the phone number of the COD Recipient, which will be printed on the COD label.

CODRecipientResidential: The residential status of the COD recipient.

This indicates whether the COD recipient is a residential address.

CODRecipientState: The state of the COD recipient.

This specifies the state of the COD Recipient, which will be printed on the COD label.

CODRecipientZipCode: The zip code of the COD recipient.

This specifies the zip code of the COD Recipient, which will be printed on the COD label.

CODReferenceIndicator: The reference information to be added to the COD return label.

The reference information to be added to the COD return label.

Possible values are:


0	None (default)
1	INVOICE
2	PO
3	REFERENCE
4	TRACKING

CODType: COD type.

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

Possible values are: ANY (Unsecured form of payment: personal check, certified check, cashier's check, official check, money order, or company check), GUARANTEED_FUNDS (Secured form of payment: cashier's check, official check, or money order), or CASH.

The amount to be collected has to be specified on package level by setting the CODAmount per each package where COD is requested.

CurrencyCode: The currency code associated with the monetary values present in the request.

This optional field identifies the preferred currency of the requestor.

CustomerImageCount: The number of records in the CustomerImage arrays.

This contains the number of records in the CustomerImage arrays. For ShippingDocumentTypes (Certificate of Origin(1) or Commercial Invoice(2)) that you are requesting, you can use any of the 5 images you have uploaded to your FedEx account as a Signature or as a Letter_Head.

This property controls the size of the following arrays:

CustomerImageDocumentType[i]
CustomerImageId[i]
CustomerImageType[i]
CustomerImageProvidedImageType[i]

NOTE: If you are using the CustomerImage configs, you must upload them first on the FedEx portal.

For example, you can choose to use IMAGE_1 as the LETTER_HEAD for the Commercial Invoice, IMAGE_5 as the SIGNATURE for the Commercial Invoice, and IMAGE_1 as the LETTER_HEAD for the Certificate of Origin. In this case, you will need to set the CustomerImageCount to 3. class.Config("CustomerImageCount=3") int index = 0; class.Config("CustomerImageDocumentType(" + index + ")=2") //2=Commercial Invoice class.Config("CustomerImageId(" + index + ")=IMAGE_1") class.Config("CustomerImageType(" + index + ")= LETTER_HEAD") class.Config("CustomerImageProvidedImageType(" + index + ")= LETTER_HEAD") index = 1; class.Config("CustomerImageDocumentType(" + index + ")=2") //2=Commercial Invoice class.Config("CustomerImageId(" + index + ")=IMAGE_5") class.Config("CustomerImageType(" + index + ")=SIGNATURE") class.Config("CustomerImageProvidedImageType(" + index + ")=SIGNATURE") index = 2; class.Config("CustomerImageDocumentType(" + index + ")=1") //1=Certificate of Origine class.Config("CustomerImageId(" + index + ")=IMAGE_1") class.Config("CustomerImageType(" + index + ")=LETTER_HEAD") class.Config("CustomerImageProvidedImageType(" + index + ")=LETTER_HEAD")

CustomerImageDocumentType[i]: Document type.

Valid values are:


Value	Description
1	Certificate of Origin
2	Commercial Invoice

The size of the array is controlled by CustomerImageCount.

CustomerImageId[i]: The Image ID.

Valid values are: "IMAGE_1", "IMAGE_2", "IMAGE_3", "IMAGE_4", "IMAGE_5". The size of the array is controlled by CustomerImageCount.

CustomerImageProvidedImageType[i]: The provided document image type.

Valid values: "LETTER_HEAD", "SIGNATURE". The size of the array is controlled by CustomerImageCount.

CustomerImageType[i]: Document image type.

Valid values are: "SIGNATURE", "LETTER_HEAD". The size of the array is controlled by CustomerImageCount.

CustomerTransactionId: Customer transaction id.

This element allows you to assign a unique identifier to your transaction. This element is returned in the reply and helps you match requests to replies. Maximum of 40 characters.

DeclarationStatement: The declarations statement to be sent to the customs office.

This is the legal explanation, used by Customs, for the delivery of this shipment. It must be identical to the set of declarations actually used by Customs. Examples of declarations that might be entered in this field are: EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin. Invoice statement: I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above. NAFTA statement: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff treatment under the NAFTA.

DeliveryDay: Day of the week on which shipment is expected to be delivered.

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

DeliveryInstructions: Delivery instructions.

Used with Freight services only.

DocTabContent: Custom DocTab content set by the user when preparing a shipping label.

This is applicable to thermal labels with DocTab only.

If provided, thermal labels will include specified doc tab content. If omitted, label will be produced without the doc tab content. This field, if used, should be specified as a JSON.

Documents: Whether an international shipment contains only documents or no documents.

This is applicable for international shipments only.

If False (default value), this means that this shipment contains NO documents. In this case, the data for commodity items (included in the shipment) have to be provided in the request. The Commercial Invoice is required to associate the shipment (see respective commodity elements defined by the Commodities for more details).

If True, it means that this shipment contains ONLY documents. An international shipment can either contain documents only, or no documents. Documents and other commodities cannot be mixed in a shipment.

DryIceCount: The number of packages which contain dry ice.

This specifies the number of packages in the shipment which contain dry ice. This is used in conjunction with PackageDryIceWeight when DryIce is present (requested) in the ShipmentSpecialServices.

EstimateDelivery: Determines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.

If True (default), the class will attempt to estimate Transit Time, Delivery Date, and/or Delivery Day based on what information came back in the response. This does not account for non-business days, holidays, or weekend delivery and should be treated accordingly.

If False, the class will not estimate Transit Time, Delivery Date, and/or Delivery Day. Instead it will ONLY use the values returned in the response from FedEx. If a property is empty, it means that FedEx did not return this information.

ExportCompliance: This is an export compliance statement.

General field for exporting-country-specific export data (e.g. B13A for CA, FTSR Exemption or AES Citation for US).

For international shipments requiring an EEI/SED (Electronic Export information/Shipper's Export Declaration), the ExportCompliance should be set to: either a FTR (Foreign Trade Regulations) exemption number or an ITN number (Internal Transaction Number) received from filing your EEI/SED shipment data with AESDirect (go to www.aesdirect.gov to use this application) as proof of filing citation.

For shipments originating in Canada, the following rules apply:

if B13AFiling is set to 'NOT_REQUIRED', this field should contain a valid B13A Exemption Number;
if B13AFiling is set to 'MANUALLY_ATTACHED', you are not required to enter the 21-character B13A transaction number at the time of shipping;
if B13AFiling is set to 'FILED_ELECTRONICALLY', this field should contain a valid 17 or 23 alphanumeric authorization code for your B13A;
if B13AFiling is set to 'SUMMARY_REPORTING': this option requires a prior written authorization from Canada Customs;

This number will print on the international shipping label and it is used by customs office. Maximum length: 50.

Two most common exemptions are: 'NO EEI 30.36' (for shipments to Canada) and 'NO EEI 30.37(a)' (for commodity value less than $2,500). However, for the official list of FTR Exemption codes and definitions, please refer to Code of Federal Regulations (CFR) Title 15, Part 30, Subpart D (located at http://ecfr.gpoaccess.gov or http://www.census.gov/foreign-trade/regulations).

InvoiceSpecialInstructions: Special instructions for commercial invoices.

This will allow you to add special instructions to the commercial invoice.

LabelFormatType: Indicates the type of label to be returned.

This element is required when either the GetPackageLabel or GetShipmentLabels method is called.

Valid values are:


Value	Description
0	Common 2D
1	Label Data Only
2	Freight Straight Bill of Lading
3	VICS Bill of Lading

LabelOrientationType: Indicates if the top or bottom of the label comes out of the printer.

This setting is applicable only to documents produced on thermal printers with roll stock. Valid printing orientation types are:


Value	Description
0	Top Edge of Text First
1	Bottom Edge of Text First

LabelStockType: Indicates the size of the label and the location of the doc tab if present.

All 'Paper *' items should be used when a laser printer is being used to print the generated label file (ie. LabelImageType is set to fitPDF or fitPNG).

All 'Stock *' items should be used when a thermal printer is being used to print the generated label file (ie. LabelImageType is set to fitEltron, fitZebra or fitUniMark).

By Default, 0 (Paper 4x6) will be used when LabelImageType is set to fitPDF or fitPNG. However if LabelImageType is set to fitEltron, fitZebra or fitUniMark, the default is 2 (Stock 4x6). If an invalid value is passed, the default value for the LabelImageType you are using will be used.

Valid label stock types are:


Value	Description
0	Paper 4x6
1	Paper 7x4.75
2	Stock 4x6
3	Stock 4x6.75 Leading Doc Tab
4	Stock 4x8
5	Stock 4x9 Leading Doc Tab
6	Paper 4x8
7	Paper 4x9
8	Paper 8.5x11 Bottom Half Label
9	Paper 8.5x11 Top Half Label
10	Stock 4x6.75 Trailing Doc Tab
11	Stock 4x9 Trailing Doc Tab
12	Paper Letter
13	Paper 4x6.75
14	Stock 4x9
15	Stock 4x8.5 Trailing Doc Tab
16	Stock 4x10.5 Trailing Doc Tab

LoadAndCount: Shipper's Load and Count (SLAC) = total shipment pieces.

This is required for a single piece or on the first piece of an MPS for international freight shipping. It is applicable only for International Priority Freight (IPFS) and International Economy Freight (IEFS) (i.e., when the ServiceType is set to either ST_INTERNATIONALPRIORITY_FREIGHT (14) or ST_INTERNATIONALECONOMY_FREIGHT (15)).

This indicates the total shipment pieces (e.g. 3 boxes and 3 pallets of 100 pieces each = SLAC of 303). Maximum length: 5. Values must be in the range of 1 - 99999.

MaskedData: Specifies which data/sections to be masked on the shipping label.

Use this config to specify which data/sections on the shipping label to be masked. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:


Value	Description
0x0001	Customs Value
0x0002	Dimensions
0x0004	Duties and Taxes Payor Account Number
0x0008	Insured Value
0x0010	Secondary Barcode
0x0020	Shipper Information
0x0040	Terms and Conditions
0x0080	Total Weight
0x0100	Transportation Charges Payor Account Number

Overwrite: Determines whether label files will be overwritten.

If True (default value) the label files are overwritten. Otherwise, an error is returned if the file exist.

PackageDocumentFile: The file path for the additional package documents.

When package documents are received from FedEx, they will be put in the filepath specified in the following format:

So if the path "C:\packageDoc.png" is specified and you receive an auxiliary label, the file "C:\packageDoc_AUXILIARY_LABEL1.png" will be created.

PackageDryIceWeight[i]: The weight of the dry ice for each package.

This is required to be provided in a ship request when shipping Dry Ice (i.e., when the corresponding flag for DryIce is present (requested) in the ShipmentSpecialServices). Dry ice shipping is allowed for FedEx Express services only (U.S. domestic, intra-Canadian, and FedEx Express International shipments). FedEx assesses a surcharge on each package containing dry ice. Dry ice weight cannot be greater than the package weight. The dry ice weight type is KGS only. There is a limit of 2.5 KG dry ice for destination.

NOTE: The weight will always be specified in KG.

PackageFreightCommodityIds[i]: The Freight Commodity Line Item IDs associated with this package.

For FedEx Freight Shipments, set this config to specify the Freight Commodity Line Item IDs associated with this package. This setting accepts multiple, comma separated IDs. For example: class.Commodities[0].Id = "Item1"; ... class.Commodities[1].Id = "Item2"; class.Config("PackageFreightCommodityIds[0]=Item1,Item2");

Note: This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

PackagePhysicalPackagingType[i]: Additional details about the physical packaging of the item in a FedEx Freight shipment.

Set this config to specify additional details about how the item has been physically packaged for a FedEx Freight shipment.

The applicable values include the following:


0 (default)	Not Set
1	BAG
2	BARREL
3	BASKET
4	BOX
5	BUCKET
6	BUNDLE
7	CAGE
8	CARTON
9	CASE
10	CHEST
11	CONTAINER
12	CRATE
13	CYLINDER
14	DRUM
15	ENVELOPE
16	HAMPER
17	OTHER
18	PACKAGE
19	PAIL
20	PALLET
21	PARCEL
22	PIECE
23	REEL
24	ROLL
25	SACK
26	SHRINKWRAPPED
27	SKID
28	TANK
29	TOTEBIN
30	TUBE
31	UNIT

PrintedReferenceBillOfLading: Shipper's Bill of Lading number to be printed on the label.

Shipper's Bill of Lading number to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.

PrintedReferenceConsigneeId: Consignee Id to be printed on the label.

Consignee Id to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.

PrintedReferenceShipperId: Shipper Id to be printed on the label.

Shipper Id to be printed on the label. This configuration setting can be used when LabelFormatType is set to Freight Straight Bill of Lading or VICS Bill of Lading.

RawRequest: Contains the complete request sent to the Server.

This returns the complete request as sent to the server. Used for debugging purposes.

RawResponse: Contains the complete response returned by the Server.

This returns the complete response as received from the server. Used for debugging purposes.

RecipientTinNumber: Indicates the corresponding Id number for recipient TIN type.

This element should be included in the request in order to produce a Commercial Invoice. You can specify the recipient TIN type by setting the RecipientTinType. When this is set, you must also specify the Taxpayer Identification Number (RecipientTinNumber) with the corresponding Id number for shipper TIN Type.

RecipientTinType: Indicates the type of the recipient tax identification number (TIN).

You can specify the recipient TIN type by setting the RecipientTinType. When this is set, you must also provide the corresponding Taxpayer Identification Number.

This type must match the data entered in the RecipientTinNumber.

Valid values for the taxpayer identification number's (TIN) type are:


BUSINESS_NATIONAL
BUSINESS_STATE
BUSINESS_UNION
PERSONAL_NATIONAL
PERSONAL_STATE

RegulatoryControlType: Identifies the type of regulatory control.

Possible values are: 'FOOD_OR_PERISHABLE', 'USMCA', 'NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS', 'NOT_IN_FREE_CIRCULATION'. 'FOOD_OR_PERISHABLE' value is required by FDA/BTA for food/perishable items coming to US or PR from non-US/non-PR origin.

ReturnDescription: Description for the return.

If ReturnType is set to Other then ReturnDescription must be set, otherwise it is optional.

ReturnType: Identifies the reason for return.

Identifies the reason for a global return, as recognized by Customs.

Valid values are:


Value	Meaning
0	Exhibition Trade Show.
1	Faulty Item.
2	For Repair.
3	Item For Loan.
4	Other.
5	Rejected.
6	Trial.

SenderTinNumber: Indicates the corresponding Id number for shipper TIN type.

As the shipper, your tax identification information must be uploaded to FedEx for EEI/SED shipments. This element should be included in the request in order to produce a Commercial Invoice. You can specify the shipper TIN type by setting the SenderTinType. When this is set, you must also specify the Taxpayer Identification Number (SenderTinNumber) with the corresponding Id number for shipper TIN Type.

SenderTinType: Indicates the type of the shipper tax identification number (TIN).

As the shipper, your tax identification information must be uploaded to FedEx for EEI/SED shipments. This element should be included in the request in order to produce a Commercial Invoice. You can specify the shipper TIN type by setting the SenderTinType. When this is set, you must also provide the corresponding Taxpayer Identification Number.

This type must match the data entered in the SenderTinNumber.

Valid values for the taxpayer identification number's (TIN) type are:


BUSINESS_NATIONAL
BUSINESS_STATE
BUSINESS_UNION
PERSONAL_NATIONAL
PERSONAL_STATE

ShipmentRatingAggregate: String representing the rating detail on shipment level.

Upon a successful ship request, the shipment rating is returned in the server response only if the PayorType is set to 0 (SENDER). This will be stored as a string in the ShipmentRatingAggregate, formatted as XML. This setting is read-only.

ShippingDocumentFile: Identifies the location of the document file.

When a document file is received, it will be put at the location specified with the following format:

>ShippingDocumentFile<_>type<>sequence number<.pdf

Note that there will not be a sequence number if the file is the only file of its type.

ShippingDocumentImageType: Specifies the image or printer commands format of the shipping document.

This element indicates the format in which the shipping document should be printed.

Possible values are:


0	PDF (default)
1	PNG
2	ELP2
3	ZPLII
4	DPL

ShippingDocumentStockType: Indicates the size of the shipping document and the location of the doc tab if present.

All 'Paper *' items should be used when a laser printer is being used to print the generated document file (ie. ShippingDocumentImageType is set to PDF or PNG).

All 'Stock *' items should be used when a thermal printer is being used to print the generated document file (ie. ShippingDocumentImageType is set to ELP2, ZPLII or DPL).

By Default, 7 (PAPER_LETTER) will be used. Valid label stock types are:


1	OP_900_LG
2	OP_900_LG_B
3	OP_900_LL
4	OP_900_LL_B
5	OP_950
6	PAPER_4X6
7	PAPER_LETTER (default)
8	STOCK_4X6
9	STOCK_4X6.75_LEADING_DOC_TAB
10	STOCK_4X6.75_TRAILING_DOC_TAB
11	STOCK_4X8
12	STOCK_4X9_LEADING_DOC_TAB
13	STOCK_4X9_TRAILING_DOC_TAB

ShippingDocumentTypes: Specifies which document type to get.

This specifies which documents you would like FedEx to generate and send back to you.

To request one or more 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:


Value	Description
0x0	None
0x0001	Certificate of Origin
0x0002	Commercial Invoice
0x0004	NAFTA Certificate of Origin
0x0040	Freight Address Label
0x1000	FedEx Freight Straight Bill of Lading
0x2000	VICS Bill of Lading

ShipTime: Local Time of shipment based on shipper's time zone.

This config is used in combination with ShipDate property. Together, these identify the date and time the package is tendered to FedEx. This is optional to be entered in the ship request. If not provided, defaults to the current U.S. Central Standard Time. Format: HH:MM:SS using a 24 hour clock (e.g. 11:00 a.m. is 11:00:00, whereas 5:00 p.m. is 17:00:00).

SizeUnit: The dimension unit.

Declares the type of size units to be used in calculating the size of the shipment and each package contained in it. This is required if package dimensions are passed in the request.

Valid dimension unit of measure codes: IN and CM. Defaults to IN if a value is not passed in the transaction.

TESTMODE: This configuration setting will allow you to run test transactions.

When setting this configuration setting to True the transactions will be directed to the default testing end-point. component.Config("TESTMODE=true");

Default value is False, transactions are directed to the default production end-point.

Warning: Warning message returned by the server.

This might be returned by the server even upon successful response. These warnings are usually informational.

WeightUnit: Weight unit.

This is required when submitting a rate or ship request. It declares the type of weight unit to be used in calculating the weight of the shipment and each package contained in it.

Valid weight types: LB and KG. Defaults to LB if a value is not passed in the transaction. It must be LB for a U.S. Domestic rate quote or ship request.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword: A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount: The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

SSLCACertFilePaths: The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (FedExFreightShip Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

FedExFreightShip Errors

301	Operation interrupted (or timeout).
432	Invalid index.
527	Server Error Response.
528	Property set with invalid data.

The class may also return one of the following error codes, which are inherited from other classes.


BAG
BBL
BDL
BOX
BSK
BXT
CAG
CAS
CHS
CNT
CRT
CTN
CYL
DRM
ENV
PAL
PCL
PCS
PKG
PLT
REL
ROL
SAK
SHW
SKD
TBE
TBN
TNK
UNT


BAG
BBL
BDL
BOX
BSK
BXT
CAG
CAS
CHS
CNT
CRT
CTN
CYL
DRM
ENV
PAL
PCL
PCS
PKG
PLT
REL
ROL
SAK
SHW
SKD
TBE
TBN
TNK
UNT


BAG
BBL
BDL
BOX
BSK
BXT
CAG
CAS
CHS
CNT
CRT
CTN
CYL
DRM
ENV
PAL
PCL
PCS
PKG
PLT
REL
ROL
SAK
SHW
SKD
TBE
TBN
TNK
UNT