4D Shipping SDK 2020 .NET Edition
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 either use ppEndicia or ppStamps as your PostageProvider .

Syntax

DPayments.DShipping.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 Hold For Pickup, Return Shipment, etc.).

This component also allows you 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:

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.
BarcodeNumberPostnet Barcode number associated with label's barcode.
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).
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.
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.
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.

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 .
GetPackageLabelUSPS no longer supports this operation. PostageProvider needs to be set to a value other than ppNone . Generates a shipping label for the first package in the shipment.
GetTrackingNumberUSPS no longer supports this operation.
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.

RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
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.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
RegisteredMailValueThe value of registered mail sent in the request.
StampsTestModeControls whether requests are test requests or live requests.
StampsAPIVersionControls the API version used for requests.
CertifyCertify/Test mode for label components.
ImageParametersFor future use.
LabelImageResolutionThe resolution of the label.
LabelImageRotationThe rotation of the label.
LabelSizeThe size of the label.
OverwriteDetermines whether label files will be overwritten.
StampsCreateManifestSends a request to create a manifest for the specified shipments.
StampsCreateManifestIdentifierA list of identifiers to create a manifest for.
StampsCreateManifestIdentifierTypeUsed to indicate the type of identifier used.
StampsCreateManifestIdReturns the ManifestId from the last succesful call to StampsCreateManifest.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EscapeEndiciaXMLWhether to escape XML special characters when using Endicia.
EndiciaHazMatDescriptionHazMat Description.
EndiciaHazMatPhoneHazMat phone number.
EndiciaTestModeControls whether requests are test requests or live requests.
EntryFacilityPostal facility where mail is entered.
IncludePostageUsed to determine if the postage will be printed on the label.
POZipCodeZIP Code of Post Office.
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.
SortTypeSort level for applicable mail classes.
UseStealthUsed to determine if the postage price is printed on the label.
AddOnCountTotal number of AddOns.
AddOnTypesThe AddOn type to be requested.
AddOnType[i]Indicates the AddOn type.
AddOnTypeDescription[i]Indicates the AddOn description.
AddOnAmount[i]Indicates the AddOn amount.
AddOnAggregate[i]Indicates the AddOn raw XML.
AllowBadAddressIndicates whether the destination address should be verified.
IntegratorTxIdStamps.com transaction integrator Id.
EndiciaCostCenterCost-center code for accounting purposes.
StampsTxIdStamps.com transaction identifier.
PackageLabelUrlStamps.com label Url.
CarrierRouteThe carrier route.
IncludeEndiciaCODFormIndicates whether the COD labels should be returned in the response.
EndiciaCODReturnNameReturn Addressee's name.
EndiciaCODReturnAddress1Return Addressee's Address Line 1.
EndiciaCODReturnCityReturn Addressee's City.
EndiciaCODReturnPostalCodeReturn Addressee's Postal Code.
EndiciaCODReturnStateReturn Addressee's State.
EndiciaCODAS3816Indicates whether the 2-part Form AS3816 will be used.
EndiciaCODUSPSCAUSPS Corporate Account Number.
EndiciaCODPMExpressReturnIndicates whether the COD is to be returned by Express Mail.
EndiciaCODEndorsementOptional endorsement string on the form.
EndiciaLabelTypeThe Endicia label type to be used.
EndiciaReplyPostageUsed to request postage paid return labels.
EndiciaInsuredMailUsed to request Endicia mailpiece insurance.
EndiciaPrintScanBasedLabelUsed to request Pay-on-Use Returns.
EndiciaPrintConsolidatorLabelUsed to request Consolidator Services.
EndiciaMailClassSpecifies the mail class used with the Consolidator Service request.
EMCAAccountFor future use.
EMCAPasswordFor future use.
FacilityIdId of Pickup Facility used when requesting Hold For Pickup service.
MerchandiseReturnNumberThe number assigned to the return package.
SenderPhoneExtSender's phone number extension.
SpecialInstructionsSpecial instructions for pickup location.
UseStandardPostUsed to retrieve Standard Post shipping labels.
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.
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.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
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.
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.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
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.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
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.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
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.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]