USPSShip Component

Properties   Methods   Events   Configuration Settings   Errors  

Allows you to generate a USPS shipping label for any of USPS domestic services complete with addresses and barcode, or manage pickups. To get a label with USPS, postage must be paid. To get a label with postage you must use ppNone , ppEndicia , or ppStamps as your PostageProvider . Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS (or Electronic Verification System) Label API allows high-volume package mailers and package consolidators to document and pay postage, including special service fees, using electronic manifest files.

Syntax

DPayments.DShippingSDK.Uspsship

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 Return Shipment, etc.).

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.

Postage Provider Notes

ppNone

When using USPS as the PostageProvider (i.e. ppNone) you will need to...

• Set PostageProvider to ppNone (default).
• Set UserId to the UserId provided by USPS.
• Set Password to the password provided by USPS.
• Set Server to either the test or production server.

ppEndicia

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

• Set PostageProvider to ppEndicia.
• Set AccountNumber to your production account number (provided by Endicia).
• Set Password to your production password (provided by Endicia).

Testing

The components come with a built in sandbox account for your use. To use that account with the components...

• Set PostageProvider to ppEndicia.
• Set EndiciaTestMode to either 1 or 2.

In all cases the component will send requests to the correct server without setting Server.

ppStamps

When using Stamps.com as the PostageProvider you will need to...

• Set PostageProvider to ppStamps.
• Set UserId to the sandbox or production user provided by Stamps.com.
• Set AccountNumber to the sandbox or production account number provided by Stamps.com.
• Set Password to the sandbox or production password provided by Stamps.com.
• Set Server to either the test or production server.

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	Barcode number associated with label's barcode.
Contents	Type of the contents in the package.
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).
DeliveryOption	Indicates the type of delivery option.
ExtraServices	Contains the collection of extra services offered by USPS on shipment level.
Firewall	A set of properties related to firewall access.
InsuranceCost	Insurance fee for the package being shipped.
LabelImageType	Type of label image.
LabelOption	Indicates type of label the USPS Server will return.
Machinable	Indicates if shipment is machinable or not.
MailingLocation	Postal Office Zip Code where the item will be mailed (if different from ZipCode ).
Notify	Collection of e-mail notifications to be sent.
PackageLocation	The location of pickup.
Packages	A collection of packages contained in the shipment.
PermitIssuingPOAddress	Address of the Post Office that issued the permit.
PermitNumber	Permit number to print Postage Due labels.
PostageDueAddress	Address of the Postage Due Unit (on the delivery address).
PostageProvider	The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.
PostalZone	Indicates the number of postal rate zones between the origin and destination zip codes.
PriceOption	Indicates pricing that should be returned (i.e. Commercial Base).
Proxy	A set of properties related to proxy access.
RecipientAddress	Identifies the recipient's address.
RecipientContact	Identifies the recipient's contact info.
RMABarcode	Indicates whether to print the RMANumber as a barcode on the label.
RMANumber	Return Materials Authorization number.
SenderAddress	Identifies the sender's address.
SenderContact	Identifies the sender's contact info.
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.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
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.
USPSAccount	Login information for USPS.

Method List

---

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

CancelPackage	Cancels a single package by deleting it from the eVS shipping log.
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. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.
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.

