IBiz Fedex ship Component : ship OCX, ship .NET Component, ship Class, ship Bean, ship Object

Available in: FEDEX | USPS

Ship Component [IBiz FedEx Integrator V1]

Properties Methods Events Configuration Settings

Allows you to generate a FedEx shipping label 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 the ShipPackage 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 to associate the shipment (such as Saturday Pickup, Saturday Delivery, Hold At Locations, etc.).

Canceling a shipment already included in the daily shipping log, 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 AccountNumber, MeterNumber and CarrierCode used originally to ship the package.

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

To use this component, you must have a FedEx account number (AccountNumber) and a meter number (MeterNumber) uniquely assigned to your account by FedEx, which can be retrieved by using our SUBSCRIBE component.

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 IBiz FedEx Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.

Property List

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


AccountNumber	Account number for logging in to the FedEx ServerURL.
BaseCharge	Base rate amount for the shipment.
CIComments	Comments on Commercial Invoice (CI).
COD	Whether COD (Cash On Delivery) is selected.
CODAmount	COD collection amount (if applicable).
CODReport	Image of the COD report for FedEx Ground COD shipments.
CODType	COD type.
CarrierCode	Carrier code used to ship the package.
CloseDate	Date up to which the unclosed FedEx Ground shipments are to be closed.
CloseTime	Time up to which the unclosed FedEx Ground shipments are to be closed.
CommodityCount	Number of commodities (items) included in the package being shipped.
CommodityDescription	Complete and accurate description of a commodity item.
CommodityHarmonizedCode	Unique alpha/numeric representing a commodity item.
CommodityManufacturer	Country code where the commodity item contents were produced or manufactured in their final form.
CommodityQuantity	Number of units of a commodity line item.
CommodityUnit	Unit of measure used for a commodity line item.
CommodityUnitPrice	Value of each CommodityUnit.
CommodityWeight	Weight of the commodity item.
CurrencyCode	Currency code.
DeclaredValue	The declared value of entire shipment/package contents.
DeliveryDate	Date on which package will be delivered.
DeliveryDay	Day of the week on which package will be delivered.
DropoffType	Dropoff type.
DutiesPayorType	Payment type for duties and taxes.
FromAddress1	Primary address line from which the shipment is originating.
FromAddress2	Secondary address line from which the shipment is originating.
FromCity	City name from which the shipment is originating.
FromCompany	Company from which the shipment is originating.
FromCountry	Country code from which the shipment is originating.
FromName	Name of the person initiating the shipment.
FromPhoneNumber	The phone number of the person initiating the shipment.
FromPostalCode	Postal code from which the shipment is originating.
FromState	State or province code from which the shipment is originating.
HazMatCertificate	Image of the Hazardous Materials certification report for FedEx Ground HazMat shipments.
HoldAtAddress	Street address for the location where the shipment is being held.
HoldAtCity	City name of the location where the shipment is being held.
HoldAtLocation	Whether Hold At location special service is selected for FedEx Express.
HoldAtPhoneNumber	The phone number for the location where the shipment is being held.
HoldAtPostalCode	Postal code for the location where the shipment is being held.
HoldAtState	State or province code of the location where the shipment is being held.
HomeDeliveryDate	Date for Ground Home Delivery service.
HomeDeliveryPhone	The phone number for Ground Home Delivery service.
HomeDeliveryType	Type of Ground Home Delivery service.
LabelImageType	Type of data stream or bitmap to be returned.
ListRate	Whether a list rate courtesy quotes should be included in the server response.
Manifest	Image of the manifest retrieved by FedEx for FedEx Ground shipment activity.
MeterNumber	Meter number to use for submitting requests to the FedEx ServerURL.
MultiweightReport	Image of the multiweight report for FedEx Ground multiweight shipments.
NetCharge	Net charge amount for this shipment.
PackageHeight	The height of the package to be shipped.
PackageLength	The length of the package to be shipped.
PackageWidth	The width of the package to be shipped.
PackagingType	Packaging type for the shipment.
PayorAccountNumber	The FedEx account number for the payor of the shipment.
PayorCountry	The country code for the payor of the shipment.
PayorType	Method of payment for shipment.
Reference	Customer reference information assigned to a package.
ReportFile	File name of the report to be saved and/or printed by customer.
ReportIndicator	Indicates which report(s) from the last 3 days are to be returned in a report-only close operation request.
ReportOnly	Whether or not CloseOperation sends a close request or a report only request.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
ServerURL	URL for the FedEx server where the requests are sent.
ServiceType	FedEx service type the package is to be shipped by.
ShippingLabel	Image of the shipping label retrieved by FedEx ServerURL upon a successful ship request transaction.
ShippingLabelFile	Filename and location to save the ShippingLabel to.
SignatureOption	Specifies one of the Delivery Signature Options.
SizeUnit	The dimension unit of the package.
Timeout	A timeout for the component.
ToAddress1	Primary address line to which the shipment is destined.
ToAddress2	Secondary address line to which the shipment is destined.
ToCity	Name of the city to which the shipment is destined.
ToCompany	Name of the company to whom the shipment is destined.
ToCountry	Country code to which the shipment is destined.
ToName	Name of the person to whom the shipment is destined.
ToPhoneNumber	Phone number for the contact person to whom the shipment is destined.
ToPostalCode	Postal code to which the shipment is destined.
ToState	State or province code to which the shipment is destined.
TotalCustomsValue	Total customs value for the shipment/package.
TotalDiscount	Total discount amount applied to this shipment.
TotalSurcharge	Total surcharge amount applied to ship this package.
TrackingNumber	Tracking number assigned to the shipment.
Weight	Package weight.
WeightUnit	Weight unit used for the shipment.

