Shipping Integrator USPSShip Component : USPSShip OCX, USPSShip .NET Component, USPSShip Class, USPSShip Bean, USPSShip Object

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

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 other special services you want to associate the shipment (such as Hold For Pickup, Return Shipment, etc.).

This component allows you also to return only the tracking number by using the GetTrackingNumber method. This is useful if you have your own Postnet barcode generating software.

In addition, the component can submit a request for your carrier to pick up packages from your current location. You can schedule multiple pickups and edit or cancel previously submitted pickups, and even electronically determine if carrier pickup is available at your current address.

The following methods are available for scheduling carrier pickups:


PickupAvailability	Checks the availability of a Carrier Pickup service for the given address.
SchedulePickup	Schedules a Carrier Pickup.
PickupInquiry	Returns all the data submitted in your original SchedulePickup request.
ChangePickup	Changes your original scheduled pickup with updated information (number of packages, change the date, etc).
CancelPickup	Cancels a scheduled Carrier Pickup request.

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

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

Property List

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


AddressServiceRequest	Indicates if an address service request is made.
BarcodeNumber	Postnet Barcode number associated with label's barcode.
CountExpress	The number of Express Mail packages to be picked up.
CountInternational	The number of International Mail packages to be picked up.
CountOther	The number of packages to be picked up for a service type other than Priority/Express/International Mail.
CountPriority	The number of Priority Mail packages to be picked up.
CustomerId	User-assigned number for internal use.
CustomerReceipt	Image of the Customer Online Record.
CustomerReceiptFile	Filename for CustomerReceipt (optional).
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.
InsuranceCost	Insurance fee for the package being shipped.
LabelImageType	Type of label image.
LabelOption	Indicates type of label the USPS Server will return.
MailingLocation	Postal Office Zip Code where the item will be mailed (if different from ZipCode ).
NotifyCount	The number of records in the Notify arrays.
NotifyEmail	Email address of the recipient to be notified.
NotifyName	The name associated with the notification.
NotifyType	Identifies the set of valid email notification recipient types.
PackageLocation	The location of pickup.
PackageCount	The number of records in the Package arrays.
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.
PermitIssuingPOCity	Name of city, town, etc.
PermitIssuingPOState	State or province code.
PermitIssuingPOZipCode	Postal code.
PermitNumber	Permit number to print Postage Due labels.
PostageDueAddress1	Street name.
PostageDueCity	Name of city, town, etc.
PostageDueState	State or province code.
PostageDueZipCode	Postal code.
PostageProvider	The postage provider to use.
PostalZone	Indicates the number of postal rate zones between the origin and destination zip codes.
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.
RecipientCity	Name of city, town, etc.
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.
RMABarcode	Indicates whether to print the RMANumber as a barcode on the label.
RMANumber	Return Materials Authorization number.
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.
SeparateReceipt	Indicates whether you want the shipping label and Customer Online Label Record be printed on two separate pages.
ServiceType	Identifies the USPS service type (applicable to US domestic shipments) to use in a ship request.
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).
StandardizeAddress	Checks the delivery address against the USPS Address Matching System.
Timeout	A timeout for the component.
TotalWeight	The estimated weight for the package to be picked up.
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 component with short descriptions. Click on the links for further details.


CancelPickup	Cancels a scheduled Carrier Pickup request.
ChangePickup	Changes requested data in your original Pickup Schedule request and schedules a new pickup.
Config	Sets or retrieves a configuration setting.
GetPackageLabel	Generates a shipping label for the first package in the shipment.
GetTrackingNumber	Generates a Delivery Confirmation Number or a Signature Confirmation Number that can be applied to user-generated labels.
PickupAvailability	Checks the availability of a Carrier Pickup service for the given address.
PickupInquiry	Retrieves the data submitted in your original SchedulePickup request.
Reset	Resets the internal state of the component and all properties to their default values.
SchedulePickup	Schedules a Carrier Pickup and provides the user a confirmation number for the scheduled pickup.

Event List

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


Error	Information about errors during data delivery.
Notification	Notification returned by the server upon successful request (if applicable).
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

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


AllowBadAddress	Indicates whether the destination address should be verified.
CarrierRoute	The carrier route.
EMCAAccount	For future use.
EMCAPassword	For future use.
FacilityId	Id of Pickup Facility used when requesting Hold For Pickup service.
SenderPhoneExt	Sender's phone number extension.
SpecialInstructions	Special instructions for pickup location.
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.
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.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
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.
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.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
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).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
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.

|

About

|

Privacy Policy

|

Terms of Use

|