ActionCode	Use to specify the Action Code.
AddOnAggregate[i]	Indicates the AddOn raw XML.
AddOnAmount[i]	Indicates the AddOn amount.
AddOnCount	Total number of AddOns.
AddOnType[i]	Indicates the AddOn type.
AddOnTypeDescription[i]	Indicates the AddOn description.
AddOnTypes	The AddOn type to be requested.
AllowBadAddress	Indicates whether the destination and origin addresses should be verified.
CarrierRelease	Indicates if the CARRIER LEAVE IF NO RESPONSE is to be printed on the eVS Domestic Labels.
CarrierRoute	The carrier route.
Certify	Certify/Test mode for label components.
ContentDescription	Content Description of a package.
CRID	Customer Registration ID.
CustomerId2	User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API.
EMCAAccount	For future use.
EMCAPassword	For future use.
EndiciaCODAS3816	Indicates whether the 2-part Form AS3816 will be used.
EndiciaCODEndorsement	Optional endorsement string on the form.
EndiciaCODPMExpressReturn	Indicates whether the COD is to be returned by Express Mail.
EndiciaCODReturnAddress1	Return Addressee's Address Line 1.
EndiciaCODReturnCity	Return Addressee's City.
EndiciaCODReturnName	Return Addressee's name.
EndiciaCODReturnPostalCode	Return Addressee's Postal Code.
EndiciaCODReturnState	Return Addressee's State.
EndiciaCODUSPSCA	USPS Corporate Account Number.
EndiciaCostCenter	Cost-center code for accounting purposes.
EndiciaHazMatDescription	HazMat Description.
EndiciaHazMatPhone	HazMat phone number.
EndiciaInsuranceType	The Insurance type when using Endicia.
EndiciaInsuredMail	Used to request Endicia mailpiece insurance.
EndiciaLabelType	The Endicia label type to be used.
EndiciaMailClass	Specifies the mail class used with the Consolidator Service request.
EndiciaPrintConsolidatorLabel	Used to request Consolidator Services.
EndiciaPrintScanBasedLabel	Used to request Pay-on-Use Returns.
EndiciaReplyPostage	Used to request postage paid return labels.
EndiciaTestMode	Controls whether requests are test requests or live requests.
EndiciaValidateAddress	Defines if the address should be validated or not.
EntryFacility	Postal facility where mail is entered.
EscapeEndiciaXML	Whether to escape XML special characters when using Endicia.
eSOFAllowed	Electronic Signature On File (eSOF) Allowed. Valid for USPS eVS Domestic Labels only.
HasXPath	Determines whether a specific element exists in the document.
HoldForManifest	Holds manifest record for inclusion in SCAN request.
ImageParameters	For future use.
IncludeEndiciaCODForm	Indicates whether the COD labels should be returned in the response.
IncludePostage	Used to determine if the postage will be printed on the label.
IntegratorTxId	Stamps.com transaction integrator Id.
LabelImageResolution	The resolution of the label.
LabelImageRotation	The rotation of the label.
LabelSize	The size of the label.
LogisticsManagerMID	Logistics Manager Mailer ID.
Memo	Customer defined data to be printed on a Stamps shipping label.
MerchandiseReturnNumber	The number assigned to the return package.
MID	Mailer ID.
NineDigitRoutingZip	Nine Digit Routing Zip. Valid for USPS eVS Domestic Labels only.
OptOutOfSPE	Opt out of Shipping Partner Event file creation.
Overwrite	Determines whether label files will be overwritten.
PackageLabelUrl	Stamps.com label Url.
PackageNumber	The package number to be used in the case of multiple packages.
POZipCode	ZIP Code of Post Office.
PrintCustomerRefNo	Print Customer Reference Number (CustomerId). Valid for USPS eVS Domestic Labels only.
PrintCustomerRefNo2	Print Customer Reference Number 2 (CustomerId2). Valid for USPS eVS Domestic Labels only.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
ReceiptOption	Indicates the Label and Receipt layout options.
RegisteredMailValue	The value of registered mail sent in the request.
RequestId	The ID used to identify a particular request/response pair when tracking Endicia packages.
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.
SCANFormImage	Image of the PS Form 3152 or PS Form 5630.
SCANFormImageFile	The location where the SCAN Form Image will be written.
SCANFormNumber	Returns the Form Number from the last succesful call to USPSCreateManifest.
SCANFormType	Indicates the SCAN Form Type that should be returned when calling USPSCreateManifest.
SCANPackageBarcodes	A list of Package Barcodes to include in the SCAN Request (create a manifest for).
SenderPhoneExt	Sender's phone number extension.
ShipInfo	Ship Info. Valid for USPS eVS Domestic Labels only.
ShipTime	Time package will be mailed.
SortType	Sort level for applicable mail classes.
SpecialInstructions	Special instructions for pickup location.
StampsAPIVersion	Controls the API version used for requests.
StampsCreateManifest	Sends a request to create a manifest for the specified shipments.
StampsCreateManifestId	Returns the ManifestId from the last succesful call to StampsCreateManifest.
StampsCreateManifestIdentifier	A list of identifiers to create a manifest for.
StampsCreateManifestIdentifierType	Used to indicate the type of identifier used.
StampsTestMode	Controls whether requests are test requests or live requests.
StampsTxId	Stamps.com transaction identifier.
TotalPackages	The total number of packages to be used in the case of multiple packages.
UseStandardPost	Used to retrieve Standard Post shipping labels.
UseStealth	Used to determine if the postage price is printed on the label.
USPSCreateManifest	Sends a SCAN request to create a manifest for the specified shipments.
VendorCode	Vendor Code to identify the developer of the shipping system.
VendorProductVersionNumber	Vendor Product Version Number.
XAttrCount	The number of records in the XAttr arrays.
XAttrName[i]	The name of the indexed attribute.
XAttrValue[i]	The value of the indexed attribute.
XChildCount	The number of records in the XChild arrays.
XChildElement[i]	The name of the indexed child element.
XChildText[i]	The text of the indexed child element.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Used to set the XPath within the response from the server.
XText	The text of the current element.
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.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
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 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.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
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.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
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.
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.
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 component.
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.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
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).
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;.
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 component 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.
UseNTLMv2	Whether to use NTLM V2.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
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.
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.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
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 UseInternalSecurityAPI is True.
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.
GUIAvailable	Tells the component whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.