USPSShip Class

Properties   Methods   Events   Config 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

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 class 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:

Postage Provider Notes

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

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

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 USPSAccountNumber to your production account number (provided by Endicia).
• Set USPSPassword to your production password (provided by Endicia).

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.

ppStamps

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

• Set PostageProvider to ppStamps.
• Set USPSUserId to the sandbox or production user provided by Stamps.com.
• Set USPSAccountNumber to the sandbox or production account number provided by Stamps.com.
• Set USPSPassword to the sandbox or production password provided by Stamps.com.
• Set USPSServer to either the test or production server.

Property List

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

Method List

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

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.

Config Settings

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

AddressServiceRequest Property (USPSShip Class)

Indicates if an address service request is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAddressServiceRequest();
int SetAddressServiceRequest(int bAddressServiceRequest);

Unicode (Windows)
BOOL GetAddressServiceRequest();
INT SetAddressServiceRequest(BOOL bAddressServiceRequest);

int dshippingsdk_uspsship_getaddressservicerequest(void* lpObj);
int dshippingsdk_uspsship_setaddressservicerequest(void* lpObj, int bAddressServiceRequest);

bool GetAddressServiceRequest();
int SetAddressServiceRequest(bool bAddressServiceRequest);

Default Value

FALSE

Remarks

The value of this property is optional. False is assumed if no value is entered.

By setting this property to True, you can request the USPS to alert you when a customer changes their address. This feature is especially useful to ensure correct billing. The words "Address Service Requested" will appear on the shipping label immediately below the return address.

By using this option, you will receive the following service with Priority Mail:

• For 12 months after an address change, the mail piece is forwarded at no charge. However, a separate notice of the new address is returned to you and an address correction fee is charged.
• For 13-18 months after an address change, the mail piece is returned with the new address attached at no charge.
• After 18 months, or if undeliverable, the mail piece is returned with the reason for nondelivery attached at no charge.

Data Type

Boolean

BarcodeNumber Property (USPSShip Class)

Barcode number associated with label's barcode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBarcodeNumber();

Unicode (Windows)
LPWSTR GetBarcodeNumber();

char* dshippingsdk_uspsship_getbarcodenumber(void* lpObj);

QString GetBarcodeNumber();

Default Value

""

Remarks

The value of this property is filled after a call to the GetPackageLabel method when using the eVS Label API (in other words PostageProvider is set to ppNone).

This property is read-only.

Data Type

String

Contents Property (USPSShip Class)

Type of the contents in the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContents();
int SetContents(int iContents);

Unicode (Windows)
INT GetContents();
INT SetContents(INT iContents);

CT_SAMPLE(0), 
CT_GIFT(1), 
CT_DOCUMENTS(2), 
CT_RETURN(3), 
CT_OTHER(4), 
CT_MERCHANDISE(5), 
CT_HUMANITARIAN_DONATION(6), 
CT_DANGEROUS_GOODS(7), 
CT_CREMATED_REMAINS(8), 
CT_NON_NEGOTIABLE_DOCUMENT(9), 
CT_PHARMACEUTICALS(10), 
CT_MEDICAL_SUPPLIES(11), 
CT_HAZMAT(12), 
CT_LIVES(13), 
CT_PERISHABLE(14)

int dshippingsdk_uspsship_getcontents(void* lpObj);
int dshippingsdk_uspsship_setcontents(void* lpObj, int iContents);

int GetContents();
int SetContents(int iContents);

Default Value

0

Remarks

You can set this property when generating labels to indicate the content type in the package.

Possible values are as follows:

Note that if Contents is set to ctLives, you must also set the ContentDescription configuration setting. For example:

class.Contents = ctLives; class.Config("ContentDescription=0");

Data Type

Integer

CountExpress Property (USPSShip Class)

The number of Express Mail packages to be picked up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCountExpress();
int SetCountExpress(int iCountExpress);

Unicode (Windows)
INT GetCountExpress();
INT SetCountExpress(INT iCountExpress);

int dshippingsdk_uspsship_getcountexpress(void* lpObj);
int dshippingsdk_uspsship_setcountexpress(void* lpObj, int iCountExpress);

int GetCountExpress();
int SetCountExpress(int iCountExpress);

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountInternational, and CountOther properties to indicate such.

The maximum count is 999 packages.

Data Type

Integer

CountInternational Property (USPSShip Class)

The number of International Mail packages to be picked up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCountInternational();
int SetCountInternational(int iCountInternational);

Unicode (Windows)
INT GetCountInternational();
INT SetCountInternational(INT iCountInternational);

int dshippingsdk_uspsship_getcountinternational(void* lpObj);
int dshippingsdk_uspsship_setcountinternational(void* lpObj, int iCountInternational);

int GetCountInternational();
int SetCountInternational(int iCountInternational);

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountExpress, and CountOther properties to indicate such.

The maximum count is 999 packages.

Data Type

Integer

CountOther Property (USPSShip Class)

The number of packages to be picked up for a service type other than Priority/Express/International Mail.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCountOther();
int SetCountOther(int iCountOther);

Unicode (Windows)
INT GetCountOther();
INT SetCountOther(INT iCountOther);

int dshippingsdk_uspsship_getcountother(void* lpObj);
int dshippingsdk_uspsship_setcountother(void* lpObj, int iCountOther);

int GetCountOther();
int SetCountOther(int iCountOther);

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountPriority, CountExpress, CountInternational properties to indicate such.

The maximum count is 999 packages.

Data Type

Integer

CountPriority Property (USPSShip Class)

The number of Priority Mail packages to be picked up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCountPriority();
int SetCountPriority(int iCountPriority);

Unicode (Windows)
INT GetCountPriority();
INT SetCountPriority(INT iCountPriority);

int dshippingsdk_uspsship_getcountpriority(void* lpObj);
int dshippingsdk_uspsship_setcountpriority(void* lpObj, int iCountPriority);

int GetCountPriority();
int SetCountPriority(int iCountPriority);

Default Value

0

Remarks

When the SchedulePickup method is called, there must be provided at least one Express Mail Package or one Priority Mail package to make the SchedulePickup call a valid request. If your pickup contains more than one type of package, you may use the CountExpress, CountInternational, and CountOther properties to indicate such.

