Search: 
Available in: USPS
CustomsLabels Component [IBiz USPS Integrator V2]

Properties   Methods   Events   Configuration Settings  

Provides Customs Forms needed for international 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

The CustomsLabels component generates the customs forms complete with addresses, barcodes, and customs declarations. This component is used when a prepaid shipping label has been acquired from another source, or when shipping to APO/FPO addresses. To send International Priority, Express, or First Class mail, use the INTERNATIONALLABELS component instead.

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:

1. PS Form 2976, Customs - CN 22 and Sender's Declaration. To generate this form, you can call GetFormCN22 method,

2. PS Form 2976-A, Customs Declaration and Dispatch Note CP 72. To generate this form, you can call GetFormCP72 method.

You must know which form is applicable for each shipment. An individual country will require a PS Form 2976 (CN 22) or PS Form 2976-A (CP 72) Customs Form, depending on the contents of the package. The correct form for each country and content combination can be found in the USPS International Mail Manual (IMM). To access the IMM, go to the Postal Explorer Web Site (http://pe.usps.gov/).

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.

BarcodeNumber Barcode number required by Customs Service.
CN22Form Image of the Customs Form CN 22.
CP72Forms Array containing all 6 all pages of Customs form CP 72.
CP72PageCount Number of pages returned in CP72Forms
CertificateNumber Certificate number (if known or included in the package).
Comments Comments on the package being shipped.
Contents Description of items being shipped.
CountryOfOrigin Country where the goods originated.
CustomerRefNo User-assigned number for internal use.
CustomsFormFile Filename where the customs form required to mail to destination country can be saved to (optional).
CustomsFormInstructions Image of customs form instructions.
CustomsFormInstructionsFile Filename and location to save the CustomsFormInstructions to.
DeliveryType Sender's selection of the type of delivery.
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 Sender's Customs Reference Number.
FromFirm Sender's company name.
FromFirstName Sender's first name.
FromLastName Sender's last name.
FromPhone Sender's phone number.
FromState Sender's state.
FromZip4 Sender's extended Zip Code (ZIP+4).
FromZipCode Sender's Zip Code.
GrossOunces Estimated weight of the package to be mailed - ounce portion.
GrossPounds Estimated weight of the package to be mailed - pounds portion.
HSTariffNumber HS Tariff Number that applies to the entire contents of the package being shipped.
ImageType Type of label image.
InsuredAmount Insurance amount, if known.
InsuredNumber Insurance number, if known.
InvoiceNumber Invoice number if known or included in 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.
LicenseNumber Import License number if known, or included in package.
NonDeliveryOption Indicates what to do with the package in case it is undeliverable.
Observations Additional mailing information based on country of destination.
Password Password to use for logging in to the USPS Server.
Postage Postage amount, if known.
Prohibitions List of items prohibited from mailing to the destination country.
Regulations Additional regulations for shipping to the destination country.
RequiredCustomsForms Customs forms required to mail packages to destination country.
Restrictions Restrictions on items being shipped based on country of destination
SDRInsuredValue Insurance amount, if known.
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.
Timeout A timeout for the component.
ToAPOFPOZip APO/FPO ZIP code for Military Mail.
ToAddress1 Line 1 in shipping address.
ToAddress2 Line 2 in shipping address.
ToAddress3 Line 3 in shipping address.
ToAddress4 Line 4 in shipping address.
ToAddress5 Line 5 in shipping address.
ToAddress6 Line 6 in shipping address.
ToCity Recipient's city.
ToCountry Destination country.
ToEmail Recipient's email address.
ToFax Recipient's fax number.
ToPhone Recipient's phone number.
ToPostalCode Postal code for the recipient.
ToReference Importer's Reference.
TotalValue Total value of all items being shipped.
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.
GetFormCN22 Retrieves Customs Form CN 22 providing customs barcode number, regulations, prohibitions, observations, restrictions, and image files of the customs forms required to ship to the destination country.
GetFormCP72 Retrieves Customs Form CP 72 providing customs barcode number, regulations, prohibitions, observations, restrictions, and image files of the customs forms required to ship to the destination country.
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
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 User-defined 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.