4D Shipping SDK 2020 .NET Edition

Questions / Feedback?

FedExShip Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DShipping.Fedexship

Remarks

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

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

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

To use this component, you must have a FedEx AccountNumber. You should also have already obtained a DeveloperKey, Password and a MeterNumber uniquely assigned to your account by FedEx after registration for Web Services.

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.

Please note that our components support the non-SOAP version of FedEx Web Services. You might have to specify this detail while submitting the certification package. Upon successful certification, FedEx will provide you with new credentials and URL to be used in the production environment (while the credentials work for both SOAP and non-SOAP FedEx Web Services, the URL is SOAP/non-SOAP specific).

Property List


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

CarrierTypeThe carrier type.
CloseRequestIdentifies the close request.
CODLabelThe label that is returned.
CODLabelFileThe file the COD label should be written to.
CODTotalAmountThe total amount to be collected on delivery.
CODTrackingNumberContains the tracking number for the COD return shipment.
CODTypeCOD type.
CompanyCloseTimeThe time your company closes.
DeliveryDateDate on which shipment is expected to be delivered.
DropoffTypeIdentifies the method by which the package is to be tendered to FedEx.
FedExAccountLogin information for FedEx.
FirewallA set of properties related to firewall access.
FreightGuaranteeIdentifies the freight guarantee details.
HazMatCertificateImage of a Hazardous Materials certification report.
HoldAtLocationIdentifies the FedEx location where you want to have your shipment held for pickup.
HoldAtLocationContactThe contact information for shipment when the Hold At Location service is used.
HoldAtLocationPhonePhone number of the FedEx location where the shipment will be hold at.
HomeDeliveryDateDate for Ground Home Delivery service.
HomeDeliveryPhoneThe phone number of the delivery location.
HomeDeliveryTypeThe type of Home Delivery Premium service being requested.
InsuredValueTotal insured amount.
LabelImageTypeType of image or printer commands the label is to be formatted in.
LocationThe FedEx location identifier that received the express dispatch request.
ManifestImage of the manifest for FedEx Ground shipment activity.
MasterTrackingNumberTracking number assigned to the whole MPS shipment.
MultiweightReportImage of a multiweight report.
NotifyCollection of recipients to get notified.
OriginAddressIdentifies the originating address.
OriginContactIdentifies the sender's contact info.
PackageLocationThe location of pickup.
PackagesA collection of packages contained in the shipment.
PayorIdentifies the payor of transportation charges for the requested shipment.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RecipientContactIdentifies the recipient's contact info.
ReturnAddressIdentifies the return address to be printed on the label.
ReturnContactIdentifies the return contact info to be printed on the label.
SenderAddressIdentifies the sender's address.
SenderContactIdentifies the sender's contact info.
ServiceTypeIdentifies the FedEx domestic service to use in a ship request.
ShipDateThe date on which the package will be tendered to FedEx.
ShipmentSpecialServicesContains the collection of special services offered by FedEx.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TotalNetChargeThe total net charge applied to the whole shipment (specific to the AccountNumber ).
TotalWeightTotal shipment weight.
TransitTimeExpected number of days in transit from pickup to delivery.

Method List


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

CancelPackageCancels a single package shipment by deleting it from the shipping log.
CancelPickupCancels a scheduled Carrier Pickup request.
CancelShipmentCancels a multi-package (MPS) shipment by deleting it from the shipping log.
CloseGroundShipmentsCloses out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests.
ConfigSets or retrieves a configuration setting.
CSPVersionCaptureUploads your CSP software version information to FedEx when you close your ship day.
GetPackageLabelGenerates a shipping label for the specified package.
GetShipmentLabelsGenerates a shipping label for all packages in the shipment.
PickupAvailabilityChecks the availability of the courier dispatch service for the given address.
ReprintDocumentsReprints the requested document.
ResetResets the internal state of the component and all properties to their default values.
SchedulePickupThis method schedules a courier pickup.

Event List


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

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