The maximum count is 999 packages.

Data Type

Integer

CustomerId Property (USPSShip Class)

User-assigned number for internal use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerId();
int SetCustomerId(const char* lpszCustomerId);

Unicode (Windows)
LPWSTR GetCustomerId();
INT SetCustomerId(LPCWSTR lpszCustomerId);

char* dshippingsdk_uspsship_getcustomerid(void* lpObj);
int dshippingsdk_uspsship_setcustomerid(void* lpObj, const char* lpszCustomerId);

QString GetCustomerId();
int SetCustomerId(QString qsCustomerId);

Default Value

""

Remarks

You can set a value to CustomerId property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.

Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId value on the shipping label image if you set the PrintCustomerRefNo to True. In all other cases this string will not be included on the label.

For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.

Data Type

String

CustomerReceipt Property (USPSShip Class)

Image of the Customer Online Record.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCustomerReceipt(char* &lpCustomerReceipt, int &lenCustomerReceipt);

Unicode (Windows)
INT GetCustomerReceipt(LPSTR &lpCustomerReceipt, INT &lenCustomerReceipt);

int dshippingsdk_uspsship_getcustomerreceipt(void* lpObj, char** lpCustomerReceipt, int* lenCustomerReceipt);

QByteArray GetCustomerReceipt();

Default Value

""

Remarks

If you want to have the Customer Online Label Record and PackageShippingLabel in separate image files, you can accomplish this by setting the ReceiptOption property to 1 (meaning "SEPARATE PAGE"). This image can be generated in PDF or TIF format. The image type is determined by setting LabelImageType property prior to submitting the request.

The Customer Receipt must be presented when filing an indemnity claim and/or for a postage refund.

This property is read-only.

Data Type

Binary String

CustomerReceiptFile Property (USPSShip Class)

