Search: 
Available in: FEDEX | S3 | USPS
InternationalLabels Component [IBiz USPS Integrator V2]

Properties   Methods   Events   Configuration Settings  

Provides shipping labels and Customs Forms needed for international Priority Mail, Express Mail, and First Class Mail shipments.

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

Remarks

This component generates the customs forms complete with addresses, tracking number, and customs declarations for International Priority Mail, International Express Mail, and International First Class Mail. For all other international mail types or when shipping to an APO/FPO address, you must use the CUSTOMSLABELS component instead.

This component replaces the GlobalExpressMail component that was present in the previous version, as that API is no longer supported by the United States Postal Service.

there are two different customs forms that are returned in the ShippingLabels property:

  • PS Form 2976, Customs - CN22 and Sender's Declaration.
  • PS Form 2976-A, Customs Declaration and Dispatch Note CP 72.
However, you do not need to know which form is required. Simply fill out the To and From address properties, the package weight and size, and list the contents inside the package and call one of these three methods: GetPriorityLabel, GetExpressLabel, or GetFirstClassLabel, depending on the service you wish to use. The USPS server will determine the proper forms for the package weight and destination country and return them in the ShippingLabels array property. ShippingLabelCount will indicate the number ShippingLabels returned.

Note: International mail is subject to customs examination in the destination country. Contents and value of an item must be declared on the applicable customs forms in the Item properties (ItemDescription, ItemValue, etc).

Both customs forms require signatures by the sender before submission to the post office.

Property List

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

CertificateNumber Certificate number (if known or included in the package).
Comments Comments on the package being shipped.
Contents Description of items being shipped.
CustomerRefNo User-assigned number for internal use.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
FromAddress1 An apartment or suite number that the package is being shipped from.
FromAddress2 Sender's street address.
FromCity Sender's city.
FromCustomsReference Corresponds to the Sender's Customs Reference field that appears on the shipping label.
FromFirm Sender's company name.
FromFirstName Sender's first name.
FromLastName Sender's last name.
FromMiddleInitial Sender's middle initial
FromPhone Sender's phone number.
FromState Sender's state.
FromZip4 Sender's extended Zip Code (ZIP+4).
FromZipCode Sender's Zip Code.
ImageLayout Determines how the labels will be formatted for printing.
ImageType Type of label image.
IndemnityCoverage Indicates the indemnity coverage for the package.
Insured Indicates whether an International Priority package is insured or not.
InsuredAmount Insurance amount, if known.
InsuredNumber Insurance number, if known.
InvoiceNumber Invoice number for the package.
ItemCount Number of items being shipped inside this package.
ItemDescription Description of an individual item being shipped.
ItemNetOunces Estimated number of ounces of an individual item being shipped.
ItemNetPounds Estimated number of pounds of an individual being shipped.
ItemOrigin Country of origin for an individual item being shipped.
ItemQuantity Quantity of an individual item being shipped.
ItemTariffNumber HS Tariff Number under which an individual item contained in the package being shipped is classified.
ItemValue The value of an individual item being shipped.
LabelDate Date package will be mailed.
LicenseNumber Import License number if known, or included in package.
MailingLocation Postal Office Zip Code where the item will be mailed (if different from FromZipCode).
NonDeliveryOption Requests alternate delivery.
Notes Additional information returned by the USPS Server.
Observations Additional mailing information based on country of destination.
PackageOunces Estimated weight of the package to be mailed - ounce portion.
PackagePounds Estimated weight of the package to be mailed - pounds portion.
Password Password to use for logging in to the USPS Server.
Postage Amount of postage required to mail a package.
Prohibitions List of items prohibited from mailing to the destination country.
Regulations Additional regulations for shipping to the destination country.
Restrictions Restrictions on items being shipped based on country of destination
SDRValue Special Drawing Right calculated on TotalValue.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
Server URL for the USPS server where the requests are sent.
ShippingContainer The type of container the item is packaged in.
ShippingLabelCount Number of shipping labels returned
ShippingLabelFile Filename and location to save the ShippingLabels to.
ShippingLabels Array of shipping label images returned return from the USPS Server.
Timeout A timeout for the component.
ToAddress1 An apartment or suite number that the package is being shipped to.
ToAddress2 Recipient's street address.
ToAddress3 Recipient's address line 3.
ToCity Recipient's city.
ToCountry Recipient's country.
ToCustomsReference Corresponds to the Importer's Customs Reference field that appears on the shipping label.
ToEmail Recipient's email address.
ToFax Recipient's fax number.
ToFirm Recipient's company name.
ToName Recipient's full name.
ToPOBoxFlag Indicates whether or not the ToAddress1 is a Post Office Box.
ToPhone Recipient's phone number.
ToPostalCode Recipient's Postal Code.
ToProvince Destination's province or other principal subdivision.
TotalValue Total value of all items being shipped.
TrackingNumber Tracking Number of the package shipped provided by the USPS Server.
UserId User ID for logging in to the USPS Server.

Method List

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

Config Sets or retrieves a component configuration setting.
GetExpressLabel Retrieves a USPS International Express Mail ShippingLabel and associated customs forms.
GetFirstClassLabel Retrieves a USPS International First Class Mail ShippingLabel and associated customs forms.
GetPriorityLabel Retrieves a USPS International Priority Mail ShippingLabel and associated customs forms.
Reset Reset the internal state of the component and all properties to their default values.

Event List

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

Error Information about errors during data delivery.
SSLServerAuthentication Fired after the server presents its certificate to the client.
SSLStatus Shows the progress of the secure connection.

Configuration Settings

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

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
AltReturnAddress1 Alternate return address 1.
AltReturnAddress2 Alternate return address 2.
AltReturnAddress3 Alternate return address 3.
AltReturnAddress4 Alternate return address 4.
AltReturnAddress5 Alternate return address 5.
AltReturnAddress6 Alternate return address 6.
AltReturnCountry Alternate return country.
Certify Certify/Test mode for label components.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
FromUrbanization The Urbanization that the package is being shipped from.
FullResponse Contains the full response returned by the USPS server.
HTTPVersion The version of HTTP used by the component
HoldForManifest Holds manifest record for inclusion in SCAN request.
IfModifiedSince A date determining the maximum age of the desired document.
ImageParameters For future use.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
OpenSSLCADir The path to a directory containing CA certificates.
OpenSSLCAFile Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData The data to seed the pseudo random number generator(PRNG).
OtherContents Description of the contents.
OutBufferSize The size in bytes of the outgoing queue of the socket.
Overwrite Determines whether label files will be overwritten.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if Basic authentication is to be used for the proxy.
SSLCipherStrength The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols Used to enable/disable the supported security protocols.
SSLProvider The name of the security provider to use.
SSLSecurityFlags Flags that control certificate verification
SocketHandle The handle of the main socket used by the component.
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)
XPath Used to retrieve data at any place within the response.

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.