Shipping Integrator FedExShip Component : FedExShip OCX, FedExShip .NET Component, FedExShip Class, FedExShip Bean, FedExShip Object

Available in: SHIPPING

FedExShip Component [Shipping Integrator V4]

Properties Methods Events Configuration Settings

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.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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 allows you also to delete packages included in the daily shipping log that have not already been tendered to FedEx. This can be done by calling CancelShipment method where the TrackingNumber parameter that identifies the shipment, has to be specified in the request along with the FedExAccount, FedExAccount, FedExAccount, and FedExAccount.

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 FedExAccount. You should also have already obtained a FedExAccount, FedExAccount and a FedExAccount 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.


CloseDate	Identifies the date up to which the unclosed FedEx Ground shipments are to be closed.
CloseReportFile	File name of the report to be saved and/or printed by customer.
CloseReportType	Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.
CloseTime	Identifies the time up to which the unclosed FedEx Ground shipments are to be closed.
CloseTrackingNumber	Shipment Ground tracking number.
CODTotalAmount	The total amount to be collected.
CODType	COD type.
CompanyCloseTime	The time your company closes.
DeliveryDate	Date on which shipment is expected to be delivered.
DropoffType	Identifies the method by which the package is to be tendered to FedEx.
FedExAccountNumber	Account number for logging in to the FedEx Server .
FedExCSPProductId	Identifies the CSP product.
FedExCSPProductVersion	Identifies the CSP product version.
FedExCSPUserKey	CSP end user key.
FedExCSPUserPassword	CSP end user password.
FedExDeveloperKey	Identifying part of the authentication key used for the sender's identity.
FedExMeterNumber	Meter number to use for submitting requests to the FedEx Server .
FedExPassword	Secret part of authentication key used for the sender's identity.
FedExServer	URL for the FedEx Server where the requests are sent.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
HazMatCertificate	Image of a Hazardous Materials certification report.
HoldAtLocationAddress1	Street name.
HoldAtLocationAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
HoldAtLocationCity	Name of city, town, etc.
HoldAtLocationCountryCode	Country code.
HoldAtLocationState	State or province code.
HoldAtLocationZipCode	Postal code.
HoldAtLocationContactCompany	Identifies the contact person's company name.
HoldAtLocationContactEmail	Identifies the contact person's email address.
HoldAtLocationContactFax	Recipient's fax number.
HoldAtLocationContactFirstName	Sender's first name.
HoldAtLocationContactLastName	Person's last name.
HoldAtLocationContactMiddleInitial	Middle initial.
HoldAtLocationContactPhone	Identifies the contact person's phone number.
HoldAtLocationPhone	Phone number of the FedEx location where the shipment will be hold at.
HomeDeliveryDate	Date for Ground Home Delivery service.
HomeDeliveryPhone	The phone number of the delivery location.
HomeDeliveryType	The type of Home Delivery Premium service being requested.
InsuredValue	Total insured amount.
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.
Manifest	Image of the manifest for FedEx Ground shipment activity.
MasterTrackingNumber	Tracking number assigned to the whole MPS shipment.
MultiweightReport	Image of a multiweight report.
NotifyCount	The number of records in the Notify arrays.
NotifyAggregate	This can be used to set the entire aggregate xml for the recipient to be notified.
NotifyEmail	Email address of the recipient to be notified.
NotifyFax	Fax number of the recipient that is going to receive the Signature Proof of Delivery via fax.
NotifyMessage	User defined text that will be included in the email to be sent to Email .
NotifyName	The name associated with the notification.
NotifyFlags	Identifies the type of notification requested.
NotifyType	Identifies the set of valid email notification recipient types.
PackageLocation	The location of pickup.
PackageCount	The number of records in the Package arrays.
PackageBaseCharge	Base charge applicable to this package.
PackageCODAmount	The COD monetary value for the package.
PackageCODFile	Filename and location to save the CODLabel of this package to.
PackageCODLabel	Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.
PackageDangerousGoodsAccessible	Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.
PackageDescription	For FedEx, this is the description that appears in the email to identify this package.
PackageHeight	The height of the package to be shipped.
PackageInsuredValue	Amount of insurance requested for this package.
PackageLength	The length of the package to be shipped.
PackageNetCharge	Net charge applicable to this package.
PackageType	The packaging type of the package being rated and/or shipped.
PackageReference	Indicates the package reference type and value, that associates this package (assigned by the customer).
PackageShippingLabel	Image of the shipping label for this package return by the Server upon a successful ship response.
PackageShippingLabelFile	Filename and location to save the ShippingLabel of this package to.
PackageSignatureType	Specifies one of the Delivery Signature Options requested for this package.
PackageSpecialServices	Contains the collection of special services offered on the package level.
PackageTotalDiscount	Total discount applicable to this package.
PackageTotalSurcharges	Total surcharges applicable to this package.
PackageTrackingNumber	Tracking number assigned to this package.
PackageWeight	Weight of this package.
PackageWidth	The width of the package to be shipped.
PayorAccountNumber	The account number of the party responsible for payment (shipping charges, or duties and taxes).
PayorCountryCode	The country code for the payor of the shipment, or duties and taxes.
PayorType	Method of payment for shipment, or duties and taxes.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
RecipientAddress1	Street name.
RecipientAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlags	Various flags that denote information about the address.
RecipientCity	Name of city, town, etc.
RecipientCountryCode	Country code.
RecipientState	State or province code.
RecipientZipCode	Postal code.
RecipientCompany	Identifies the contact person's company name.
RecipientEmail	Identifies the contact person's email address.
RecipientFax	Recipient's fax number.
RecipientFirstName	Sender's first name.
RecipientLastName	Person's last name.
RecipientMiddleInitial	Middle initial.
RecipientPhone	Identifies the contact person's phone number.
SenderAddress1	Street name.
SenderAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderAddressFlags	Various flags that denote information about the address.
SenderCity	Name of city, town, etc.
SenderCountryCode	Country code.
SenderState	State or province code.
SenderZipCode	Postal code.
SenderCompany	Identifies the contact person's company name.
SenderEmail	Identifies the contact person's email address.
SenderFax	Recipient's fax number.
SenderFirstName	Sender's first name.
SenderLastName	Person's last name.
SenderMiddleInitial	Middle initial.
SenderPhone	Identifies the contact person's phone number.
ServiceType	Identifies the FedEx domestic service to use in a ship request.
ShipDate	The date on which the package was tendered to FedEx.
ShipmentSpecialServices	Contains the collection of special services offered by FedEx.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
TotalNetCharge	The total net charge applied to the whole shipment (specific to the AccountNumber ).
TotalWeight	Total shipment weight.
TransitTime	Expected 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.


