FedExTrack Class
Properties Methods Events Config Settings Errors
Provides tracking information, SPOD, and notification for a given tracking number or other shipment identifier.
Class Name
DShippingSDK_FedExTrack
Procedural Interface
dshippingsdk_fedextrack_open(); dshippingsdk_fedextrack_close($res); dshippingsdk_fedextrack_register_callback($res, $id, $function); dshippingsdk_fedextrack_get_last_error($res); dshippingsdk_fedextrack_get_last_error_code($res); dshippingsdk_fedextrack_set($res, $id, $index, $value); dshippingsdk_fedextrack_get($res, $id, $index); dshippingsdk_fedextrack_do_config($res, $configurationstring); dshippingsdk_fedextrack_do_getproofofdelivery($res, $trackingnumber); dshippingsdk_fedextrack_do_requestemailnotification($res, $trackingnumber); dshippingsdk_fedextrack_do_reset($res); dshippingsdk_fedextrack_do_saveproofofdelivery($res, $trackingnumber, $filename); dshippingsdk_fedextrack_do_trackshipment($res, $idvalue);
Remarks
This class provides Tracking, Signature Proof of Delivery (SPOD), and Notification services:
- Tracking Service: to obtain real-time tracking information for FedEx Express, FedEx Ground, FedEx Home Delivery, FedEx Express Freight, and FedEx Custom Critical shipments.
- Signature Proof of Delivery (SPOD): to request a proof of delivery letter that includes a graphic image of your recipient's signature after your shipment has been delivered.
- Notification to have FedEx automatically notify you and/or your customer and/or another third party by e-mail, fax, or wireless of significant shipment events, such as clearance delays, delivery attempts, releases, consolidated proofs of delivery, and pre-alerts.
The available options for Tracking service are:
Track by Tracking Number
On Single Piece Shipments, the tracking number represents the package's tracking number. This option applies to Express, Ground, Freight and Custom Critical shipments. You can track any package shipped by FedEx using TrackShipment method by providing this number as the value of idValue parameter. No extra qualifiers (date range, etc.) are required in such case, but are recommended. It is also recommended that you provide the Carrier Code to ensure the desired results for your request. This class handles tracking numbers individually, not in batch.
On Multiple Package Shipments (MPS), the tracking number represents either the master tracking number or one of the associated sequential tracking numbers for child packages. This option is available for: Express and Ground (Domestic and International) multiple-package shipments, Express and Ground (Domestic and International) C.O.D. multiple-package shipments.
Tracking by the master tracking number returns tracking data for all child tracking numbers associated with the master.
Tracking by the child tracking number returns tracking data on the specific shipment associated with that tracking number.
Track by other identifier
This identifier can be a:
- Reference Number This option applies to Express, Ground, Freight, and Custom Critical shipments. You can track packages by a reference number entered during the shipping transaction. Track by Reference Number can use any of the following sources: Shipper/Customer Reference, Invoice Number, Purchase Order (PO), Department, Part Number, Returns Material Authorization (RMA), Transportation Control Number (TCN), Bill of Lading (BOL).
- Door Tag Number This option is available for Express and Ground U.S. and Canadian shipments. This option allows you to track by a FedEx Door Tag number. A Door Tag is left at the recipient's shipping address if the recipient is not there to receive the package. A Door Tag number is linked at FedEx with the package's original tracking number. This tracking functionality allows you to track using only the Door Tag number without requiring the associated tracking number. No additional search elements are required to track by Door Tag. You may request tracking scan information for any packages shipped by FedEx by providing a valid Door Tag Number.
To track by identifiers other than tracking number, the TrackShipment method should be called by providing an idValue and the IdentifierType, as well as other required values described in detail in this method description depending on the identifier type.
When the track request has been made for an identifier of type other than Tracking Number, either the ShipperAccountNumber or the RecipientCountryCode and RecipientZipCode (where applicable) are required to be provided in the request.
Upon successful request, the user will receive the current shipment status with a detailed tracking activity.
To confirm a shipment has been received and signed for, you can call the GetProofOfDelivery or SaveProofOfDelivery methods. With this feature, you can request a letter that includes a graphic of the recipient's signature for FedEx Express and FedEx Ground shipments. The SPOD is returned in PDF format and may be printed, browsed, or e-mailed. There is no charge for Signature Proof of Delivery.
You can use Tracking service to check the status of your shipment at any time during delivery and up to 18 months after delivery. You can use SPOD service to obtain an image of the recipient's signature (if the signature is available) once the shipment has been delivered.
SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.
If the ShipperAccountNumber is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.
If the ShipperAccountNumber is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).
In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.
Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).
SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.
To use this class, you must have a FedEx FedExAccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
CarrierCodeDescription | FedEx carrier code description used for shipment. |
EstimatedPickupDate | Estimated package pickup date for shipments that haven't been picked up yet. |
FedExAccountNumber | The account number associated with the shipment. |
FedExAuthorizationToken | Authorization Token used to authenticate the request. |
FedExLanguageCode | Two-letter code for the language (e. |
FedExLocaleCode | Two-letter code for the region (e. |
FedExServer | URL for the FedEx Server where the requests are sent. |
FirewallAutoDetect | This property tells the class 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 transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
IdentifierType | Type of shipment identifier by which the shipment is to be tracked. |
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. |
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. |
PackageCount | The number of packages returned for a given tracking number or any other shipment identifier. |
PackageDeliveryAncAction | Delivery ancillary action recommended for customer to resolve the delivery issue for the package at PackageIndex . |
PackageDeliveryAncActionDesc | Delivery ancillary action description. Field which holds recommended action description to resolve delivery issue for the package at PackageIndex . |
PackageDeliveryAncReasonDesc | Delivery ancillary reason description. Field which holds reason description associated to the status of the package at PackageIndex . |
PackageDeliveryDate | Actual date when the package at PackageIndex was delivered at destination (if applicable). |
PackageDeliveryEstimate | Projected delivery date for the package at PackageIndex based on the ship date, service and destination address. |
PackageDeliveryLocation | Relative location at which package at PackageIndex was left (if package delivered). |
PackageDeliveryStatus | Delivery status description of the package at PackageIndex . |
PackageErrorMessage | The error message corresponding to the PackageIndex . |
PackageIndex | The package index in a shipment being tracked. |
PackagePackagingType | Description of packaging type of the package at PackageIndex . |
PackageReceivedBy | The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex . |
PackageReferences | References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer. |
PackageServiceTypeDescription | String describing the service type used to ship the package at PackageIndex being tracked. |
PackageSignedBy | Signature of person who signed for package at PackageIndex . |
PackageTrackingNumber | Tracking number for the package at PackageIndex . |
PackageWeight | Weight of the package at PackageIndex . |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class 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 Transmission Control Protocol (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 a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username 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. |
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. |
ShipDate | The date on which the package was tendered to FedEx. |
ShipDateEnd | End of ship date range used to narrow search. |
ShipDateStart | Start of ship date range used to narrow search. |
ShipperAccountNumber | Account number associated with shipment. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Timeout | A timeout for the class. |
TotalWeight | Total shipment weight. |
TrackEventCount | The number of records in the TrackEvent arrays. |
TrackEventAddress1 | Line 1 in the location address where a tracking event occurred (by package). |
TrackEventAddress2 | Line 2 in the location address where a tracking event occurred (by package). |
TrackEventCity | Name of the city where the tracking event occurred. |
TrackEventCountryCode | Country code where the tracking event happened. |
TrackEventDate | Date the tracking event happened. |
TrackEventException | The most recent status exception for the tracking event. |
TrackEventState | State or province code where the tracking event occurred. |
TrackEventStatus | Literal description of the tracking event. |
TrackEventTime | Time the tracking event occurred. |
TrackEventZipCode | Postal code where the tracking event happened. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
GetProofOfDelivery | Request Signature Proof of Delivery (SPOD) for a specified trackingNumber . |
RequestEmailNotification | Request email notification for a specified trackingNumber to a specified Recipients list. |
Reset | Resets the internal state of the class and all properties to their default values. |
SaveProofOfDelivery | Request Signature Proof of Delivery (SPOD) for a specified trackingNumber . |
TrackShipment | Returns tracking data for requested idValue of IdentifierType type. |
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.
CustomerTransactionId | Customer transaction id. |
EstimateDelivery | Determines if class will attempt to estimate the Transit Time, Delivery Date, and Delivery Day. |
RawRequest | Contains the complete request sent to the Server. |
RawResponse | Contains the complete response returned by the Server. |
SPODLetterImageType | The format of the SPOD letter. |
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. |
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 certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
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 certificate 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. |
MaskSensitive | 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. |
CarrierCodeDescription Property (DShippingSDK_FedExTrack Class)
FedEx carrier code description used for shipment.
Object Oriented Interface
public function getCarrierCodeDescription();
Procedural Interface
dshippingsdk_fedextrack_get($res, 1 );
Default Value
''
Remarks
Specifies the particular carrier used to ship the packages being tracked.
Upon successful request, this is always returned when the TrackShipment and RequestEmailNotification methods are called.
This property is read-only.
Data Type
String
EstimatedPickupDate Property (DShippingSDK_FedExTrack Class)
Estimated package pickup date for shipments that haven't been picked up yet.
Object Oriented Interface
public function getEstimatedPickupDate();
Procedural Interface
dshippingsdk_fedextrack_get($res, 2 );
Default Value
''
Remarks
This property is returned in the server response only if applicable.
Format: YYYY-MM-DD.
This property is read-only.
Data Type
String
FedExAccountNumber Property (DShippingSDK_FedExTrack Class)
The account number associated with the shipment.
Object Oriented Interface
public function getFedExAccountNumber(); public function setFedExAccountNumber($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 3 ); dshippingsdk_fedextrack_set($res, 3, $value );
Default Value
''
Remarks
The account number associated with the shipment.
The FedExAccountNumber 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.
Data Type
String
FedExAuthorizationToken Property (DShippingSDK_FedExTrack Class)
Authorization Token used to authenticate the request.
Object Oriented Interface
public function getFedExAuthorizationToken(); public function setFedExAuthorizationToken($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 4 ); dshippingsdk_fedextrack_set($res, 4, $value );
Default Value
''
Remarks
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.
Data Type
String
FedExLanguageCode Property (DShippingSDK_FedExTrack Class)
Two-letter code for the language (e.
Object Oriented Interface
public function getFedExLanguageCode(); public function setFedExLanguageCode($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 5 ); dshippingsdk_fedextrack_set($res, 5, $value );
Default Value
'en'
Remarks
Two-letter code for the language (e.g. en, fr, etc.).
This field allows you to assign the language code. Default value is en.
Data Type
String
FedExLocaleCode Property (DShippingSDK_FedExTrack Class)
Two-letter code for the region (e.
Object Oriented Interface
public function getFedExLocaleCode(); public function setFedExLocaleCode($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 6 ); dshippingsdk_fedextrack_set($res, 6, $value );
Default Value
'US'
Remarks
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.
Data Type
String
FedExServer Property (DShippingSDK_FedExTrack Class)
URL for the FedEx Server where the requests are sent.
Object Oriented Interface
public function getFedExServer(); public function setFedExServer($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 7 ); dshippingsdk_fedextrack_set($res, 7, $value );
Default Value
''
Remarks
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").
Data Type
String
FirewallAutoDetect Property (DShippingSDK_FedExTrack Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 8 ); dshippingsdk_fedextrack_set($res, 8, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (DShippingSDK_FedExTrack Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 9 ); dshippingsdk_fedextrack_set($res, 9, $value );
Default Value
0
Remarks
This property determines 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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (DShippingSDK_FedExTrack Class)
This property contains the name or IP address of firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 10 ); dshippingsdk_fedextrack_set($res, 10, $value );
Default Value
''
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (DShippingSDK_FedExTrack Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 11 ); dshippingsdk_fedextrack_set($res, 11, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (DShippingSDK_FedExTrack Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 12 ); dshippingsdk_fedextrack_set($res, 12, $value );
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (DShippingSDK_FedExTrack Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 13 ); dshippingsdk_fedextrack_set($res, 13, $value );
Default Value
''
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
IdentifierType Property (DShippingSDK_FedExTrack Class)
Type of shipment identifier by which the shipment is to be tracked.
Object Oriented Interface
public function getIdentifierType(); public function setIdentifierType($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 14 ); dshippingsdk_fedextrack_set($res, 14, $value );
Default Value
0
Remarks
This is required if the track request will be made for an identifier other than Tracking Number.
Possible values are as follows:
Value | Type Description |
fitTrackingNumberOrDoorTag (0) | Tracking Number Or DoorTag |
fitBillOfLading (1) | Bill of Lading (BOL) |
fitCODReturnTrackingNumber (2) | COD Return Tracking Number |
fitCustomerAuthorizationNumber (3) | Customer Authorization Number |
fitCustomerReference (4) | Customer Reference |
fitDepartment (5) | Department |
fitFreeFormReference (6) | Free Form Reference |
fitGroundShipmentId (7) | Ground Shipment Id |
fitGroundMPS (8) | Ground Multi Piece Shipment (MPS) |
fitInvoiceNumber (9) | Invoice Number |
fitPartnerCarrierNumber (10) | Partner Carrier Number |
fitPartNumber (11) | Part Number |
fitPONumber (12) | Purchase Order Number |
fitRMANumber (13) | Return Materials Authorization (RMA) Number |
fitTrackingControlNumber (14) | Tracking Control Number (TCN) |
fitShipperReference (15) | Shipper Reference |
fitStandardMPS (16) | Standard MPS |
To limit the number of tracking replies for a specific reference, you can enter a date range (ShipDateStart and ShipDateEnd) for this search.
When the track request has been made for an identifier of type other than Tracking Number, either the ShipperAccountNumber or the RecipientCountryCode and RecipientZipCode (where applicable) are required to be provided in the request.
Data Type
Integer
NotifyCount Property (DShippingSDK_FedExTrack Class)
The number of records in the Notify arrays.
Object Oriented Interface
public function getNotifyCount(); public function setNotifyCount($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 15 ); dshippingsdk_fedextrack_set($res, 15, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at NotifyCount - 1.This property is not available at design time.
Data Type
Integer
NotifyAggregate Property (DShippingSDK_FedExTrack Class)
This can be used to set the entire aggregate xml for the recipient to be notified.
Object Oriented Interface
public function getNotifyAggregate($notifyidx); public function setNotifyAggregate($notifyidx, $value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 16 , $notifyidx); dshippingsdk_fedextrack_set($res, 16, $value , $notifyidx);
Default Value
''
Remarks
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).
This setting is optional. If NotifyAggregate 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 property does not apply for USPS and CanadaPost.
The $notifyidx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.
This property is not available at design time.
Data Type
String
NotifyEmail Property (DShippingSDK_FedExTrack Class)
Email address of the recipient to be notified.
Object Oriented Interface
public function getNotifyEmail($notifyidx); public function setNotifyEmail($notifyidx, $value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 17 , $notifyidx); dshippingsdk_fedextrack_set($res, 17, $value , $notifyidx);
Default Value
''
Remarks
Email address of the recipient to be notified. This is required to be provided for each recipient.
The $notifyidx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.
This property is not available at design time.
Data Type
String
NotifyMessage Property (DShippingSDK_FedExTrack Class)
User defined text that will be included in the email to be sent to Email .
Object Oriented Interface
public function getNotifyMessage($notifyidx); public function setNotifyMessage($notifyidx, $value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 18 , $notifyidx); dshippingsdk_fedextrack_set($res, 18, $value , $notifyidx);
Default Value
''
Remarks
User defined text that will be included in the email to be sent to NotifyEmail. 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 property is not used by USPS or Canada Post.
The $notifyidx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.
This property is not available at design time.
Data Type
String
NotifyName Property (DShippingSDK_FedExTrack Class)
The name associated with the notification.
Object Oriented Interface
public function getNotifyName($notifyidx); public function setNotifyName($notifyidx, $value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 19 , $notifyidx); dshippingsdk_fedextrack_set($res, 19, $value , $notifyidx);
Default Value
''
Remarks
The name associated with the notification.
For USPS, this name will appear in the text of the Signature Confirmation e-mail message.
This property is not applicable to FedEx, UPS, or Canada Post.
The $notifyidx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.
This property is not available at design time.
Data Type
String
NotifyFlags Property (DShippingSDK_FedExTrack Class)
Identifies the type of notification requested.
Object Oriented Interface
public function getNotifyFlags($notifyidx); public function setNotifyFlags($notifyidx, $value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 20 , $notifyidx); dshippingsdk_fedextrack_set($res, 20, $value , $notifyidx);
Default Value
0
Remarks
Identifies the type of notification requested. Valid values are:
Value | Meaning |
0x00000001 (On Shipment) | An email notification is requested to be sent to the NotifyEmail when the package is shipped. |
0x00000002 (On Exception) | An email notification should be sent to the NotifyEmail when an exception occurs during package movement from origin to destination. |
0x00000004 (On Delivery) | An email notification is requested to be sent to the NotifyEmail when the package is delivered. |
0x00000008 (On Tender) | An email notification is requested to be sent to the NotifyEmail when the package is tendered. |
0x00000010 (On Return) | An email notification is requested to be sent to the NotifyEmail 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 NotifyEmail 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 NotifyEmail 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
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.
The $notifyidx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.
This property is not available at design time.
Data Type
Integer
NotifyType Property (DShippingSDK_FedExTrack Class)
Identifies the set of valid email notification recipient types.
Object Oriented Interface
public function getNotifyType($notifyidx); public function setNotifyType($notifyidx, $value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 21 , $notifyidx); dshippingsdk_fedextrack_set($res, 21, $value , $notifyidx);
Default Value
0
Remarks
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 NotifyEmail specified for these types will be ignored.
For USPS, only the rtShipper and rtRecipient are valid.
This property does not apply to UPS or Canada Post notifications.
The $notifyidx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.
This property is not available at design time.
Data Type
Integer
PackageCount Property (DShippingSDK_FedExTrack Class)
The number of packages returned for a given tracking number or any other shipment identifier.
Object Oriented Interface
public function getPackageCount();
Procedural Interface
dshippingsdk_fedextrack_get($res, 22 );
Default Value
1
Remarks
This property contains the number of packages returned from the FedEx Server after calling the TrackShipment.
This property is read-only.
Data Type
Integer
PackageDeliveryAncAction Property (DShippingSDK_FedExTrack Class)
Delivery ancillary action recommended for customer to resolve the delivery issue for the package at PackageIndex .
Object Oriented Interface
public function getPackageDeliveryAncAction();
Procedural Interface
dshippingsdk_fedextrack_get($res, 23 );
Default Value
''
Remarks
This property may be returned in server response when the TrackShipment method is called.
This property is read-only.
Data Type
String
PackageDeliveryAncActionDesc Property (DShippingSDK_FedExTrack Class)
Delivery ancillary action description. Field which holds recommended action description to resolve delivery issue for the package at PackageIndex .
Object Oriented Interface
public function getPackageDeliveryAncActionDesc();
Procedural Interface
dshippingsdk_fedextrack_get($res, 24 );
Default Value
''
Remarks
This property may be returned in server response when the TrackShipment method is called.
Example: "Customer not Available or Business Closed"
This property is read-only.
Data Type
String
PackageDeliveryAncReasonDesc Property (DShippingSDK_FedExTrack Class)
Delivery ancillary reason description. Field which holds reason description associated to the status of the package at PackageIndex .
Object Oriented Interface
public function getPackageDeliveryAncReasonDesc();
Procedural Interface
dshippingsdk_fedextrack_get($res, 25 );
Default Value
''
Remarks
This property may be returned in server response when the TrackShipment method is called.
Example: "Customer not Available or Business Closed"
This property is read-only.
Data Type
String
PackageDeliveryDate Property (DShippingSDK_FedExTrack Class)
Actual date when the package at PackageIndex was delivered at destination (if applicable).
Object Oriented Interface
public function getPackageDeliveryDate();
Procedural Interface
dshippingsdk_fedextrack_get($res, 26 );
Default Value
''
Remarks
When the TrackShipment method is called, PackageDeliveryDate is returned in the response only if the package has been delivered.
Format: YYYY-MM-DD.
This property is read-only.
Data Type
String
PackageDeliveryEstimate Property (DShippingSDK_FedExTrack Class)
Projected delivery date for the package at PackageIndex based on the ship date, service and destination address.
Object Oriented Interface
public function getPackageDeliveryEstimate();
Procedural Interface
dshippingsdk_fedextrack_get($res, 27 );
Default Value
''
Remarks
When the TrackShipment method is called, the PackageDeliveryEstimate is populated only if delivery has not already occurred.
Format: YYYY-MM-DD.
This property is read-only.
Data Type
String
PackageDeliveryLocation Property (DShippingSDK_FedExTrack Class)
Relative location at which package at PackageIndex was left (if package delivered).
Object Oriented Interface
public function getPackageDeliveryLocation();
Procedural Interface
dshippingsdk_fedextrack_get($res, 28 );
Default Value
''
Remarks
When the TrackShipment method is called, PackageDeliveryLocation is returned in the response only if this package has been delivered.
This might be such as Front Desk, Back Door, etc. It is applicable for Express services only.
This property is read-only.
Data Type
String
PackageDeliveryStatus Property (DShippingSDK_FedExTrack Class)
Delivery status description of the package at PackageIndex .
Object Oriented Interface
public function getPackageDeliveryStatus();
Procedural Interface
dshippingsdk_fedextrack_get($res, 29 );
Default Value
''
Remarks
This is applicable for Express services only. Maximum length: 25.
This property is read-only.
Data Type
String
PackageErrorMessage Property (DShippingSDK_FedExTrack Class)
The error message corresponding to the PackageIndex .
Object Oriented Interface
public function getPackageErrorMessage();
Procedural Interface
dshippingsdk_fedextrack_get($res, 30 );
Default Value
''
Remarks
This property may be returned in server response when the TrackShipment method is called.
This property is read-only.
Data Type
String
PackageIndex Property (DShippingSDK_FedExTrack Class)
The package index in a shipment being tracked.
Object Oriented Interface
public function getPackageIndex(); public function setPackageIndex($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 31 ); dshippingsdk_fedextrack_set($res, 31, $value );
Default Value
0
Remarks
This property contains the index of a package contained in the shipment.
The PackageCount will contain the number of packages included in a shipment and the PackageIndex will contain the package index in the list of packages.
To retrieve all attributes corresponding to a package, the PackageIndex should be set from 0 to PackageCount - 1.
Data Type
Integer
PackagePackagingType Property (DShippingSDK_FedExTrack Class)
Description of packaging type of the package at PackageIndex .
Object Oriented Interface
public function getPackagePackagingType();
Procedural Interface
dshippingsdk_fedextrack_get($res, 32 );
Default Value
''
Remarks
This is returned for Express services only. Possible values are: 'FedEx Envelope', 'FedEx Box', etc.
This property is read-only.
Data Type
String
PackageReceivedBy Property (DShippingSDK_FedExTrack Class)
The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex .
Object Oriented Interface
public function getPackageReceivedBy();
Procedural Interface
dshippingsdk_fedextrack_get($res, 33 );
Default Value
''
Remarks
This corresponds to the package at PackageIndex and is returned only if this package has already been delivered. To retrieve this property, the PackageIndex should be set from 0 to PackageCount - 1.
This property is read-only.
Data Type
String
PackageReferences Property (DShippingSDK_FedExTrack Class)
References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.
Object Oriented Interface
public function getPackageReferences();
Procedural Interface
dshippingsdk_fedextrack_get($res, 34 );
Default Value
''
Remarks
This should be inspected after a call to the TrackShipment method. When populated, it is a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).
Reference Type can be any of the following values:
Reference Type | |
BILL_OF_LADING (or BOL) | |
COD_RETURN_TRACKING_NUMBER | |
CUSTOMER_AUTHORIZATION_NUMBER (or CUSTAUTHNUM) | |
CUSTOMER_REFERENCE (or CUR) | |
DEPARTMENT | |
FREE_FORM_REFERENCE | |
GROUND_SHIPMENT_ID | |
GROUND_MPS | |
INVOICE (or INV) | |
PARTNER_CARRIER_NUMBER (or PARTNERCARNBR) | |
PART_NUMBER | |
PURCHASE_ORDER | |
RETURN_MATERIALS_AUTHORIZATION (or RMA) | |
TRACKING_CONTROL_NUMBER (TCN) | |
SHIPPER_REFERENCE (or SHR) | |
STANDARD_MPS |
This property is read-only.
Data Type
String
PackageServiceTypeDescription Property (DShippingSDK_FedExTrack Class)
String describing the service type used to ship the package at PackageIndex being tracked.
Object Oriented Interface
public function getPackageServiceTypeDescription();
Procedural Interface
dshippingsdk_fedextrack_get($res, 35 );
Default Value
''
Remarks
This might be one of FedEx available services, such as 'Priority Pack', 'Standard Overnight', etc.
This property is read-only.
Data Type
String
PackageSignedBy Property (DShippingSDK_FedExTrack Class)
Signature of person who signed for package at PackageIndex .
Object Oriented Interface
public function getPackageSignedBy();
Procedural Interface
dshippingsdk_fedextrack_get($res, 36 );
Default Value
''
Remarks
This corresponds to the package at PackageIndex and is returned only if this package has already been delivered. If the signature confirmation is not selected when the shipping label was generated, the PackageSignedBy might also be a relative location at which package was left, such as Front Desk or Back Door.
This property is read-only.
Data Type
String
PackageTrackingNumber Property (DShippingSDK_FedExTrack Class)
Tracking number for the package at PackageIndex .
Object Oriented Interface
public function getPackageTrackingNumber();
Procedural Interface
dshippingsdk_fedextrack_get($res, 37 );
Default Value
''
Remarks
This indicates tracking number assigned by FedEx when the shipping label was generated. Maximum length: 20.
Note: Door Tag will never be returned in the response.
This property is read-only.
Data Type
String
PackageWeight Property (DShippingSDK_FedExTrack Class)
Weight of the package at PackageIndex .
Object Oriented Interface
public function getPackageWeight();
Procedural Interface
dshippingsdk_fedextrack_get($res, 38 );
Default Value
''
Remarks
This corresponds to the package at PackageIndex position in the list of packages contained in the shipment.
This property is read-only.
Data Type
String
ProxyAuthScheme Property (DShippingSDK_FedExTrack Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Object Oriented Interface
public function getProxyAuthScheme(); public function setProxyAuthScheme($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 39 ); dshippingsdk_fedextrack_set($res, 39, $value );
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (DShippingSDK_FedExTrack Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Object Oriented Interface
public function getProxyAutoDetect(); public function setProxyAutoDetect($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 40 ); dshippingsdk_fedextrack_set($res, 40, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (DShippingSDK_FedExTrack Class)
This property contains a password if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyPassword(); public function setProxyPassword($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 41 ); dshippingsdk_fedextrack_set($res, 41, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (DShippingSDK_FedExTrack Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Object Oriented Interface
public function getProxyPort(); public function setProxyPort($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 42 ); dshippingsdk_fedextrack_set($res, 42, $value );
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (DShippingSDK_FedExTrack Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Object Oriented Interface
public function getProxyServer(); public function setProxyServer($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 43 ); dshippingsdk_fedextrack_set($res, 43, $value );
Default Value
''
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (DShippingSDK_FedExTrack Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Object Oriented Interface
public function getProxySSL(); public function setProxySSL($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 44 ); dshippingsdk_fedextrack_set($res, 44, $value );
Default Value
0
Remarks
This property determines 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. |
Data Type
Integer
ProxyUser Property (DShippingSDK_FedExTrack Class)
This property contains a username if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyUser(); public function setProxyUser($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 45 ); dshippingsdk_fedextrack_set($res, 45, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
RecipientAddress1 Property (DShippingSDK_FedExTrack Class)
Street name.
Object Oriented Interface
public function getRecipientAddress1(); public function setRecipientAddress1($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 46 ); dshippingsdk_fedextrack_set($res, 46, $value );
Default Value
''
Remarks
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 RecipientAddress1 should not exceed 35 characters.
Data Type
String
RecipientAddress2 Property (DShippingSDK_FedExTrack Class)
A specific detail on the address (such as building, suite, apartment, floor number etc.
Object Oriented Interface
public function getRecipientAddress2(); public function setRecipientAddress2($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 47 ); dshippingsdk_fedextrack_set($res, 47, $value );
Default Value
''
Remarks
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.
Data Type
String
RecipientAddressFlags Property (DShippingSDK_FedExTrack Class)
Various flags that denote information about the address.
Object Oriented Interface
public function getRecipientAddressFlags(); public function setRecipientAddressFlags($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 48 ); dshippingsdk_fedextrack_set($res, 48, $value );
Default Value
0
Remarks
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. |
Data Type
Integer
RecipientCity Property (DShippingSDK_FedExTrack Class)
Name of city, town, etc.
Object Oriented Interface
public function getRecipientCity(); public function setRecipientCity($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 49 ); dshippingsdk_fedextrack_set($res, 49, $value );
Default Value
''
Remarks
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.
Data Type
String
RecipientCountryCode Property (DShippingSDK_FedExTrack Class)
Country code.
Object Oriented Interface
public function getRecipientCountryCode(); public function setRecipientCountryCode($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 50 ); dshippingsdk_fedextrack_set($res, 50, $value );
Default Value
'US'
Remarks
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 |
Data Type
String
RecipientState Property (DShippingSDK_FedExTrack Class)
State or province code.
Object Oriented Interface
public function getRecipientState(); public function setRecipientState($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 51 ); dshippingsdk_fedextrack_set($res, 51, $value );
Default Value
''
Remarks
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.
Data Type
String
RecipientZipCode Property (DShippingSDK_FedExTrack Class)
Postal code.
Object Oriented Interface
public function getRecipientZipCode(); public function setRecipientZipCode($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 52 ); dshippingsdk_fedextrack_set($res, 52, $value );
Default Value
''
Remarks
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 RecipientCity and RecipientState are not present.
Valid characters: A-Z; 0-9; a-z. Maximum length: 16.
Data Type
String
SenderAddress1 Property (DShippingSDK_FedExTrack Class)
Street name.
Object Oriented Interface
public function getSenderAddress1();
Procedural Interface
dshippingsdk_fedextrack_get($res, 53 );
Default Value
''
Remarks
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 SenderAddress1 should not exceed 35 characters.
This property is read-only.
Data Type
String
SenderAddress2 Property (DShippingSDK_FedExTrack Class)
A specific detail on the address (such as building, suite, apartment, floor number etc.
Object Oriented Interface
public function getSenderAddress2();
Procedural Interface
dshippingsdk_fedextrack_get($res, 54 );
Default Value
''
Remarks
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS SenderAddress2 should not exceed 35 characters.
This property is read-only.
Data Type
String
SenderAddressFlags Property (DShippingSDK_FedExTrack Class)
Various flags that denote information about the address.
Object Oriented Interface
public function getSenderAddressFlags();
Procedural Interface
dshippingsdk_fedextrack_get($res, 55 );
Default Value
0
Remarks
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. |
This property is read-only.
Data Type
Integer
SenderCity Property (DShippingSDK_FedExTrack Class)
Name of city, town, etc.
Object Oriented Interface
public function getSenderCity();
Procedural Interface
dshippingsdk_fedextrack_get($res, 56 );
Default Value
''
Remarks
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.
This property is read-only.
Data Type
String
SenderCountryCode Property (DShippingSDK_FedExTrack Class)
Country code.
Object Oriented Interface
public function getSenderCountryCode();
Procedural Interface
dshippingsdk_fedextrack_get($res, 57 );
Default Value
'US'
Remarks
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 |
This property is read-only.
Data Type
String
SenderState Property (DShippingSDK_FedExTrack Class)
State or province code.
Object Oriented Interface
public function getSenderState();
Procedural Interface
dshippingsdk_fedextrack_get($res, 58 );
Default Value
''
Remarks
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.
This property is read-only.
Data Type
String
SenderZipCode Property (DShippingSDK_FedExTrack Class)
Postal code.
Object Oriented Interface
public function getSenderZipCode();
Procedural Interface
dshippingsdk_fedextrack_get($res, 59 );
Default Value
''
Remarks
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 SenderCity and SenderState are not present.
Valid characters: A-Z; 0-9; a-z. Maximum length: 16.
This property is read-only.
Data Type
String
SenderCompany Property (DShippingSDK_FedExTrack Class)
Identifies the contact person's company name.
Object Oriented Interface
public function getSenderCompany(); public function setSenderCompany($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 60 ); dshippingsdk_fedextrack_set($res, 60, $value );
Default Value
''
Remarks
Identifies the contact person's company name. In a ship request, either SenderFirstName and SenderLastName or SenderCompany are required to be provided.
Data Type
String
SenderEmail Property (DShippingSDK_FedExTrack Class)
Identifies the contact person's email address.
Object Oriented Interface
public function getSenderEmail(); public function setSenderEmail($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 61 ); dshippingsdk_fedextrack_set($res, 61, $value );
Default Value
''
Remarks
Identifies the contact person's email address. Maximum length: 120.
Data Type
String
SenderFax Property (DShippingSDK_FedExTrack Class)
Recipient's fax number.
Object Oriented Interface
public function getSenderFax(); public function setSenderFax($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 62 ); dshippingsdk_fedextrack_set($res, 62, $value );
Default Value
''
Remarks
Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.
Data Type
String
SenderFirstName Property (DShippingSDK_FedExTrack Class)
Sender's first name.
Object Oriented Interface
public function getSenderFirstName(); public function setSenderFirstName($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 63 ); dshippingsdk_fedextrack_set($res, 63, $value );
Default Value
''
Remarks
Sender's first name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent.
Data Type
String
SenderLastName Property (DShippingSDK_FedExTrack Class)
Person's last name.
Object Oriented Interface
public function getSenderLastName(); public function setSenderLastName($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 64 ); dshippingsdk_fedextrack_set($res, 64, $value );
Default Value
''
Remarks
Person's last name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent. Maximum length: 45 characters for both names or company name.
Data Type
String
SenderMiddleInitial Property (DShippingSDK_FedExTrack Class)
Middle initial.
Object Oriented Interface
public function getSenderMiddleInitial(); public function setSenderMiddleInitial($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 65 ); dshippingsdk_fedextrack_set($res, 65, $value );
Default Value
''
Remarks
Middle initial. The value of this property is optional.
Data Type
String
SenderPhone Property (DShippingSDK_FedExTrack Class)
Identifies the contact person's phone number.
Object Oriented Interface
public function getSenderPhone(); public function setSenderPhone($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 66 ); dshippingsdk_fedextrack_set($res, 66, $value );
Default Value
''
Remarks
Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.
Data Type
String
ShipDate Property (DShippingSDK_FedExTrack Class)
The date on which the package was tendered to FedEx.
Object Oriented Interface
public function getShipDate(); public function setShipDate($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 67 ); dshippingsdk_fedextrack_set($res, 67, $value );
Default Value
''
Remarks
Upon successful request, this is always returned when the TrackShipment and RequestEmailNotification methods are called.
Format: YYYY-MM-DD.
Data Type
String
ShipDateEnd Property (DShippingSDK_FedExTrack Class)
End of ship date range used to narrow search.
Object Oriented Interface
public function getShipDateEnd(); public function setShipDateEnd($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 68 ); dshippingsdk_fedextrack_set($res, 68, $value );
Default Value
''
Remarks
This property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateStart is required.
This is required though to be provided in an email notification request (when the RequestEmailNotification method is called).
Format: YYYY-MM-DD.
Data Type
String
ShipDateStart Property (DShippingSDK_FedExTrack Class)
Start of ship date range used to narrow search.
Object Oriented Interface
public function getShipDateStart(); public function setShipDateStart($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 69 ); dshippingsdk_fedextrack_set($res, 69, $value );
Default Value
''
Remarks
This property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateEnd is required.
This is required though to be provided in a email notification request (when the RequestEmailNotification method is called).
Format: YYYY-MM-DD.
Data Type
String
ShipperAccountNumber Property (DShippingSDK_FedExTrack Class)
Account number associated with shipment.
Object Oriented Interface
public function getShipperAccountNumber(); public function setShipperAccountNumber($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 70 ); dshippingsdk_fedextrack_set($res, 70, $value );
Default Value
''
Remarks
This indicates the account number associated with shipment (as opposed to the FedExAccountNumber, which is that of the party sending the request).
This property is optional and applicable in 2 types of track services:
- Tracking request made for an identifier of IdentifierType other than Tracking Number; or
- Signature Proof of Delivery (SPOD) request;
In tracking request: When providing the ShipperAccountNumber, the server will return all packages matching the search criteria and associated with this account. If account is not specified, then the RecipientCountryCode and RecipientZipCode (applicable countries) are required. The Reply data may be restricted if ShipperAccountNumber is not provided.
In the SPOD request transaction: To view detailed SPOD information, include the 9-digit ShipperAccountNumber when the GetProofOfDelivery or SaveProofOfDelivery methods are called. If this is not provided, or if it does not match the shipper's or payor's FedEx account number, then summary SPOD information will be provided. Otherwise, the detailed SPOD (sender's and recipient's address details) will be included in the SPOD.
Data Type
String
SSLAcceptServerCertEncoded Property (DShippingSDK_FedExTrack Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 72 ); dshippingsdk_fedextrack_set($res, 72, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (DShippingSDK_FedExTrack Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 100 ); dshippingsdk_fedextrack_set($res, 100, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (DShippingSDK_FedExTrack Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 116 ); dshippingsdk_fedextrack_set($res, 116, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (DShippingSDK_FedExTrack Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 117 ); dshippingsdk_fedextrack_set($res, 117, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (DShippingSDK_FedExTrack Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 118 ); dshippingsdk_fedextrack_set($res, 118, $value );
Default Value
0
Remarks
This is 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 property 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 SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLCertSubject Property (DShippingSDK_FedExTrack Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 119 ); dshippingsdk_fedextrack_set($res, 119, $value );
Default Value
''
Remarks
This is 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 property 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.
Data Type
String
SSLProvider Property (DShippingSDK_FedExTrack Class)
This specifies the SSL/TLS implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 127 ); dshippingsdk_fedextrack_set($res, 127, $value );
Default Value
0
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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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
SSLServerCertEncoded Property (DShippingSDK_FedExTrack Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
dshippingsdk_fedextrack_get($res, 129 );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (DShippingSDK_FedExTrack Class)
A timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
dshippingsdk_fedextrack_get($res, 156 ); dshippingsdk_fedextrack_set($res, 156, $value );
Default Value
60
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.
Please note that by default, all timeouts are inactivity timeouts, i.e. 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
TotalWeight Property (DShippingSDK_FedExTrack Class)
Total shipment weight.
Object Oriented Interface
public function getTotalWeight();
Procedural Interface
dshippingsdk_fedextrack_get($res, 157 );
Default Value
''
Remarks
This property is returned when the TrackShipment method is called.
This property is read-only.
Data Type
String
TrackEventCount Property (DShippingSDK_FedExTrack Class)
The number of records in the TrackEvent arrays.
Object Oriented Interface
public function getTrackEventCount();
Procedural Interface
dshippingsdk_fedextrack_get($res, 158 );
Default Value
0
Remarks
This property controls the size of the following arrays:
- TrackEventAddress1
- TrackEventAddress2
- TrackEventCity
- TrackEventCountryCode
- TrackEventDate
- TrackEventException
- TrackEventState
- TrackEventStatus
- TrackEventTime
- TrackEventZipCode
This property is read-only and not available at design time.
Data Type
Integer
TrackEventAddress1 Property (DShippingSDK_FedExTrack Class)
Line 1 in the location address where a tracking event occurred (by package).
Object Oriented Interface
public function getTrackEventAddress1($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 159 , $trackeventidx);
Default Value
''
Remarks
Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.
This is not available for USPS tracking requests.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventAddress2 Property (DShippingSDK_FedExTrack Class)
Line 2 in the location address where a tracking event occurred (by package).
Object Oriented Interface
public function getTrackEventAddress2($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 160 , $trackeventidx);
Default Value
''
Remarks
Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.
This is not available for USPS tracking requests.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventCity Property (DShippingSDK_FedExTrack Class)
Name of the city where the tracking event occurred.
Object Oriented Interface
public function getTrackEventCity($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 161 , $trackeventidx);
Default Value
''
Remarks
Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventCountryCode Property (DShippingSDK_FedExTrack Class)
Country code where the tracking event happened.
Object Oriented Interface
public function getTrackEventCountryCode($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 163 , $trackeventidx);
Default Value
''
Remarks
Country code where the tracking event happened.
For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventDate Property (DShippingSDK_FedExTrack Class)
Date the tracking event happened.
Object Oriented Interface
public function getTrackEventDate($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 164 , $trackeventidx);
Default Value
''
Remarks
Date the tracking event happened.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventException Property (DShippingSDK_FedExTrack Class)
The most recent status exception for the tracking event.
Object Oriented Interface
public function getTrackEventException($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 165 , $trackeventidx);
Default Value
''
Remarks
The most recent status exception for the tracking event. This is only available for FedEx, and is applicable for Express services only.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventState Property (DShippingSDK_FedExTrack Class)
State or province code where the tracking event occurred.
Object Oriented Interface
public function getTrackEventState($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 168 , $trackeventidx);
Default Value
''
Remarks
State or province code where the tracking event occurred. This is a two-letter standard abbreviation.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventStatus Property (DShippingSDK_FedExTrack Class)
Literal description of the tracking event.
Object Oriented Interface
public function getTrackEventStatus($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 169 , $trackeventidx);
Default Value
''
Remarks
Literal description of the tracking event.
For UPS, possible values are:
In Transit | |
Delivered | |
Exception | |
Pickup | |
Manifest Pickup |
For USPS, if RequestType is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, TrackEventStatus will contain the entire summary and none of the other properties will be populated. For example, this property might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."
If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the TrackEventStatus property that pertains to the specific TrackingNumber.
When RequestType is set to rtDetail however, this property will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.
When using Endicia as your postage provider, Status will be the only field populated and may contain the status, the timestamp, and the location of the tracking event.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventTime Property (DShippingSDK_FedExTrack Class)
Time the tracking event occurred.
Object Oriented Interface
public function getTrackEventTime($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 170 , $trackeventidx);
Default Value
''
Remarks
Time the tracking event occurred.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
TrackEventZipCode Property (DShippingSDK_FedExTrack Class)
Postal code where the tracking event happened.
Object Oriented Interface
public function getTrackEventZipCode($trackeventidx);
Procedural Interface
dshippingsdk_fedextrack_get($res, 171 , $trackeventidx);
Default Value
''
Remarks
Postal code where the tracking event happened. Returned if the country, where the scanning activity happened, supports postal-code system.
The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.
This property is read-only and not available at design time.
Data Type
String
Config Method (DShippingSDK_FedExTrack Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
dshippingsdk_fedextrack_do_config($res, $configurationstring);
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.
GetProofOfDelivery Method (DShippingSDK_FedExTrack Class)
Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .
Object Oriented Interface
public function doGetProofOfDelivery($trackingnumber);
Procedural Interface
dshippingsdk_fedextrack_do_getproofofdelivery($res, $trackingnumber);
Remarks
The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.
The following properties can be set when this method is called:
- FedExAuthorizationToken (required)
- FedExServer (optional)
- FedExAccountNumber (required)
- ShipDate (required)
- ShipperAccountNumber (optional)
This method will return the image of the SPOD. This is the decoded binary image file of the Signature Proof of Delivery (SPOD), stored in memory.
SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.
If the ShipperAccountNumber is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.
If the ShipperAccountNumber is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).
In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.
Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).
SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.
RequestEmailNotification Method (DShippingSDK_FedExTrack Class)
Request email notification for a specified trackingNumber to a specified Recipients list.
Object Oriented Interface
public function doRequestEmailNotification($trackingnumber);
Procedural Interface
dshippingsdk_fedextrack_do_requestemailnotification($res, $trackingnumber);
Remarks
The trackingNumber parameter identifies the shipment the notification will be requested for. Via this method, you send notification of package state to up to four e-mail addresses.
The following properties can be set when this method is called:
- FedExAuthorizationToken (required)
- FedExServer (optional)
- FedExAccountNumber (required)
- ShipDateStart (required)
- ShipDateEnd (required)
- SenderContact (by specifying SenderFirstName, SenderLastName, and SenderEmail - required)
- Notify (required)
- Message (optional)
Notification allows you to request that e-mail exception and delivery notifications be sent to you, your recipient, and up to 2 other e-mail addresses (by specifying the Notify). A personal message can also be included via the Message property.
FedEx services offering this feature are FedEx Express (FDXE), FedEx Ground (FDXG), FedEx Cargo (FDXC), FedEx Custom Critical (FXCC), and FedEx Freight (FXFR). FedEx SmartPost shipments are not included in this feature.
There are three notification options:
- Shipment notification. In this case, the ntOnShipment flag should be set in the NotifyFlags property for that recipient;
- Exception notification (such as if an exception occurs during scanning and the package may be delayed, for example, or if an address correction is required. In this case, the ntOnException flag should be set in the NotifyFlags property for that recipient; or
- Delivery notification. In this case, the ntOnDelivery flag should be set in the NotifyFlags property for that recipient;
You must choose between these delivery types: wireless (to a cell phone), text only e-mail, and HTML e-mail by setting the NotifyFlags to any of the desired options.
A personal message, which can be included in the request via the Message, up to 120 characters) is allowed for e-mail notifications only. This is not applicable for wireless notifications.
If there is a problem with the trackingNumber, or recipients' information, the response will raise an error that pertains to that element. For more details on errors codes and descriptions, please refer to the Error Codes section.
Reset Method (DShippingSDK_FedExTrack Class)
Resets the internal state of the class and all properties to their default values.
Object Oriented Interface
public function doReset();
Procedural Interface
dshippingsdk_fedextrack_do_reset($res);
Remarks
The Reset method does not have any parameters and does not return any value.
SaveProofOfDelivery Method (DShippingSDK_FedExTrack Class)
Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .
Object Oriented Interface
public function doSaveProofOfDelivery($trackingnumber, $filename);
Procedural Interface
dshippingsdk_fedextrack_do_saveproofofdelivery($res, $trackingnumber, $filename);
Remarks
The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.
The following properties can be set when this method is called:
- FedExAuthorizationToken (required)
- FedExServer (optional)
- FedExAccountNumber (required)
- ShipDate (required)
- ShipperAccountNumber (optional)
The filename parameter describes the location on disk to write the returned image of the SPOD to. This filename should have the .pdf extension.
If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting. The default value of this config is True.
SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.
If the ShipperAccountNumber is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.
If the ShipperAccountNumber is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).
In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.
Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).
SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.
TrackShipment Method (DShippingSDK_FedExTrack Class)
Returns tracking data for requested idValue of IdentifierType type.
Object Oriented Interface
public function doTrackShipment($idvalue);
Procedural Interface
dshippingsdk_fedextrack_do_trackshipment($res, $idvalue);
Remarks
The idValue parameter identifies the shipment. This identifier can be of IdentifierType type. Some identifiers apply to a single package (such as Package Tracking Number), while others apply to multiple packages or shipments of which they are part of. The idValue must be alphanumeric.
FedEx uses shipment identification numbers and types to identify and trace every shipment as it goes through the FedEx system to its destination. You can use this shipment identification number and type to track, locate, and verify arrival of a shipment.
When sending a tracking request to the FedEx Server, there is information that the server requires before it will process the request. The following properties can be sent in the request in order to track by tracking number or by any other identifier:
- FedExAuthorizationToken (required)
- FedExServer (optional)
- FedExAccountNumber (required)
- ShipDateStart (optional)
- ShipDateEnd (optional)
- ShipperAccountNumber (optional)
- RecipientCountryCode (optional)
- RecipientZipCode (optional)
A successful query returns all of the packages within a shipment. For example, if a shipment contained four packages, the query response would show all four packages.
If FedEx system doesn't locate any data for the requested identifier, the transaction will be considered successful and the Warning will contain the 'No data...' message. The full server reply will be saved to RawResponse.
The following properties may be populated upon method return:
- CarrierCodeDescription
- ShipDate
- PackageTrackingNumber
- PackageServiceTypeDescription
- PackagePackagingType
- PackageDeliveryStatus
- PackageDeliveryEstimate
- PackageDeliveryDate
- PackageDeliveryLocation
- PackageErrorMessage
- PackageSignedBy
- SenderAddress
- RecipientAddress
- TotalWeight and WeightUnit;
- Tracking details for each tracking event, which can be inspected via TrackEvents collection. This information consists of: TrackEventAddress1, TrackEventAddress2, TrackEventCity, TrackEventState, TrackEventCountryCode, TrackEventZipCode, TrackEventDate, TrackEventTime, TrackEventStatus and TrackEventException.
If there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific idValue of a IdentifierType type.
For more details on errors codes and descriptions, please refer to the Error Codes section.
Error Event (DShippingSDK_FedExTrack Class)
Information about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
dshippingsdk_fedextrack_register_callback($res, 1, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
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 (DShippingSDK_FedExTrack Class)
Notification returned by the server upon successful request (if applicable).
Object Oriented Interface
public function fireNotification($param);
Procedural Interface
dshippingsdk_fedextrack_register_callback($res, 2, array($this, 'fireNotification'));
Parameter List
'message'
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 (DShippingSDK_FedExTrack Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
dshippingsdk_fedextrack_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
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 (DShippingSDK_FedExTrack Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
dshippingsdk_fedextrack_register_callback($res, 4, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Config Settings (FedExTrack 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.FedExTrack Config Settings
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.
Format | Value |
0 (default) | |
PNG | 1 |
component.Config("TESTMODE=true");
Default value is False, transactions are directed to the default production end-point.
HTTP Config Settings
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.
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.
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]".
The default value is False.
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
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
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.
.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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
Note: This setting is applicable only to Mac/iOS editions.
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.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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.
In multi-homed 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 multi-homed hosts (machines with more than one IP interface).
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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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 setting has no effect if SSLProvider is set to Platform.
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 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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".
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.
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.
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:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this 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 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 config setting.
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:
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:
- 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
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_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- 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.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - 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 which 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 only supported 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 only available 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 the above 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.
This setting is only applicable when SSLProvider is set to Internal.
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.
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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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 not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this 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 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.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
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)
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 setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified 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"
- "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 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
Note: This option is not valid for UDP ports.
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.
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
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 |
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 |
- 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.
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.
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 (FedExTrack Class)
FedExTrack 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.