USPSShipIntl Class

Properties Methods Events Configuration Settings Errors

Allows you to generate a USPS shipping label for any of USPS international services complete with addresses and barcode.

Syntax

inship.uspsshipintl()

Remarks

Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Hold For Pickup, Return Shipment, etc.), and any other specific information on international shipments.

This class also allows you to request customs forms through the GetFormCN22 and GetFormCP72 methods.

To use this class, you must have a USPS account. You should also have already obtained a USPSUserId and USPSPassword uniquely assigned to your account by USPS.

This class also includes Endicia support to print labels and postage through their web services. To use this service, you must have an Endicia USPSAccountNumber. You should also have already obtained a USPSUserId and USPSPassword uniquely assigned to your account by Endicia. The PostageProvider property must be set to ppEndicia to tell the class to use the Endicia protocol.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


BarcodeNumber	Barcode number required by Customs Service.
CertificateNumber	Certificate number (if known or included in the package).
Comments	Comments on the package being shipped.
CommodityCount	The number of records in the Commodity arrays.
CommodityDescription	Complete and accurate description of this commodity line item.
CommodityHarmonizedCode	Unique code representing this commodity line item (for imports only).
CommodityManufacturer	Country code where the contents of this commodity line were produced, manufactured or grown in their final form.
CommodityQuantity	Number of units contained in this commodity line item measured in units specified by the QuantityUnit .
CommodityValue	The value of an individual item being shipped.
CommodityWeight	The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.
Contents	Description of items being shipped.
CountryOfOrigin	Country where the goods originated.
CustomerId	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.
FirewallAutoDetect	This property tells the component 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 TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
HSTariffNumber	HS Tariff Number that applies to the entire contents of the package being shipped.
ImageLayout	Determines how the labels will be formatted for printing.
IndemnityCoverage	Indicates the indemnity coverage for the package.
InsurancePolicy	Insurance number, if known.
InvoiceNumber	Invoice number if known or included in the package.
LabelImageType	Type of label image.
LicenseNumber	Import License number if known, or included in package.
MailingLocation	Postal Office Zip Code where the item will be mailed (if different from ZipCode ).
NonDeliveryOption	Indicates what to do with the package in case it is undeliverable.
Notes	Additional information returned by the USPS Server .
Observations	Additional mailing information based on country of destination.
PackageCount	The number of records in the Package arrays.
PackageDescription	For FedEx, this is the description that appears in the email to identify this package.
PackageHeight	The height of the package to be shipped.
PackageId	An 8-digit Unique Parcel Identification Number.
PackageInsuredValue	Amount of insurance requested for this package.
PackageLength	The length of the package to be shipped.
PackageNetCharge	Net charge applicable to this package.
PackageType	The packaging type of the package being rated and/or shipped.
PackageShippingLabel	Image of the shipping label for this package return by the Server upon a successful ship response.
PackageShippingLabelFile	Filename and location to save the ShippingLabel of this package to.
PackageSignatureType	Specifies one of the Delivery Signature Options requested for this package.
PackageTrackingNumber	Tracking number assigned to this package.
PackageWeight	Weight of this package.
PackageWidth	The width of the package to be shipped.
PostageProvider	The postage provider to use.
Prohibitions	List of items prohibited from mailing to the destination country.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component 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 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 SSL for the connection to the proxy.
ProxyUser	This property contains a user name, 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.
RecipientCompany	Identifies the contact person's company name.
RecipientEmail	Identifies the contact person's email address.
RecipientFax	Recipient's fax number.
RecipientFirstName	Sender's first name.
RecipientLastName	Person's last name.
RecipientMiddleInitial	Middle initial.
RecipientPhone	Identifies the contact person's phone number.
RecipientCustomsReference	Corresponds to the person's Customs Reference field that appears on the shipping label.
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.
SDRValue	Special Drawing Right calculated on TotalValue .
SenderAddress1	Street name.
SenderAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderCity	Name of city, town, etc.
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.
SenderCustomsReference	Corresponds to the person's Customs Reference field that appears on the shipping label.
ServiceType	The mail service type when shipping to the CountryCode .
ShipDate	Date package will be mailed.
ShipmentSpecialServices	Contains the collection of special services offered by USPS on shipment level.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
TotalValue	Total value of all items being shipped.
TransactionId	The transaction Id.
USPSAccountNumber	The shipper's Endicia account number.
USPSPassword	Password to use for logging in to the USPS Server .
USPSServer	URL for the USPS server where the requests are sent.
USPSUserId	User Id for logging in to the USPS Server .

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 .
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.
GetPackageLabel	Generates a shipping label for the first package in the shipment.
Reset	Resets 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 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	Shows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


RawRequest	Contains the complete request sent to USPS.
RawResponse	Contains the complete response returned by the USPS server.
XPath	Used to retrieve data at any place within the response.
RequesterId	The Requester Id to be used for Endicia requests.
Certify	Certify/Test mode for label components.
ImageParameters	For future use.
LabelImageResolution	The resolution of the label.
LabelImageRotation	The rotation of the label.
LabelSize	The size of the label.
Overwrite	Determines whether label files will be overwritten.
EndiciaInsuranceType	The Insurance type when using Endicia.
EntryFacility	Postal facility where mail is entered.
POZipCode	ZIP Code of Post Office.
EscapeEndiciaXML	Whether to escape XML special characters when using Endicia.
IncludePostage	Used to determine if the postage will be printed on the label.
SortType	Sort level for applicable mail classes.
RubberStamp1	Customer defined data to be printed on label.
RubberStamp2	Customer defined data to be printed on label.
RubberStamp3	Customer defined data to be printed on label.
UseStealth	Used to determine if the postage price is printed on the label.
AddOnCount	Total number of AddOns.
PackageShippingLabelCount[i]	Total number of labels and / or custom forms returned in the response for each package.
PackageShippingLabelIndex[i]	Image of the shipping label return by the Server upon a successful ship response for each package.
AddOnTypes	The AddOn type to be requested.
AddOnType[i]	Indicates the AddOn type.
AddOnDescription[i]	Indicates the AddOn description.
AddOnAmount[i]	Indicates the AddOn amount.
AddOnAggregate[i]	Indicates the AddOn raw XML.
DeclaredValue	The amount to declare.
IntegratorTxId	Stamps.com transaction integrator Id.
StampsTxId	Stamps.com transaction identifier.
PackageLabelUrl	Stams.com label Url.
CommercialPrice	Indicates whether the commercial price should be returned.
CustomsFormType	The customs form type of the label.
CustomsSigner	The name of the person certifying the customs information is correct.
EndiciaPrintConsolidatorLabel	Used to request Consolidator Services.
HoldForManifest	Holds manifest record for inclusion in SCAN request.
PackageSize[i]	Indicates the package reference type and value, that associates this package.
PackageReference[i]	Indicates the package reference type and value, that associates this package.
OtherContents	Description of the contents.
RecipientAddress3	Recipient's address line 3.
RecipientAddress4	Recipient's address line 4.
RecipientAPOFPOZip	APO/FPO ZIP code for Military Mail.
RecipientAPOFPOZip4	APO/FPO ZIP4 code for Military Mail.
APOFPOServiceType	APO/FPO Service Type for Military Mail.
SenderUrbanization	The Urbanization that the package is being shipped from.
UseInsurance	Specifies whether or not to request insurance.
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.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.