AccessTimeTime window for FedEx to pickup up the package.
BlockVisibilityWhether the visibility of this shipment should be blocked from parties other than shipper/payor.
BookingNumberBooking confirmation number.
CloseSmartPostShipmentsSends a request to close SmartPost Shipments.
CODRecipientAddress1The primary street address of the COD recipient.
CODRecipientAddress1Street name of the COD recipient.
CODRecipientAddress2The secondary street address of the COD recipient.
CODRecipientAddress2A specific detail on the COD recipient's address (such as building, suite, apartment, floor number etc.).
CODRecipientCityThe city of the COD recipient.
CODRecipientCityName of city, town, etc. of the COD recipient.
CODRecipientCompanyThe company of the COD recipient.
CODRecipientCompanyCompany name of the COD recipient.
CODRecipientCountryCodeThe country code of the COD recipient.
CODRecipientCountryCodeCountry code of the COD recipient.
CODRecipientNameThe name of the COD recipient.
CODRecipientNameName of the COD recipient.
CODRecipientPhoneThe phone number of the COD recipient.
CODRecipientPhonePhone number of the COD recipient.
CODRecipientResidentialThe residential status of the COD recipient.
CODRecipientResidentialIndicates whether the COD recipient address is residential (as opposed to commercial).
CODRecipientStateThe state of the COD recipient.
CODRecipientStateState or province code of the COD recipient.
CODRecipientZipCodeThe zip code of the COD recipient.
CODRecipientZipCodePostal code of the COD recipient.
CODReferenceIndicatorThe reference information to be added to the COD return label.
CODTrackingNumberThe COD Tracking Number.
CSPOriginLocationIdOrigin location Id for the CSP developer sending the version capture request.
CSPProductIdIdentifies the CSP product.
CSPProductPlatformVendor product platform name.
CSPProductVersionIdentifies the CSP product version.
CSPUserKeyCSP end user key.
CSPUserPasswordCSP end user password.
CustomContentDefines any custom content to print on the label.
CustomerTransactionIdCustomer transaction id.
CutoffTimeLatest pickup time.
DeliveryDayDay of the week on which shipment is expected to be delivered.
DeliveryInstructionsDelivery instructions.
DocTabContentCustom DocTab content set by the user when preparing a shipping label.
DryIceCountThe number of packages which contain dry ice.
EmailLabelExpirationDateEmail label's expiration date.
EstimateDeliveryDetermines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
FreightAccountNumberAccount number used with the FedEx Freight service.
FreightAlternateBillingAccountNumberThe alternate account number to be billed.
FreightAlternateBillingCityThe city of the party to be billed.
FreightAlternateBillingCompanyNameThe name of the company to be billed.
FreightAlternateBillingCountryCodeThe country code of the party to be billed.
FreightAlternateBillingPersonNameThe name of the person to be billed.
FreightAlternateBillingStateThe state of the party to be billed.
FreightAlternateBillingStreetAddressThe street address line of the party to be billed.
FreightAlternateBillingZipCodeThe zip code of the party to be billed.
FreightBillingAddress1The first address line of the party to be billed.
FreightBillingAddress2The second address line of the party to be billed.
FreightBillingCityThe city of the party to be billed.
FreightBillingCompanyNameThe name of the company to be billed.
FreightBillingCountryCodeThe country code of the party to be billed.
FreightBillingEmailThe email of the party to be billed.
FreightBillingFaxThe fax number of the party to be billed.
FreightBillingPersonNameThe name of the person to be billed.
FreightBillingPhoneThe phone number of the party to be billed.
FreightBillingStateThe state of the party to be billed.
FreightBillingZipCodeThe zip code of the party to be billed.
FreightClientDiscountPercentEstimated discount rate provided by client for unsecured rate quote.
FreightCollectTermsTypeThe terms of the collect payment for a Freight Shipment.
FreightCommentDescription for the shipment.
FreightDeclaredValueThe declared value for the shipment.
FreightDeclaredValueUnitsThe declared value units.
FreightHazardousMaterialsOfferorThe offeror of the hazardous materials.
FreightItemClass[i]The class of the freight item.
FreightItemCountThe number of freight items.
FreightItemDescription[i]The description for the specified freight item.
FreightItemHeight[i]The height of the specified freight item.
FreightItemLength[i]The length of the specified freight item.
FreightItemPackagingType[i]The packaging type for the specified freight item.
FreightItemVolume[i]Volume of the specified freight item.
FreightItemWeight[i]The weight of the specified freight item.
FreightItemWidth[i]The width of the specified freight item.
FreightLiabilityCoverageAmountThe total amount of liability coverage.
FreightLiabilityCoverageTypeThe type of liability coverage offered.
FreightPalletWeightTotal weight of pallets used in shipment.
FreightRoleIndicates the role of the party submitting the transaction.
FreightShipmentHeightThe overall height of the shipment.
FreightShipmentLengthThe overall length of the shipment.
FreightShipmentWidthThe overall width of the shipment.
FreightTotalHandlingUnitsThe total handling units for the shipment.
HasXPathDetermines whether a specific element exists in the document.
LabelFormatTypeIndicates the type of label to be returned.
LabelOrientationTypeIndicates if the top or bottom of the label comes out of the printer.
LabelStockTypeIndicates the size of the label and the location of the doc tab if present.
ListTotalNetCharge[i]Total net charge for list rates applied at package level at index i (if applicable).
MaskAccountNumberWhether the shipper account number is masked on the shipping label.
MerchantPhoneNumberThe merchant's phone number.
OverwriteDetermines whether label files will be overwritten.
PackageAlcoholRecipientType[i]The type of recipient for an Alcohol Special Service package.
PackageCountThe number of packages to be picked up.
PackageDocumentFileThe file path for the additional package documents.
PackageDryIceWeight[i]The weight of the dry ice for each package.
PackageRatingAggregate[i]String representing the rating detail on package level (at index i).
PayorPhonePayor's phone number.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
RMANumberThe RMA number.
RMAReasonThe RMA reason description.
ShipmentRatingAggregateString representing the rating detail on shipment level.
ShipTimeLocal Time of shipment based on shipper's time zone.
SizeUnitThe dimension unit.
SmartPostAncillaryEndorsementThe endorsement type used for a FedEx SmartPost shipment.
SmartPostCustomerManifestIdThe Customer Manifest Id used to group FedEx SmartPost packages.
SmartPostHubIdThe HubId used to send FedEx SmartPost shipments.
SmartPostIndiciaThe Indicia type used for a FedEx SmartPost shipment.
SmartPostPhysicalPackagingAdditional details about the physical packaging of the item in a FedEx SmartPost shipment.
SmartPostTrackingNumbersContains the tracking numbers for a FedEx SmartPost shipment.
SpecialInstructionsSpecial instructions for the courier.
UseAccountAddressWhether or not the pickup should be sent to the address associated with the account.
UseSOAPDetermines if the FedEx SOAP web services are used instead of the FedEx XML web services.
WarningWarning message returned by the server.
WeightUnitWeight unit.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathUsed to set the XPath within the response from the server.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7802]