FedExFreightShip Component
Properties Methods Events Configuration 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
nsoftware.InShip.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 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.
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.
| 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 type of brokerage. |
| CarrierType | The carrier type. |
| 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. |
| DropoffType | Identifies the method by which the package is to be tendered to FedEx. |
| 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. |
| 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. |
| 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 from FedEx as an Electronic Trade Document. |
| 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 component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| SubmittedBy | Identifies the person who submitted the pickup request. |
| Timeout | A timeout for the component. |
| 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. |
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. |
| 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. |
| ReprintDocuments | Reprints the requested document. |
| Reset | Resets the internal state of the component and all properties to their default values. |
| SchedulePickup | This method schedules a courier pickup. |
| UploadDocuments | Uploads documents to FedEx. |
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. |
| UseSOAP | Determines if the FedEx SOAP web services are used instead of the FedEx XML web services. |
| CustomContent | Defines any custom content to print on the label. |
| CODReferenceIndicator | The reference information to be added to the COD return label. |
| DryIceCount | The number of packages which contain dry ice. |
| PackageDryIceWeight[i] | The weight of the dry ice for each package. |
| SizeUnit | The dimension unit. |
| WeightUnit | Weight unit. |
| BlockVisibility | Whether the visibility of this shipment should be blocked from parties other than shipper/payor. |
| 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. |
| CODRecipientState | The state of the COD recipient. |
| CODRecipientZipCode | The zip code of the COD recipient. |
| CODRecipientResidential | The residential status of the COD recipient. |
| CSPOriginLocationId | Origin location Id for the CSP developer sending the version capture request. |
| CSPProductPlatform | Vendor product platform name. |
| CustomerTransactionId | Customer transaction id. |
| DocTabContent | Custom DocTab content set by the user when preparing a shipping label. |
| 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. |
| PackageDocumentFile | The file path for the additional package documents. |
| ShipmentRatingAggregate | String representing the rating detail on shipment level. |
| ShipTime | Local Time of shipment based on shipper's time zone. |
| AdmissibilityPackageType | Identifies the admissibility package type. |
| B13AFiling | Specifies which option is being exercised by the customer to file the B13A. |
| BookingNumber | Booking confirmation number. |
| CurrencyCode | The currency code associated with the monetary values present in the request. |
| CODType | COD type. |
| DeliveryInstructions | Delivery instructions. |
| Documents | Whether an international shipment contains only documents or no documents. |
| ExportCompliance | This is an export compliance statement. |
| InvoiceSpecialInstructions | Special instructions for commercial invoices. |
| LoadAndCount | Shipper's Load and Count (SLAC) = total shipment pieces. |
| PrintedReferenceBillOfLading | Shipper's Bill of Lading number to be printed on the label. |
| PrintedReferenceShipperId | Shipper Id to be printed on the label. |
| PrintedReferenceConsigneeId | Consignee Id to be printed on the label. |
| RecipientTinType | Indicates the type of the recipient tax identification number (TIN). |
| RecipientTinNumber | Indicates the corresponding Id number for recipient TIN type. |
| RegulatoryControlType | Identifies the type of regulatory control. |
| SenderTinType | Indicates the type of the shipper tax identification number (TIN). |
| SenderTinNumber | Indicates the corresponding Id number for shipper TIN type. |
| 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. |
| ShippingDocumentFile | Identifies the location of the document file. |
| FreightAccountNumber | Account number used with the FedEx Freight service. |
| FreightBillingPersonName | The name of the person to be billed. |
| FreightBillingCompanyName | The name of the company to be billed. |
| FreightBillingPhone | The phone number of the party to be billed. |
| FreightBillingFax | The fax number of the party to be billed. |
| FreightBillingEmail | The email of the party to be billed. |
| FreightBillingAddress1 | The first address line of the party to be billed. |
| FreightBillingAddress2 | The second address line of the party to be billed. |
| FreightBillingCity | The city of the party to be billed. |
| FreightBillingState | The state of the party to be billed. |
| FreightBillingCountryCode | The country code of the party to be billed. |
| FreightBillingZipCode | The zip code of the party to be billed. |
| FreightAlternateBillingAccountNumber | The alternate account number to be billed. |
| FreightAlternateBillingPersonName | The name of the person to be billed. |
| FreightAlternateBillingCompanyName | The name of the company to be billed. |
| FreightAlternateBillingStreetAddress | The street address line of the party to be billed. |
| FreightAlternateBillingCity | The city of the party to be billed. |
| FreightAlternateBillingState | The state of the party to be billed. |
| FreightAlternateBillingCountryCode | The country code of the party to be billed. |
| FreightAlternateBillingZipCode | The zip code of the party to be billed. |
| FreightClientDiscountPercent | Estimated discount rate provided by client for unsecured rate quote. |
| FreightCollectTermsType | The terms of the collect payment for a Freight Shipment. |
| FreightComment | Description for the shipment. |
| FreightDeclaredValue | The declared value for the shipment. |
| FreightDeclaredValueUnits | The declared value units. |
| FreightHazardousMaterialsOfferor | The offeror of the hazardous materials. |
| FreightLiabilityCoverageAmount | The total amount of liability coverage. |
| FreightLiabilityCoverageType | The type of liability coverage offered. |
| FreightPalletWeight | Total weight of pallets used in shipment. |
| FreightRole | Indicates the role of the party submitting the transaction. |
| FreightShipmentLength | The overall length of the shipment. |
| FreightShipmentWidth | The overall width of the shipment. |
| FreightShipmentHeight | The overall height of the shipment. |
| FreightTotalHandlingUnits | The total handling units for the shipment. |
| FreightItemLength[i] | The length of the specified freight item. |
| FreightItemHeight[i] | The height of the specified freight item. |
| FreightItemWidth[i] | The width of the specified freight item. |
| FreightItemVolume[i] | Volume of the specified freight item. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| 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. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| 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. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| 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. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| 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). |
| 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| 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. |