Filename for CustomerReceipt (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerReceiptFile();
int SetCustomerReceiptFile(const char* lpszCustomerReceiptFile);

Unicode (Windows)
LPWSTR GetCustomerReceiptFile();
INT SetCustomerReceiptFile(LPCWSTR lpszCustomerReceiptFile);

char* dshippingsdk_uspsship_getcustomerreceiptfile(void* lpObj);
int dshippingsdk_uspsship_setcustomerreceiptfile(void* lpObj, const char* lpszCustomerReceiptFile);

QString GetCustomerReceiptFile();
int SetCustomerReceiptFile(QString qsCustomerReceiptFile);

Default Value

""

Remarks

When this property is set to a valid filename, the contents of the CustomerReceipt property are written into the file.

The file will be saved in the format defined by the value of LabelImageType property, and the filename should include the appropriate extension.

Data Type

String

DeliveryOption Property (USPSShip Class)

Indicates the type of delivery option for USPS eVS Domestic shipments.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDeliveryOption();
int SetDeliveryOption(int iDeliveryOption);

Unicode (Windows)
INT GetDeliveryOption();
INT SetDeliveryOption(INT iDeliveryOption);

EDO_NORMAL(0), 
EDO_NO_WEEKEND(1), 
EDO_NO_HOLIDAY(2), 
EDO_NO_WEEKEND_OR_HOLIDAY(3), 
EDO_NO_SATURDAY(4), 
EDO_NO_SUNDAY(5), 
EDO_SUNDAY(6), 
EDO_HOLIDAY(7), 
EDO_NO_SUNDAY_OR_HOLIDAY(8), 
EDO_SCHEDULED_ENDOF_DAY(9), 
EDO_SCHEDULED_ENDOF_DAY_NO_SUNDAY_OR_HOLIDAY(10), 
EDO_SCHEDULED_ENDOF_DAY_NO_WEEKEND_OR_HOLIDAY(11)

int dshippingsdk_uspsship_getdeliveryoption(void* lpObj);
int dshippingsdk_uspsship_setdeliveryoption(void* lpObj, int iDeliveryOption);

int GetDeliveryOption();
int SetDeliveryOption(int iDeliveryOption);

Default Value

1

Remarks

Note that this property is valid when ServiceType is stUSPSPriorityExpress (85) and PostageProvider is set to ppNone.

The default value for this property is edoNormal.

Possible values are as follows:

Data Type

Integer

ExtraServices Property (USPSShip Class)

Contains the collection of extra services offered by USPS on shipment level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetExtraServices();
int SetExtraServices(int64 lExtraServices);

Unicode (Windows)
LONG64 GetExtraServices();
INT SetExtraServices(LONG64 lExtraServices);

int64 dshippingsdk_uspsship_getextraservices(void* lpObj);
int dshippingsdk_uspsship_setextraservices(void* lpObj, int64 lExtraServices);

qint64 GetExtraServices();
int SetExtraServices(qint64 lExtraServices);

Default Value

0

Remarks

To request any of the extra services offered by USPS, you must set the ExtraServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

Data Type

Long64

FirewallAutoDetect Property (USPSShip Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int dshippingsdk_uspsship_getfirewallautodetect(void* lpObj);
int dshippingsdk_uspsship_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (USPSShip Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int dshippingsdk_uspsship_getfirewalltype(void* lpObj);
int dshippingsdk_uspsship_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (USPSShip Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* dshippingsdk_uspsship_getfirewallhost(void* lpObj);
int dshippingsdk_uspsship_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (USPSShip Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* dshippingsdk_uspsship_getfirewallpassword(void* lpObj);
int dshippingsdk_uspsship_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (USPSShip Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int dshippingsdk_uspsship_getfirewallport(void* lpObj);
int dshippingsdk_uspsship_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (USPSShip Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* dshippingsdk_uspsship_getfirewalluser(void* lpObj);
int dshippingsdk_uspsship_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

InsuranceCost Property (USPSShip Class)

Insurance fee for the package being shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInsuranceCost();

Unicode (Windows)
LPWSTR GetInsuranceCost();

char* dshippingsdk_uspsship_getinsurancecost(void* lpObj);

QString GetInsuranceCost();

Default Value

""

Remarks

This is a computed cost of insurance based on the value specified in InsuredValue.

The value of this property is filled after a call to the GetPackageLabel method only when the Return Shipment flag has been set in the ShipmentSpecialServices property.

This property is read-only.

Data Type

String

LabelImageType Property (USPSShip Class)

Type of label image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Unicode (Windows)
INT GetLabelImageType();
INT SetLabelImageType(INT iLabelImageType);

SIT_NONE(0), 
SIT_TIF(1), 
SIT_JPG(2), 
SIT_PDF(3), 
SIT_GIF(4), 
SIT_EPL(5), 
SIT_PNG(6), 
SIT_ZPL(7), 
SIT_PDFVECTOR(8), 
SIT_PDFVECTOR_WITH_FONTS(9), 
SIT_AZPL(10)

int dshippingsdk_uspsship_getlabelimagetype(void* lpObj);
int dshippingsdk_uspsship_setlabelimagetype(void* lpObj, int iLabelImageType);

int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Default Value

0

Remarks

The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:

Valid values for USPS (eVSLabels):

• sitTIF (1)
• sitPDF (3)

Valid values for Endicia:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitPDFVector (8)
• sitPDFVectorWithFonts (9)

Valid values for Stamps.com:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitAZPL (10)

Data Type

Integer

LabelOption Property (USPSShip Class)

Indicates type of label the USPS Server will return.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLabelOption();
int SetLabelOption(const char* lpszLabelOption);

Unicode (Windows)
LPWSTR GetLabelOption();
INT SetLabelOption(LPCWSTR lpszLabelOption);

char* dshippingsdk_uspsship_getlabeloption(void* lpObj);
int dshippingsdk_uspsship_setlabeloption(void* lpObj, const char* lpszLabelOption);

QString GetLabelOption();
int SetLabelOption(QString qsLabelOption);

Default Value

""

Remarks

For Delivery and Signature confirmation, the USPS Server may return either an entire label with the 'To' and 'From' address and the confirmation barcode, or a label with only the barcode and tracking number may be returned. Label options 1 and 2 are available for both Delivery Confirmation labels and Signature Confirmation labels. Detailed descriptions of these label options are included below.

Data Type

String

Machinable Property (USPSShip Class)

Indicates if shipment is machinable or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMachinable();
int SetMachinable(int iMachinable);

Unicode (Windows)
INT GetMachinable();
INT SetMachinable(INT iMachinable);

MO_TRUE(0), 
MO_FALSE(1), 
MO_IRREGULAR(2)

int dshippingsdk_uspsship_getmachinable(void* lpObj);
int dshippingsdk_uspsship_setmachinable(void* lpObj, int iMachinable);

int GetMachinable();
int SetMachinable(int iMachinable);

Default Value

0

Remarks

The default value for this property is moTrue (0).

Note: The value moIrregular (2) is valid only when ServiceType is stUSPSBPM (74), stUSPSMedia (75), or stUSPSLibrary (76).

Possible values are as follows:

Data Type

Integer

MailingLocation Property (USPSShip Class)

Postal Office Zip Code where the item will be mailed (if different from ZipCode ).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMailingLocation();
int SetMailingLocation(const char* lpszMailingLocation);

Unicode (Windows)
LPWSTR GetMailingLocation();
INT SetMailingLocation(LPCWSTR lpszMailingLocation);

char* dshippingsdk_uspsship_getmailinglocation(void* lpObj);
int dshippingsdk_uspsship_setmailinglocation(void* lpObj, const char* lpszMailingLocation);

QString GetMailingLocation();
int SetMailingLocation(QString qsMailingLocation);

Default Value

""

Remarks

The value of this property is optional.

If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (SenderZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.

This way, you convey this difference to the USPS Server.

Data Type

String

NotifyCount Property (USPSShip Class)

The number of records in the Notify arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyCount();
int SetNotifyCount(int iNotifyCount);

Unicode (Windows)
INT GetNotifyCount();
INT SetNotifyCount(INT iNotifyCount);

int dshippingsdk_uspsship_getnotifycount(void* lpObj);
int dshippingsdk_uspsship_setnotifycount(void* lpObj, int iNotifyCount);

int GetNotifyCount();
int SetNotifyCount(int iNotifyCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyEmail
• NotifyName
• NotifyType

The array indices start at 0 and end at NotifyCount - 1.

This property is not available at design time.

Data Type

Integer

NotifyEmail Property (USPSShip Class)

Email address of the recipient to be notified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyEmail(int iNotifyIdx);
int SetNotifyEmail(int iNotifyIdx, const char* lpszNotifyEmail);

Unicode (Windows)
LPWSTR GetNotifyEmail(INT iNotifyIdx);
INT SetNotifyEmail(INT iNotifyIdx, LPCWSTR lpszNotifyEmail);

char* dshippingsdk_uspsship_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_uspsship_setnotifyemail(void* lpObj, int notifyidx, const char* lpszNotifyEmail);

QString GetNotifyEmail(int iNotifyIdx);
int SetNotifyEmail(int iNotifyIdx, QString qsNotifyEmail);

Default Value

""

Remarks

Email address of the recipient to be notified. This is required to be provided for each recipient.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyName Property (USPSShip Class)

The name associated with the notification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyName(int iNotifyIdx);
int SetNotifyName(int iNotifyIdx, const char* lpszNotifyName);

Unicode (Windows)
LPWSTR GetNotifyName(INT iNotifyIdx);
INT SetNotifyName(INT iNotifyIdx, LPCWSTR lpszNotifyName);

char* dshippingsdk_uspsship_getnotifyname(void* lpObj, int notifyidx);
int dshippingsdk_uspsship_setnotifyname(void* lpObj, int notifyidx, const char* lpszNotifyName);

QString GetNotifyName(int iNotifyIdx);
int SetNotifyName(int iNotifyIdx, QString qsNotifyName);

Default Value

""

Remarks

The name associated with the notification.

For USPS, this name will appear in the text of the Signature Confirmation e-mail message.

This property is not applicable to FedEx, UPS, or Canada Post.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyType Property (USPSShip Class)

Identifies the set of valid email notification recipient types.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyType(int iNotifyIdx);
int SetNotifyType(int iNotifyIdx, int iNotifyType);

Unicode (Windows)
INT GetNotifyType(INT iNotifyIdx);
INT SetNotifyType(INT iNotifyIdx, INT iNotifyType);

RT_UNSPECIFIED(0), 
RT_RECIPIENT(1), 
RT_SHIPPER(2), 
RT_BROKER(3), 
RT_OTHER(4), 
RT_THIRD_PARTY(5)

int dshippingsdk_uspsship_getnotifytype(void* lpObj, int notifyidx);
int dshippingsdk_uspsship_setnotifytype(void* lpObj, int notifyidx, int iNotifyType);

int GetNotifyType(int iNotifyIdx);
int SetNotifyType(int iNotifyIdx, int iNotifyType);

Default Value

0

Remarks

Identifies the set of valid email notification recipient types. Valid values are:

For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the NotifyEmail specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

This property does not apply to UPS or Canada Post notifications.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

Integer

PackageLocation Property (USPSShip Class)

The location of pickup.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageLocation();
int SetPackageLocation(int iPackageLocation);

Unicode (Windows)
INT GetPackageLocation();
INT SetPackageLocation(INT iPackageLocation);

PL_NOT_SET(0), 
PL_FRONT_DOOR(1), 
PL_BACK_DOOR(2), 
PL_SIDE_DOOR(3), 
PL_KNOCK_ON_DOOR(4), 
PL_MAIL_ROOM(5), 
PL_OFFICE(6), 
PL_RECEPTION(7), 
PL_IN_MAILBOX(8), 
PL_OTHER(9)

int dshippingsdk_uspsship_getpackagelocation(void* lpObj);
int dshippingsdk_uspsship_setpackagelocation(void* lpObj, int iPackageLocation);

int GetPackageLocation();
int SetPackageLocation(int iPackageLocation);

Default Value

0

Remarks

This property is required when the following methods are called:

• SchedulePickup (required)
• ChangePickup (optional)
• CancelPickup (optional)

• PickupInquiry method call.

The allowed values to be selected are: Front Door, Back Door, Side Door, Knock on Door/Ring Bell, Mail Room, Office, Reception, In/At Mailbox, Other

Note: When plOther is selected, the SpecialInstructions property is required to be entered.

Data Type

Integer

PackageCount Property (USPSShip Class)

The number of records in the Package arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCount();
int SetPackageCount(int iPackageCount);

Unicode (Windows)
INT GetPackageCount();
INT SetPackageCount(INT iPackageCount);

int dshippingsdk_uspsship_getpackagecount(void* lpObj);
int dshippingsdk_uspsship_setpackagecount(void* lpObj, int iPackageCount);

int GetPackageCount();
int SetPackageCount(int iPackageCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageCODAmount
• PackageCODType
• PackageDescription
• PackageGirth
• PackageHeight
• PackageId
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSize
• PackageTrackingNumber
• PackageType
• PackageWeight
• PackageWidth

The array indices start at 0 and end at PackageCount - 1.

This property is not available at design time.

Data Type

Integer

PackageCODAmount Property (USPSShip Class)

The COD monetary value for the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, const char* lpszPackageCODAmount);

Unicode (Windows)
LPWSTR GetPackageCODAmount(INT iPackageIdx);
INT SetPackageCODAmount(INT iPackageIdx, LPCWSTR lpszPackageCODAmount);

char* dshippingsdk_uspsship_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagecodamount(void* lpObj, int packageidx, const char* lpszPackageCODAmount);

QString GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, QString qsPackageCODAmount);

Default Value

""

Remarks

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in PackageCODLabel).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the PackageCODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the PackageCODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackageType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by PackageSignatureType) and COD cannot coexist on a single package.

This property is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageCODType Property (USPSShip Class)

The code that indicates the type of funds that will be used for the COD payment for this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

Unicode (Windows)
INT GetPackageCODType(INT iPackageIdx);
INT SetPackageCODType(INT iPackageIdx, INT iPackageCODType);

CODTP_ANY(0), 
CODTP_CASH(1), 
CODTP_GUARANTEED_FUNDS(2), 
CODTP_COMPANY_CHECK(3), 
CODTP_PERSONAL_CHECK(4)

int dshippingsdk_uspsship_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagecodtype(void* lpObj, int packageidx, int iPackageCODType);

int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

Default Value

0

Remarks

The code that indicates the type of funds that will be used for the COD payment for this package.

This property is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., PackageCODAmount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageDescription Property (USPSShip Class)

For FedEx, this is the description that appears in the email to identify this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDescription(int iPackageIdx);
int SetPackageDescription(int iPackageIdx, const char* lpszPackageDescription);

Unicode (Windows)
LPWSTR GetPackageDescription(INT iPackageIdx);
INT SetPackageDescription(INT iPackageIdx, LPCWSTR lpszPackageDescription);

char* dshippingsdk_uspsship_getpackagedescription(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagedescription(void* lpObj, int packageidx, const char* lpszPackageDescription);

QString GetPackageDescription(int iPackageIdx);
int SetPackageDescription(int iPackageIdx, QString qsPackageDescription);

Default Value

""

Remarks

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageGirth Property (USPSShip Class)

Measurement around the widest part of the package, perpendicular to the Length .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageGirth(int iPackageIdx);
int SetPackageGirth(int iPackageIdx, int iPackageGirth);

Unicode (Windows)
INT GetPackageGirth(INT iPackageIdx);
INT SetPackageGirth(INT iPackageIdx, INT iPackageGirth);

int dshippingsdk_uspsship_getpackagegirth(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagegirth(void* lpObj, int packageidx, int iPackageGirth);

int GetPackageGirth(int iPackageIdx);
int SetPackageGirth(int iPackageIdx, int iPackageGirth);

Default Value

0

Remarks

Measurement around the widest part of the package, perpendicular to the PackageLength.

This property is only applicable when requesting rates for USPS packages.

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageHeight Property (USPSShip Class)

The height of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

Unicode (Windows)
INT GetPackageHeight(INT iPackageIdx);
INT SetPackageHeight(INT iPackageIdx, INT iPackageHeight);

int dshippingsdk_uspsship_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackageheight(void* lpObj, int packageidx, int iPackageHeight);

int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the PackageHeight is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageWidth are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set). For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageId Property (USPSShip Class)

An 8-digit Unique Parcel Identification Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageId(int iPackageIdx);
int SetPackageId(int iPackageIdx, const char* lpszPackageId);

Unicode (Windows)
LPWSTR GetPackageId(INT iPackageIdx);
INT SetPackageId(INT iPackageIdx, LPCWSTR lpszPackageId);

char* dshippingsdk_uspsship_getpackageid(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackageid(void* lpObj, int packageidx, const char* lpszPackageId);

QString GetPackageId(int iPackageIdx);
int SetPackageId(int iPackageIdx, QString qsPackageId);

Default Value

""

Remarks

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This property is optional, and only applies to USPS return labels.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageInsuredValue Property (USPSShip Class)

Amount of insurance requested for this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, const char* lpszPackageInsuredValue);

Unicode (Windows)
LPWSTR GetPackageInsuredValue(INT iPackageIdx);
INT SetPackageInsuredValue(INT iPackageIdx, LPCWSTR lpszPackageInsuredValue);

char* dshippingsdk_uspsship_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackageinsuredvalue(void* lpObj, int packageidx, const char* lpszPackageInsuredValue);

QString GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, QString qsPackageInsuredValue);

Default Value

""

Remarks

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageLength Property (USPSShip Class)

The length of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

Unicode (Windows)
INT GetPackageLength(INT iPackageIdx);
INT SetPackageLength(INT iPackageIdx, INT iPackageLength);

int dshippingsdk_uspsship_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagelength(void* lpObj, int packageidx, int iPackageLength);

int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the PackageLength is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageWidth and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, the PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageNetCharge Property (USPSShip Class)

Actual Net Charge applicable to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageNetCharge(int iPackageIdx);
int SetPackageNetCharge(int iPackageIdx, const char* lpszPackageNetCharge);

Unicode (Windows)
LPWSTR GetPackageNetCharge(INT iPackageIdx);
INT SetPackageNetCharge(INT iPackageIdx, LPCWSTR lpszPackageNetCharge);

char* dshippingsdk_uspsship_getpackagenetcharge(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagenetcharge(void* lpObj, int packageidx, const char* lpszPackageNetCharge);

QString GetPackageNetCharge(int iPackageIdx);
int SetPackageNetCharge(int iPackageIdx, QString qsPackageNetCharge);

Default Value

""

Remarks

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment.

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageType Property (USPSShip Class)

The packaging type of the package being rated and/or shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

Unicode (Windows)
INT GetPackageType(INT iPackageIdx);
INT SetPackageType(INT iPackageIdx, INT iPackageType);

PT_NONE(0), 
PT_POSTCARDS(1), 
PT_LETTER(2), 
PT_LARGE_ENVELOPE(3), 
PT_FLAT_RATE_ENVELOPE(4), 
PT_FLAT_RATE_LEGAL_ENVELOPE(5), 
PT_FLAT_RATE_PADDED_ENVELOPE(6), 
PT_FLAT_RATE_GIFT_CARD_ENVELOPE(7), 
PT_FLAT_RATE_WINDOW_ENVELOPE(8), 
PT_FLAT_RATE_CARDBOARD_ENVELOPE(9), 
PT_SMALL_FLAT_RATE_ENVELOPE(10), 
PT_PAK(11), 
PT_BOX(12), 
PT_10KG_BOX(13), 
PT_25KG_BOX(14), 
PT_SMALL_EXPRESS_BOX(15), 
PT_MEDIUM_EXPRESS_BOX(16), 
PT_LARGE_EXPRESS_BOX(17), 
PT_FLAT_RATE_BOX(18), 
PT_SMALL_FLAT_RATE_BOX(19), 
PT_MEDIUM_FLAT_RATE_BOX(20), 
PT_LARGE_FLAT_RATE_BOX(21), 
PT_DVDFLAT_RATE_BOX(22), 
PT_LARGE_VIDEO_FLAT_RATE_BOX(23), 
PT_REGIONAL_RATE_BOX_A(24), 
PT_REGIONAL_RATE_BOX_B(25), 
PT_RECTANGULAR(26), 
PT_NON_RECTANGULAR(27), 
PT_TUBE(28), 
PT_MATTER_FOR_THE_BLIND(29), 
PT_PALLET(30), 
PT_YOUR_PACKAGING(31), 
PT_DOCUMENT(32), 
PT_FLATS(33), 
PT_PARCELS(34), 
PT_BPM(35), 
PT_FIRST_CLASS(36), 
PT_PRIORITY(37), 
PT_MACHINABLES(38), 
PT_IRREGULARS(39), 
PT_PARCEL_POST(40), 
PT_BPMPARCEL(41), 
PT_MEDIA_MAIL(42), 
PT_BPMFLAT(43), 
PT_STANDARD_FLAT(44), 
PT_REGIONAL_RATE_BOX_C(45), 
PT_THICK_ENVELOPE(46), 
PT_SMALL_BOX(47), 
PT_MEDIUM_BOX(48), 
PT_LARGE_BOX(49), 
PT_EXTRA_LARGE_BOX(50), 
PT_PACKAGE_SERVICE(51), 
PT_CUBIC_PARCELS(52), 
PT_CUBIC_SOFT_PACK(53)

int dshippingsdk_uspsship_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagetype(void* lpObj, int packageidx, int iPackageType);

int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

Default Value

0

Remarks

The packaging type of the package being rated and/or shipped.

Possible values are:

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagePackagingType for the first package is used in label requests.

If the PackagePackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackageLength, PackageWidth, and PackageHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagePackagingType will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting PackagePackagingType make sure this is valid for all the following: SenderCountryCode, RecipientCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageShippingLabel Property (USPSShip Class)

Image of the shipping label for this package returned by the Server upon a successful ship response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageShippingLabel(int iPackageIdx, char* &lpPackageShippingLabel, int &lenPackageShippingLabel);

Unicode (Windows)
INT GetPackageShippingLabel(INT iPackageIdx, LPSTR &lpPackageShippingLabel, INT &lenPackageShippingLabel);

int dshippingsdk_uspsship_getpackageshippinglabel(void* lpObj, int packageidx, char** lpPackageShippingLabel, int* lenPackageShippingLabel);

QByteArray GetPackageShippingLabel(int iPackageIdx);

Default Value

""

Remarks

Image of the shipping label for this package returned by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the PackageShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is read-only and not available at design time.

Data Type

Binary String

PackageShippingLabelFile Property (USPSShip Class)

Filename and location to save the ShippingLabel of this package to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageShippingLabelFile(int iPackageIdx);
int SetPackageShippingLabelFile(int iPackageIdx, const char* lpszPackageShippingLabelFile);

Unicode (Windows)
LPWSTR GetPackageShippingLabelFile(INT iPackageIdx);
INT SetPackageShippingLabelFile(INT iPackageIdx, LPCWSTR lpszPackageShippingLabelFile);

char* dshippingsdk_uspsship_getpackageshippinglabelfile(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackageshippinglabelfile(void* lpObj, int packageidx, const char* lpszPackageShippingLabelFile);

QString GetPackageShippingLabelFile(int iPackageIdx);
int SetPackageShippingLabelFile(int iPackageIdx, QString qsPackageShippingLabelFile);

Default Value

""

Remarks

Filename and location to save the PackageShippingLabel of this package to. When the PackageShippingLabelFile is set to a valid path and filename, the contents of the PackageShippingLabel are written to disk upon successful response.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then PackageShippingLabelFile has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageSignatureType Property (USPSShip Class)

Specifies one of the Delivery Signature Options requested for this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

Unicode (Windows)
INT GetPackageSignatureType(INT iPackageIdx);
INT SetPackageSignatureType(INT iPackageIdx, INT iPackageSignatureType);

ST_SERVICE_DEFAULT(0), 
ST_ADULT(1), 
ST_DIRECT(2), 
ST_INDIRECT(3), 
ST_NO_SIGNATURE_REQUIRED(4), 
ST_USPSDELIVERY_CONFIRMATION(5), 
ST_ADULT_19(6)

int dshippingsdk_uspsship_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagesignaturetype(void* lpObj, int packageidx, int iPackageSignatureType);

int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

Default Value

0

Remarks

Specifies one of the Delivery Signature Options requested for this package. Possible values are:

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

• Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
• Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
• Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
• Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the PackageSignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageSize Property (USPSShip Class)

Size of the package being mailed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageSize(int iPackageIdx);
int SetPackageSize(int iPackageIdx, int iPackageSize);

Unicode (Windows)
INT GetPackageSize(INT iPackageIdx);
INT SetPackageSize(INT iPackageIdx, INT iPackageSize);

PS_REGULAR(0), 
PS_LARGE(1), 
PS_OVERSIZE(2), 
PS_IRREGULAR(3)

int dshippingsdk_uspsship_getpackagesize(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagesize(void* lpObj, int packageidx, int iPackageSize);

int GetPackageSize(int iPackageIdx);
int SetPackageSize(int iPackageIdx, int iPackageSize);

Default Value

0

Remarks

Size of the package being mailed.

This property is only used by USPS and is required for the GetRates method call.

See below for valid entries:

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the PackageLength, PackageHeight, PackageWidth and optionally PackageGirth (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PackageTrackingNumber Property (USPSShip Class)

Tracking number assigned to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageTrackingNumber(int iPackageIdx);

Unicode (Windows)
LPWSTR GetPackageTrackingNumber(INT iPackageIdx);

char* dshippingsdk_uspsship_getpackagetrackingnumber(void* lpObj, int packageidx);

QString GetPackageTrackingNumber(int iPackageIdx);

Default Value

""

Remarks

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is read-only and not available at design time.

Data Type

String

PackageWeight Property (USPSShip Class)

Weight of this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, const char* lpszPackageWeight);

Unicode (Windows)
LPWSTR GetPackageWeight(INT iPackageIdx);
INT SetPackageWeight(INT iPackageIdx, LPCWSTR lpszPackageWeight);

char* dshippingsdk_uspsship_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackageweight(void* lpObj, int packageidx, const char* lpszPackageWeight);

QString GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, QString qsPackageWeight);

Default Value

"0.0"

Remarks

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if PackagePackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagePackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

PackageWidth Property (USPSShip Class)

The width of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

Unicode (Windows)
INT GetPackageWidth(INT iPackageIdx);
INT SetPackageWidth(INT iPackageIdx, INT iPackageWidth);

int dshippingsdk_uspsship_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_uspsship_setpackagewidth(void* lpObj, int packageidx, int iPackageWidth);

int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the PackageWidth is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

The PackageIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

Integer

PermitIssuingPOCity Property (USPSShip Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermitIssuingPOCity();
int SetPermitIssuingPOCity(const char* lpszPermitIssuingPOCity);

Unicode (Windows)
LPWSTR GetPermitIssuingPOCity();
INT SetPermitIssuingPOCity(LPCWSTR lpszPermitIssuingPOCity);

char* dshippingsdk_uspsship_getpermitissuingpocity(void* lpObj);
int dshippingsdk_uspsship_setpermitissuingpocity(void* lpObj, const char* lpszPermitIssuingPOCity);

QString GetPermitIssuingPOCity();
int SetPermitIssuingPOCity(QString qsPermitIssuingPOCity);

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

PermitIssuingPOState Property (USPSShip Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermitIssuingPOState();
int SetPermitIssuingPOState(const char* lpszPermitIssuingPOState);

Unicode (Windows)
LPWSTR GetPermitIssuingPOState();
INT SetPermitIssuingPOState(LPCWSTR lpszPermitIssuingPOState);

char* dshippingsdk_uspsship_getpermitissuingpostate(void* lpObj);
int dshippingsdk_uspsship_setpermitissuingpostate(void* lpObj, const char* lpszPermitIssuingPOState);

QString GetPermitIssuingPOState();
int SetPermitIssuingPOState(QString qsPermitIssuingPOState);

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

PermitIssuingPOZipCode Property (USPSShip Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermitIssuingPOZipCode();
int SetPermitIssuingPOZipCode(const char* lpszPermitIssuingPOZipCode);

Unicode (Windows)
LPWSTR GetPermitIssuingPOZipCode();
INT SetPermitIssuingPOZipCode(LPCWSTR lpszPermitIssuingPOZipCode);

char* dshippingsdk_uspsship_getpermitissuingpozipcode(void* lpObj);
int dshippingsdk_uspsship_setpermitissuingpozipcode(void* lpObj, const char* lpszPermitIssuingPOZipCode);

QString GetPermitIssuingPOZipCode();
int SetPermitIssuingPOZipCode(QString qsPermitIssuingPOZipCode);

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both PermitIssuingPOCity and PermitIssuingPOState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

PermitNumber Property (USPSShip Class)

Permit number to print Postage Due labels.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPermitNumber();
int SetPermitNumber(const char* lpszPermitNumber);

Unicode (Windows)
LPWSTR GetPermitNumber();
INT SetPermitNumber(LPCWSTR lpszPermitNumber);

char* dshippingsdk_uspsship_getpermitnumber(void* lpObj);
int dshippingsdk_uspsship_setpermitnumber(void* lpObj, const char* lpszPermitNumber);

QString GetPermitNumber();
int SetPermitNumber(QString qsPermitNumber);

Default Value

""

Remarks

Sending postage due packages requires a permit with a US Post Office. This property should contain the Permit Number you were issued by that post office.

Data Type

String

PostageDueAddress1 Property (USPSShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPostageDueAddress1();
int SetPostageDueAddress1(const char* lpszPostageDueAddress1);

Unicode (Windows)
LPWSTR GetPostageDueAddress1();
INT SetPostageDueAddress1(LPCWSTR lpszPostageDueAddress1);

char* dshippingsdk_uspsship_getpostagedueaddress1(void* lpObj);
int dshippingsdk_uspsship_setpostagedueaddress1(void* lpObj, const char* lpszPostageDueAddress1);

QString GetPostageDueAddress1();
int SetPostageDueAddress1(QString qsPostageDueAddress1);

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS PostageDueAddress1 should not exceed 35 characters.

Data Type

String

PostageDueCity Property (USPSShip Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPostageDueCity();
int SetPostageDueCity(const char* lpszPostageDueCity);

Unicode (Windows)
LPWSTR GetPostageDueCity();
INT SetPostageDueCity(LPCWSTR lpszPostageDueCity);

char* dshippingsdk_uspsship_getpostageduecity(void* lpObj);
int dshippingsdk_uspsship_setpostageduecity(void* lpObj, const char* lpszPostageDueCity);

QString GetPostageDueCity();
int SetPostageDueCity(QString qsPostageDueCity);

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

PostageDueState Property (USPSShip Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPostageDueState();
int SetPostageDueState(const char* lpszPostageDueState);

Unicode (Windows)
LPWSTR GetPostageDueState();
INT SetPostageDueState(LPCWSTR lpszPostageDueState);

char* dshippingsdk_uspsship_getpostageduestate(void* lpObj);
int dshippingsdk_uspsship_setpostageduestate(void* lpObj, const char* lpszPostageDueState);

QString GetPostageDueState();
int SetPostageDueState(QString qsPostageDueState);

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

PostageDueZipCode Property (USPSShip Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPostageDueZipCode();
int SetPostageDueZipCode(const char* lpszPostageDueZipCode);

Unicode (Windows)
LPWSTR GetPostageDueZipCode();
INT SetPostageDueZipCode(LPCWSTR lpszPostageDueZipCode);

char* dshippingsdk_uspsship_getpostageduezipcode(void* lpObj);
int dshippingsdk_uspsship_setpostageduezipcode(void* lpObj, const char* lpszPostageDueZipCode);

QString GetPostageDueZipCode();
int SetPostageDueZipCode(QString qsPostageDueZipCode);

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both PostageDueCity and PostageDueState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

PostageProvider Property (USPSShip Class)

The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPostageProvider();
int SetPostageProvider(int iPostageProvider);

Unicode (Windows)
INT GetPostageProvider();
INT SetPostageProvider(INT iPostageProvider);

PP_NONE(0), 
PP_ENDICIA(1), 
PP_STAMPS(2)

int dshippingsdk_uspsship_getpostageprovider(void* lpObj);
int dshippingsdk_uspsship_setpostageprovider(void* lpObj, int iPostageProvider);

int GetPostageProvider();
int SetPostageProvider(int iPostageProvider);

Default Value

0

Remarks

When set to ppNone, the class will communicate with USPS servers. When set to this value the following properties should also be set.

• Set USPSUserId
• Set USPSPassword
• Set USPSServer

When set to ppEndicia, the class will communicate with Endicia's servers. When set to this value the following properties should also be set.

For Production

• Set USPSAccountNumber
• Set USPSPassword

For Testing

• Set EndiciaTestMode

When set to ppStamps, the class will communicate with Stamps.com's servers. When set to this value the following properties should also be set.

• Set USPSUserId
• Set USPSAccountNumber
• Set USPSPassword
• Set USPSServer

Data Type

Integer

PostalZone Property (USPSShip Class)

Indicates the number of postal rate zones between the origin and destination zip codes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPostalZone();

Unicode (Windows)
LPWSTR GetPostalZone();

char* dshippingsdk_uspsship_getpostalzone(void* lpObj);

QString GetPostalZone();

Default Value

""

Remarks

The Postal Zone (which might be "Local" or "0 through 8") identifies the appropriate distance code assigned to each origination and destination Zip Code pairing for every Zip Code in the nation. These zones are used for Priority Mail packages over 5 lbs.

The value of this property is filled by the response from the USPS server.

This property is read-only.

Data Type

String

PriceOption Property (USPSShip Class)

Indicates pricing that should be returned (i.e. Commercial Base).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPriceOption();
int SetPriceOption(int iPriceOption);

Unicode (Windows)
INT GetPriceOption();
INT SetPriceOption(INT iPriceOption);

PO_RETAIL(0), 
PO_COMMERCIAL_PLUS(1), 
PO_COMMERCIAL_BASE(2)

int dshippingsdk_uspsship_getpriceoption(void* lpObj);
int dshippingsdk_uspsship_setpriceoption(void* lpObj, int iPriceOption);

int GetPriceOption();
int SetPriceOption(int iPriceOption);

Default Value

2

Remarks

The default value for this property is poCommercialBase (2).

Note: When ServiceType is stUSPSPriorityMailCubic (134) the component will send "Commercial Plus" in the request (per USPS eVSLabel specifications).

Note: The value poRetail (0) is valid only when ServiceType is stUSPSPriorityMailInternational (84).

Possible values are as follows:

Data Type

Integer

ProxyAuthScheme Property (USPSShip Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dshippingsdk_uspsship_getproxyauthscheme(void* lpObj);
int dshippingsdk_uspsship_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (USPSShip Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dshippingsdk_uspsship_getproxyautodetect(void* lpObj);
int dshippingsdk_uspsship_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (USPSShip Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dshippingsdk_uspsship_getproxypassword(void* lpObj);
int dshippingsdk_uspsship_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (USPSShip Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dshippingsdk_uspsship_getproxyport(void* lpObj);
int dshippingsdk_uspsship_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (USPSShip Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dshippingsdk_uspsship_getproxyserver(void* lpObj);
int dshippingsdk_uspsship_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (USPSShip Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dshippingsdk_uspsship_getproxyssl(void* lpObj);
int dshippingsdk_uspsship_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (USPSShip Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dshippingsdk_uspsship_getproxyuser(void* lpObj);
int dshippingsdk_uspsship_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (USPSShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress1();
int SetRecipientAddress1(const char* lpszRecipientAddress1);

Unicode (Windows)
LPWSTR GetRecipientAddress1();
INT SetRecipientAddress1(LPCWSTR lpszRecipientAddress1);

char* dshippingsdk_uspsship_getrecipientaddress1(void* lpObj);
int dshippingsdk_uspsship_setrecipientaddress1(void* lpObj, const char* lpszRecipientAddress1);

QString GetRecipientAddress1();
int SetRecipientAddress1(QString qsRecipientAddress1);

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (USPSShip Class)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress2();
int SetRecipientAddress2(const char* lpszRecipientAddress2);

Unicode (Windows)
LPWSTR GetRecipientAddress2();
INT SetRecipientAddress2(LPCWSTR lpszRecipientAddress2);

char* dshippingsdk_uspsship_getrecipientaddress2(void* lpObj);
int dshippingsdk_uspsship_setrecipientaddress2(void* lpObj, const char* lpszRecipientAddress2);

QString GetRecipientAddress2();
int SetRecipientAddress2(QString qsRecipientAddress2);

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.

Data Type

String

RecipientCity Property (USPSShip Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCity();
int SetRecipientCity(const char* lpszRecipientCity);

Unicode (Windows)
LPWSTR GetRecipientCity();
INT SetRecipientCity(LPCWSTR lpszRecipientCity);

char* dshippingsdk_uspsship_getrecipientcity(void* lpObj);
int dshippingsdk_uspsship_setrecipientcity(void* lpObj, const char* lpszRecipientCity);

QString GetRecipientCity();
int SetRecipientCity(QString qsRecipientCity);

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

RecipientCountryCode Property (USPSShip Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCountryCode();
int SetRecipientCountryCode(const char* lpszRecipientCountryCode);

Unicode (Windows)
LPWSTR GetRecipientCountryCode();
INT SetRecipientCountryCode(LPCWSTR lpszRecipientCountryCode);

char* dshippingsdk_uspsship_getrecipientcountrycode(void* lpObj);
int dshippingsdk_uspsship_setrecipientcountrycode(void* lpObj, const char* lpszRecipientCountryCode);

QString GetRecipientCountryCode();
int SetRecipientCountryCode(QString qsRecipientCountryCode);

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

RecipientState Property (USPSShip Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientState();
int SetRecipientState(const char* lpszRecipientState);

Unicode (Windows)
LPWSTR GetRecipientState();
INT SetRecipientState(LPCWSTR lpszRecipientState);

char* dshippingsdk_uspsship_getrecipientstate(void* lpObj);
int dshippingsdk_uspsship_setrecipientstate(void* lpObj, const char* lpszRecipientState);

QString GetRecipientState();
int SetRecipientState(QString qsRecipientState);

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

RecipientZipCode Property (USPSShip Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientZipCode();
int SetRecipientZipCode(const char* lpszRecipientZipCode);

Unicode (Windows)
LPWSTR GetRecipientZipCode();
INT SetRecipientZipCode(LPCWSTR lpszRecipientZipCode);

char* dshippingsdk_uspsship_getrecipientzipcode(void* lpObj);
int dshippingsdk_uspsship_setrecipientzipcode(void* lpObj, const char* lpszRecipientZipCode);

QString GetRecipientZipCode();
int SetRecipientZipCode(QString qsRecipientZipCode);

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

RecipientCompany Property (USPSShip Class)

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCompany();
int SetRecipientCompany(const char* lpszRecipientCompany);

Unicode (Windows)
LPWSTR GetRecipientCompany();
INT SetRecipientCompany(LPCWSTR lpszRecipientCompany);

char* dshippingsdk_uspsship_getrecipientcompany(void* lpObj);
int dshippingsdk_uspsship_setrecipientcompany(void* lpObj, const char* lpszRecipientCompany);

QString GetRecipientCompany();
int SetRecipientCompany(QString qsRecipientCompany);

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either RecipientFirstName and RecipientLastName or RecipientCompany are required to be provided.

Data Type

String

RecipientEmail Property (USPSShip Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientEmail();
int SetRecipientEmail(const char* lpszRecipientEmail);

Unicode (Windows)
LPWSTR GetRecipientEmail();
INT SetRecipientEmail(LPCWSTR lpszRecipientEmail);

char* dshippingsdk_uspsship_getrecipientemail(void* lpObj);
int dshippingsdk_uspsship_setrecipientemail(void* lpObj, const char* lpszRecipientEmail);

QString GetRecipientEmail();
int SetRecipientEmail(QString qsRecipientEmail);

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

RecipientFax Property (USPSShip Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientFax();
int SetRecipientFax(const char* lpszRecipientFax);

Unicode (Windows)
LPWSTR GetRecipientFax();
INT SetRecipientFax(LPCWSTR lpszRecipientFax);

char* dshippingsdk_uspsship_getrecipientfax(void* lpObj);
int dshippingsdk_uspsship_setrecipientfax(void* lpObj, const char* lpszRecipientFax);

QString GetRecipientFax();
int SetRecipientFax(QString qsRecipientFax);