Method List

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


CancelShipment	Cancels a shipment by deleting it from the shipping log.
CloseOperation	Closes out all FedEx Ground shipments made for the day and generates reports (including a manifest report).
Config	Sets or retrieves a component configuration setting.
Reset	Reset the internal state of the component and all properties to their default values.
ShipPackage	Prepares a shipping label.

Event List

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


Error	Information about errors during data delivery.
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 complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
Alcohol	Whether the shipment contains alcohol.
AlcoholCount	Number of units of alcohol included in the package.
AlcoholPackaging	The packaging type for the alcohol being shipped.
AlcoholType	The type of alcohol being shipped.
AlcoholVolume	The quantity (in liters) of alcohol being shipped.
BookingNumber	Booking confirmation number.
CIComments	Comments on the shipment being made.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
CustomerInvoiceNumber	Customer Invoice number.
DeliveryNotifyRecipient	Whether delivery notification has to be sent to recipient's e-mail address.
DeliveryNotifySender	Whether delivery notification has to be sent to sender's e-mail address.
DiscountedSurchargeAggregate	Aggregate of surcharges (according to discounted rates).
DocTabLocation	Specifies doc-tab location on the thermal label (if applicable).
Documents	Whether this shipment contains only documents or no documents.
DutiesPayorAccountNumber	FedEx account number billed for duties/taxes.
DutiesPayorCountryCode	Country code where the duty/tax payor resides.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FromEmailAddress	Sender's email address where the ship or delivery notification can be e-mailed to.
FullRequest	Contains the full request sent to the FedEx server.
FullResponse	Contains the full response returned by the FedEx server.
FutureDayShip	Whether this shipment is scheduled for a future date.
HTTPVersion	The version of HTTP used by the component
HomeDeliveryInstructions	Instructions for Home Delivery service (if applicable).
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
LabelStockOrientation	Specifies label stock orienation on the thermal label (if applicable).
ListSurchargeAggregate	Aggregate of surcharges applied to shipment (according to list rates).
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
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).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
Overwrite	Determines whether label files will be overwritten.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic 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 Basic authentication is to be used for the proxy.
ResidentialDelivery	Whether this shipment is residential delivery.
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
SaturdayDelivery	Whether the shipment is scheduled for Saturday delivery.
SaturdayPickup	Whether the shipment is scheduled for Saturday pickup.
ServiceListBaseCharge	Base charge (list rate).
ServiceListNetCharge	Net charge (list rate).
ServiceListTotalDiscount	Total discount applied (list rate).
ServiceListTotalSurcharge	Total surcharge applied (list rate).
ShipDate	The date on which the package will be shipped.
ShipNotifyRecipient	Whether ship alert notification has to be sent to recipient's e-mail address.
ShipNotifySender	Whether ship alert notification has to be sent to sender's e-mail address.
ShipTime	Local Time of shipment based on shipper's time zone.
SocketHandle	The handle of the main socket used by the component.
ToEmailAddress	Recipient's email address where the ship or delivery notification can be e-mailed to.
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
UserAgent	Information about the user agent (browser).
Warning	Information on a Soft Error (if applicable).
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)
XPath	Used to retrieve data at any place within the response.