CancelPackage	Cancels a single package shipment by deleting it from the shipping log.
CancelPickup	Cancels a scheduled Carrier Pickup request.
CancelShipment	Cancels a multi-package (MPS) shipment by deleting it from the shipping log.
CloseGroundShipments	Closes out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests.
Config	Sets or retrieves a configuration setting.
CSPVersionCapture	Uploads your CSP software version information to FedEx when you close your ship day.
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.
Reset	Resets the internal state of the component and all properties to their default values.
SchedulePickup	Schedules a courier pickup and provides the user a confirmation number for the scheduled 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.


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


RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
XPath	Used to retrieve data at any place within the response.
Warning	Warning message returned by the server.
CSPUserKey	CSP end user key.
CSPUserPassword	CSP end user password.
CSPProductId	Identifies the CSP product.
CSPProductVersion	Identifies the CSP product version.
CODReferenceIndicator	The reference information to be added to the COD return label.
DryIceCount	Number of packages in this shipment which contain dry ice.
DryIceWeight	Total weight of the dry ice for this shipment.
SizeUnit	The dimension unit.
WeightUnit	Weight unit.
BlockVisibility	Whether the visibility of this shipment should be blocked from parties other than shipper/payor.
DeliveryDay	Day of the week on which shipment is expected to be delivered.
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.
MaskAccountNumber	Whether the shipper account number is masked on the shipping label.
Overwrite	Determines whether label files will be overwritten.
ShipmentRatingAggregate	String representing the rating detail on shipment level.
ShipTime	Local Time of shipment based on shipper's time zone.
CustomerTransactionId	Customer transaction id.
CSPOriginLocationId	Origin location Id for the CSP developer sending the version capture request.
CSPProductPlatform	Vendor product platform name.
AccessTime	Time window for FedEx to pickup up the package.
BookingNumber	Booking confirmation number.
CODRecipientAddress1	Street name of the COD recipient.
CODRecipientAddress2	A specific detail on the COD recipient's address (such as bulding, suite, appartment, floor number etc.).
CODRecipientCity	Name of city, town, etc. of the COD recipient.
CODRecipientCompany	Company name of the COD recipient.
CODRecipientCountryCode	Country code of the COD recipient.
CODRecipientName	Name of the COD recipient.
CODRecipientPhone	Phone number of the COD recipient.
CODRecipientResidential	Indicates whether the COD recipient address is residential (as opposed to commercial).
CODRecipientState	State or province code of the COD recipient.
CODRecipientZipCode	Postal code of the COD recipient.
CODTrackingNumber	The COD Tracking Number.
CutoffTime	Latest pickup time.
DeliveryInstructions	Delivery instructions.
PackageRatingAggregate[i]	String representing the rating detail on package level (at index i).
RMANumber	The RMA number associated with the return shipment.
RMAReason	The RMA reason description.
SpecialInstructions	Special instructions for the courier.
UseAccountAddress	Whether or not the pickup should be sent to the address associated with the account.
SmartPostAncillaryEndorsement	The endorsement type used for a FedEx SmartPost shipment.
SmartPostCustomerManifestId	The Customer Manifest Id used to group FedEx SmartPost packages.
SmartPostHubId	The HubId used to send FedEx SmartPost shipments.
SmartPostIndicia	The Indicia type used for a FedEx SmartPost shipment.
SmartPostPhysicalPackaging	Additional details about the physical packaging of the item in a FedEx SmartPost shipment.
SmartPostTrackingNumbers	Contains the tracking numbers for a FedEx SmartPost shipment.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
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).
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.
CodePage	The system code page used for Unicode to Multibyte translations.