4D Shipping SDK 2020 .NET Edition

Questions / Feedback?

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:

PickupAvailabilityChecks the availability of a Carrier Pickup service for the given address.
SchedulePickupSchedules a Carrier Pickup.
PickupInquiryReturns all the data submitted in your original SchedulePickup request.
ChangePickupChanges your original scheduled pickup with updated information (number of packages, change the date, etc).
CancelPickupCancels 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...

Testing

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

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.

AddressServiceRequestIndicates if an address service request is made.
BarcodeNumberBarcode number associated with label's barcode.
ContentsType of the contents in the package.
CountExpressThe number of Express Mail packages to be picked up.
CountInternationalThe number of International Mail packages to be picked up.
CountOtherThe number of packages to be picked up for a service type other than Priority/Express/International Mail.
CountPriorityThe number of Priority Mail packages to be picked up.
CustomerIdUser-assigned number for internal use.
CustomerReceiptImage of the Customer Online Record.
CustomerReceiptFileFilename for CustomerReceipt (optional).
DeliveryOptionIndicates the type of delivery option.
ExtraServicesContains the collection of extra services offered by USPS on shipment level.
FirewallA set of properties related to firewall access.
InsuranceCostInsurance fee for the package being shipped.
LabelImageTypeType of label image.
LabelOptionIndicates type of label the USPS Server will return.
MachinableIndicates if shipment is machinable or not.
MailingLocationPostal Office Zip Code where the item will be mailed (if different from ZipCode ).
NotifyCollection of e-mail notifications to be sent.
PackageLocationThe location of pickup.
PackagesA collection of packages contained in the shipment.
PermitIssuingPOAddressAddress of the Post Office that issued the permit.
PermitNumberPermit number to print Postage Due labels.
PostageDueAddressAddress of the Postage Due Unit (on the delivery address).
PostageProviderThe postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.
PostalZoneIndicates the number of postal rate zones between the origin and destination zip codes.
PriceOptionIndicates pricing that should be returned (i.e. Commercial Base).
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RecipientContactIdentifies the recipient's contact info.
RMABarcodeIndicates whether to print the RMANumber as a barcode on the label.
RMANumberReturn Materials Authorization number.
SenderAddressIdentifies the sender's address.
SenderContactIdentifies the sender's contact info.
SeparateReceiptIndicates whether you want the shipping label and Customer Online Label Record be printed on two separate pages.
ServiceTypeIdentifies the USPS service type (applicable to US domestic shipments) to use in a ship request.
ShipDateDate package will be mailed.
ShipmentSpecialServicesContains the collection of special services offered by USPS on shipment level.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
StandardizeAddressChecks the delivery address against the USPS Address Matching System.
TimeoutA timeout for the component.
TotalWeightThe estimated weight for the package to be picked up.
TransactionIdThe transaction Id.
USPSAccountLogin 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.

CancelPackageCancels a single package by deleting it from the eVS shipping log.
CancelPickupCancels a scheduled Carrier Pickup request.
ChangePickupChanges requested data in your original Pickup Schedule request and schedules a new pickup.
ConfigSets or retrieves a configuration setting.
GetPackageLabelGenerates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.
PickupAvailabilityChecks the availability of a Carrier Pickup service for the given address.
PickupInquiryRetrieves the data submitted in your original SchedulePickup request.
ResetResets the internal state of the component and all properties to their default values.
SchedulePickupSchedules 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.

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

ActionCodeUse to specify the Action Code.
AddOnAggregate[i]Indicates the AddOn raw XML.
AddOnAmount[i]Indicates the AddOn amount.
AddOnCountTotal number of AddOns.
AddOnType[i]Indicates the AddOn type.
AddOnTypeDescription[i]Indicates the AddOn description.
AddOnTypesThe AddOn type to be requested.
AllowBadAddressIndicates whether the destination and origin addresses should be verified.
CarrierReleaseIndicates if the CARRIER LEAVE IF NO RESPONSE is to be printed on the eVS Domestic Labels.
CarrierRouteThe carrier route.
CertifyCertify/Test mode for label components.
ContentDescriptionContent Description of a package.
CRIDCustomer Registration ID.
CustomerId2User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API.
EMCAAccountFor future use.
EMCAPasswordFor future use.
EndiciaCODAS3816Indicates whether the 2-part Form AS3816 will be used.
EndiciaCODEndorsementOptional endorsement string on the form.
EndiciaCODPMExpressReturnIndicates whether the COD is to be returned by Express Mail.
EndiciaCODReturnAddress1Return Addressee's Address Line 1.
EndiciaCODReturnCityReturn Addressee's City.
EndiciaCODReturnNameReturn Addressee's name.
EndiciaCODReturnPostalCodeReturn Addressee's Postal Code.
EndiciaCODReturnStateReturn Addressee's State.
EndiciaCODUSPSCAUSPS Corporate Account Number.
EndiciaCostCenterCost-center code for accounting purposes.
EndiciaHazMatDescriptionHazMat Description.
EndiciaHazMatPhoneHazMat phone number.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EndiciaInsuredMailUsed to request Endicia mailpiece insurance.
EndiciaLabelTypeThe Endicia label type to be used.
EndiciaMailClassSpecifies the mail class used with the Consolidator Service request.
EndiciaPrintConsolidatorLabelUsed to request Consolidator Services.
EndiciaPrintScanBasedLabelUsed to request Pay-on-Use Returns.
EndiciaReplyPostageUsed to request postage paid return labels.
EndiciaTestModeControls whether requests are test requests or live requests.
EndiciaValidateAddressDefines if the address should be validated or not.
EntryFacilityPostal facility where mail is entered.
EscapeEndiciaXMLWhether to escape XML special characters when using Endicia.
eSOFAllowedElectronic Signature On File (eSOF) Allowed. Valid for USPS eVS Domestic Labels only.
HasXPathDetermines whether a specific element exists in the document.
HoldForManifestHolds manifest record for inclusion in SCAN request.
ImageParametersFor future use.
IncludeEndiciaCODFormIndicates whether the COD labels should be returned in the response.
IncludePostageUsed to determine if the postage will be printed on the label.
IntegratorTxIdStamps.com transaction integrator Id.
LabelImageResolutionThe resolution of the label.
LabelImageRotationThe rotation of the label.
LabelSizeThe size of the label.
LogisticsManagerMIDLogistics Manager Mailer ID.
MemoCustomer defined data to be printed on a Stamps shipping label.
MerchandiseReturnNumberThe number assigned to the return package.
MIDMailer ID.
NineDigitRoutingZipNine Digit Routing Zip. Valid for USPS eVS Domestic Labels only.
OptOutOfSPEOpt out of Shipping Partner Event file creation.
OverwriteDetermines whether label files will be overwritten.
PackageLabelUrlStamps.com label Url.
PackageNumberThe package number to be used in the case of multiple packages.
POZipCodeZIP Code of Post Office.
PrintCustomerRefNoPrint Customer Reference Number (CustomerId). Valid for USPS eVS Domestic Labels only.
PrintCustomerRefNo2Print Customer Reference Number 2 (CustomerId2). Valid for USPS eVS Domestic Labels only.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
ReceiptOptionIndicates the Label and Receipt layout options.
RegisteredMailValueThe value of registered mail sent in the request.
RequestIdThe ID used to identify a particular request/response pair when tracking Endicia packages.
RubberStamp1Customer defined data to be printed on label.
RubberStamp2Customer defined data to be printed on label.
RubberStamp3Customer defined data to be printed on label.
SCANFormImageImage of the PS Form 3152 or PS Form 5630.
SCANFormImageFileThe location where the SCAN Form Image will be written.
SCANFormNumberReturns the Form Number from the last succesful call to USPSCreateManifest.
SCANFormTypeIndicates the SCAN Form Type that should be returned when calling USPSCreateManifest.
SCANPackageBarcodesA list of Package Barcodes to include in the SCAN Request (create a manifest for).
SenderPhoneExtSender's phone number extension.
ShipInfoShip Info. Valid for USPS eVS Domestic Labels only.
ShipTimeTime package will be mailed.
SortTypeSort level for applicable mail classes.
SpecialInstructionsSpecial instructions for pickup location.
StampsAPIVersionControls the API version used for requests.
StampsCreateManifestSends a request to create a manifest for the specified shipments.
StampsCreateManifestIdReturns the ManifestId from the last succesful call to StampsCreateManifest.
StampsCreateManifestIdentifierA list of identifiers to create a manifest for.
StampsCreateManifestIdentifierTypeUsed to indicate the type of identifier used.
StampsTestModeControls whether requests are test requests or live requests.
StampsTxIdStamps.com transaction identifier.
TotalPackagesThe total number of packages to be used in the case of multiple packages.
UseStandardPostUsed to retrieve Standard Post shipping labels.
UseStealthUsed to determine if the postage price is printed on the label.
USPSCreateManifestSends a SCAN request to create a manifest for the specified shipments.
VendorCodeVendor Code to identify the developer of the shipping system.
VendorProductVersionNumberVendor Product Version Number.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
XChildCountThe 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.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathUsed to set the XPath within the response from the server.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.1 [Build 8300]