UPSShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a UPS shipping label for any of UPS domestic services complete with addresses and barcode, or cancel shipments.

Syntax

UPSShip

Remarks

Generating a shipping label can be done by calling the GetShipmentLabels method. You will have to specify the package information, UPS 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 Saturday Pickup, Saturday Delivery, etc.). It also supports many valued added services for shipments, including collect on delivery (COD), declared value, delivery confirmation, and automatic notification of delivery status.

This class also allows you to delete packages included in the daily shipping log that have not already been tendered to UPS. This can be done by calling CancelShipment or CancelPackage.

To use this class, you must have a UPS UPSAccountNumber. You should also have already obtained a "Client ID" and "Client Secret" uniquely assigned to your account by UPS after registration for UPS OnLine Tools.

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.

AccountAddress1 Property (UPSShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountAddress1();
int SetAccountAddress1(const char* lpszAccountAddress1);

Unicode (Windows)
LPWSTR GetAccountAddress1();
INT SetAccountAddress1(LPCWSTR lpszAccountAddress1);

char* dshippingsdk_upsship_getaccountaddress1(void* lpObj);
int dshippingsdk_upsship_setaccountaddress1(void* lpObj, const char* lpszAccountAddress1);

QString GetAccountAddress1();
int SetAccountAddress1(QString qsAccountAddress1);

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 AccountAddress1 should not exceed 35 characters.

Data Type

String

AccountAddress2 Property (UPSShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountAddress2();
int SetAccountAddress2(const char* lpszAccountAddress2);

Unicode (Windows)
LPWSTR GetAccountAddress2();
INT SetAccountAddress2(LPCWSTR lpszAccountAddress2);

char* dshippingsdk_upsship_getaccountaddress2(void* lpObj);
int dshippingsdk_upsship_setaccountaddress2(void* lpObj, const char* lpszAccountAddress2);

QString GetAccountAddress2();
int SetAccountAddress2(QString qsAccountAddress2);

Default Value

""

Remarks

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

Data Type

String

AccountCity Property (UPSShip Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountCity();
int SetAccountCity(const char* lpszAccountCity);

Unicode (Windows)
LPWSTR GetAccountCity();
INT SetAccountCity(LPCWSTR lpszAccountCity);

char* dshippingsdk_upsship_getaccountcity(void* lpObj);
int dshippingsdk_upsship_setaccountcity(void* lpObj, const char* lpszAccountCity);

QString GetAccountCity();
int SetAccountCity(QString qsAccountCity);

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

AccountCountryCode Property (UPSShip Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountCountryCode();
int SetAccountCountryCode(const char* lpszAccountCountryCode);

Unicode (Windows)
LPWSTR GetAccountCountryCode();
INT SetAccountCountryCode(LPCWSTR lpszAccountCountryCode);

char* dshippingsdk_upsship_getaccountcountrycode(void* lpObj);
int dshippingsdk_upsship_setaccountcountrycode(void* lpObj, const char* lpszAccountCountryCode);

QString GetAccountCountryCode();
int SetAccountCountryCode(QString qsAccountCountryCode);

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

AccountState Property (UPSShip Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountState();
int SetAccountState(const char* lpszAccountState);

Unicode (Windows)
LPWSTR GetAccountState();
INT SetAccountState(LPCWSTR lpszAccountState);

char* dshippingsdk_upsship_getaccountstate(void* lpObj);
int dshippingsdk_upsship_setaccountstate(void* lpObj, const char* lpszAccountState);

QString GetAccountState();
int SetAccountState(QString qsAccountState);

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

AccountZipCode Property (UPSShip Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountZipCode();
int SetAccountZipCode(const char* lpszAccountZipCode);

Unicode (Windows)
LPWSTR GetAccountZipCode();
INT SetAccountZipCode(LPCWSTR lpszAccountZipCode);

char* dshippingsdk_upsship_getaccountzipcode(void* lpObj);
int dshippingsdk_upsship_setaccountzipcode(void* lpObj, const char* lpszAccountZipCode);

QString GetAccountZipCode();
int SetAccountZipCode(QString qsAccountZipCode);

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 AccountCity and AccountState are not present.

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

Data Type

String

AccountCompany Property (UPSShip Class)

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountCompany();
int SetAccountCompany(const char* lpszAccountCompany);

Unicode (Windows)
LPWSTR GetAccountCompany();
INT SetAccountCompany(LPCWSTR lpszAccountCompany);

char* dshippingsdk_upsship_getaccountcompany(void* lpObj);
int dshippingsdk_upsship_setaccountcompany(void* lpObj, const char* lpszAccountCompany);

QString GetAccountCompany();
int SetAccountCompany(QString qsAccountCompany);

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either AccountFirstName and AccountLastName or AccountCompany are required to be provided.

Data Type

String

AccountEmail Property (UPSShip Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountEmail();
int SetAccountEmail(const char* lpszAccountEmail);

Unicode (Windows)
LPWSTR GetAccountEmail();
INT SetAccountEmail(LPCWSTR lpszAccountEmail);

char* dshippingsdk_upsship_getaccountemail(void* lpObj);
int dshippingsdk_upsship_setaccountemail(void* lpObj, const char* lpszAccountEmail);

QString GetAccountEmail();
int SetAccountEmail(QString qsAccountEmail);

Default Value

""

Remarks

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

Data Type

String

AccountFax Property (UPSShip Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountFax();
int SetAccountFax(const char* lpszAccountFax);

Unicode (Windows)
LPWSTR GetAccountFax();
INT SetAccountFax(LPCWSTR lpszAccountFax);

char* dshippingsdk_upsship_getaccountfax(void* lpObj);
int dshippingsdk_upsship_setaccountfax(void* lpObj, const char* lpszAccountFax);

QString GetAccountFax();
int SetAccountFax(QString qsAccountFax);

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

AccountFirstName Property (UPSShip Class)

Sender's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountFirstName();
int SetAccountFirstName(const char* lpszAccountFirstName);

Unicode (Windows)
LPWSTR GetAccountFirstName();
INT SetAccountFirstName(LPCWSTR lpszAccountFirstName);

char* dshippingsdk_upsship_getaccountfirstname(void* lpObj);
int dshippingsdk_upsship_setaccountfirstname(void* lpObj, const char* lpszAccountFirstName);

QString GetAccountFirstName();
int SetAccountFirstName(QString qsAccountFirstName);

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either AccountFirstName and AccountLastName or AccountCompany must be sent.

Data Type

String

AccountLastName Property (UPSShip Class)

Person's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountLastName();
int SetAccountLastName(const char* lpszAccountLastName);

Unicode (Windows)
LPWSTR GetAccountLastName();
INT SetAccountLastName(LPCWSTR lpszAccountLastName);

char* dshippingsdk_upsship_getaccountlastname(void* lpObj);
int dshippingsdk_upsship_setaccountlastname(void* lpObj, const char* lpszAccountLastName);

QString GetAccountLastName();
int SetAccountLastName(QString qsAccountLastName);

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either AccountFirstName and AccountLastName or AccountCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

AccountMiddleInitial Property (UPSShip Class)

Middle initial.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountMiddleInitial();
int SetAccountMiddleInitial(const char* lpszAccountMiddleInitial);

Unicode (Windows)
LPWSTR GetAccountMiddleInitial();
INT SetAccountMiddleInitial(LPCWSTR lpszAccountMiddleInitial);

char* dshippingsdk_upsship_getaccountmiddleinitial(void* lpObj);
int dshippingsdk_upsship_setaccountmiddleinitial(void* lpObj, const char* lpszAccountMiddleInitial);

QString GetAccountMiddleInitial();
int SetAccountMiddleInitial(QString qsAccountMiddleInitial);

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

AccountPhone Property (UPSShip Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountPhone();
int SetAccountPhone(const char* lpszAccountPhone);

Unicode (Windows)
LPWSTR GetAccountPhone();
INT SetAccountPhone(LPCWSTR lpszAccountPhone);

char* dshippingsdk_upsship_getaccountphone(void* lpObj);
int dshippingsdk_upsship_setaccountphone(void* lpObj, const char* lpszAccountPhone);

QString GetAccountPhone();
int SetAccountPhone(QString qsAccountPhone);

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

FirewallAutoDetect Property (UPSShip 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_upsship_getfirewallautodetect(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getfirewalltype(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getfirewallhost(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getfirewallpassword(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getfirewallport(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getfirewalluser(void* lpObj);
int dshippingsdk_upsship_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

LabelImageType Property (UPSShip Class)

Type of image or printer commands the shipping label is to be formatted in.

Syntax

• C++
• C
• Qt

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

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

UIT_GIF(0), 
UIT_EPL(1), 
UIT_SPL(2), 
UIT_ZPL(3), 
UIT_STAR(4)

int dshippingsdk_upsship_getlabelimagetype(void* lpObj);
int dshippingsdk_upsship_setlabelimagetype(void* lpObj, int iLabelImageType);

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

Default Value

0

Remarks

This element defines the print method code that the labels are to be generated to. It is applicable and required to be provided in a ship request for forward shipments or return shipments. The value selection depends on the printer type used to print the shipping label.

Valid image types and their meanings with the corresponding usage are listed below:

There are two types of shipping labels supported: plain paper (when printing to an HP compatible laser or inkjet type printer only. In this case, the only possible value for the LabelImageType is 0 (uitGIF)), and thermal (when printing to thermal printers only. In this case, possible values for the LabelImageType are 1, 2, 3, and 4).

While the content of each of these labels is the same, their usages are different. Each provides a bar-coded image for the purpose of scanning the package during handling. The uses of each label depend on the type of working environment to be used.

Data Type

Integer

MasterTrackingNumber Property (UPSShip Class)

Tracking number assigned to the whole MPS shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMasterTrackingNumber();

Unicode (Windows)
LPWSTR GetMasterTrackingNumber();

char* dshippingsdk_upsship_getmastertrackingnumber(void* lpObj);

QString GetMasterTrackingNumber();

Default Value

""

Remarks

This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when the GetShipmentLabels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the CancelShipment method is called). It can also be used when tracking a MPS.

This property is read-only.

Data Type

String

NotifyCount Property (UPSShip 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_upsship_getnotifycount(void* lpObj);
int dshippingsdk_upsship_setnotifycount(void* lpObj, int iNotifyCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyAggregate
• NotifyEmail
• NotifyFlags
• NotifyMessage

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

This property is not available at design time.

Data Type

Integer

NotifyAggregate Property (UPSShip Class)

This can be used to set the entire aggregate xml for the recipient to be notified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyAggregate(int iNotifyIdx);
int SetNotifyAggregate(int iNotifyIdx, const char* lpszNotifyAggregate);

Unicode (Windows)
LPWSTR GetNotifyAggregate(INT iNotifyIdx);
INT SetNotifyAggregate(INT iNotifyIdx, LPCWSTR lpszNotifyAggregate);

char* dshippingsdk_upsship_getnotifyaggregate(void* lpObj, int notifyidx);
int dshippingsdk_upsship_setnotifyaggregate(void* lpObj, int notifyidx, const char* lpszNotifyAggregate);

QString GetNotifyAggregate(int iNotifyIdx);
int SetNotifyAggregate(int iNotifyIdx, QString qsNotifyAggregate);

Default Value

""

Remarks

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows: <EMailNotificationDetail> <PersonalMessage>personal_message</PersonalMessage> <Recipients> (this aggregate can be entered up to six times) <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType> <EMailAddress>recipient_email</EMailAddress> <NotifyOnShipment>true_or_false</NotifyOnShipment> <NotifyOnException>true_or_false</NotifyOnException> <NotifyOnDelivery>true_or_false</NotifyOnDelivery> <Format>format_type</Format> <Localization> <LanguageCode>language_code</LanguageCode> </Localization> </Recipients> </EMailNotificationDetail>

In this aggregate, you can specify:

• a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
• the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
• the recipient's email address (via the EMailAddress element). This is required.
• whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
• the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
• the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

This setting is optional. If NotifyAggregate is not set it will be automatically created by the class.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

In this aggregate, you can specify:

• a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
• the recipient's email address (via the EMailAddress element). This is required.
• the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
• the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
• an optional from name.
• a message text to be sent in the email notification (via the Memo element). This is optional.

Note that this property does not apply for USPS and CanadaPost.

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

NotifyEmail Property (UPSShip 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_upsship_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_upsship_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

NotifyMessage Property (UPSShip Class)

User defined text that will be included in the email to be sent to Email .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyMessage(int iNotifyIdx);
int SetNotifyMessage(int iNotifyIdx, const char* lpszNotifyMessage);

Unicode (Windows)
LPWSTR GetNotifyMessage(INT iNotifyIdx);
INT SetNotifyMessage(INT iNotifyIdx, LPCWSTR lpszNotifyMessage);

char* dshippingsdk_upsship_getnotifymessage(void* lpObj, int notifyidx);
int dshippingsdk_upsship_setnotifymessage(void* lpObj, int notifyidx, const char* lpszNotifyMessage);

QString GetNotifyMessage(int iNotifyIdx);
int SetNotifyMessage(int iNotifyIdx, QString qsNotifyMessage);

Default Value

""

Remarks

User defined text that will be included in the email to be sent to NotifyEmail. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This property is not used by USPS 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

NotifyFlags Property (UPSShip Class)

Identifies the type of notification requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyFlags(int iNotifyIdx);
int SetNotifyFlags(int iNotifyIdx, int iNotifyFlags);

Unicode (Windows)
INT GetNotifyFlags(INT iNotifyIdx);
INT SetNotifyFlags(INT iNotifyIdx, INT iNotifyFlags);

int dshippingsdk_upsship_getnotifyflags(void* lpObj, int notifyidx);
int dshippingsdk_upsship_setnotifyflags(void* lpObj, int notifyidx, int iNotifyFlags);

int GetNotifyFlags(int iNotifyIdx);
int SetNotifyFlags(int iNotifyIdx, int iNotifyFlags);

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Tender
• On Estimated Delivery
• HTML
• Text

For UPS notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Return
• In Transit
• ADL
• UAP

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

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

PackageCount Property (UPSShip 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_upsship_getpackagecount(void* lpObj);
int dshippingsdk_upsship_setpackagecount(void* lpObj, int iPackageCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageBaseCharge
• PackageCODAmount
• PackageCODType
• PackageDescription
• PackageHeight
• PackageId
• PackageInsuredValue
• PackageLength
• PackageReference
• PackageReturnReceipt
• PackageReturnReceiptFile
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSpecialServices
• PackageTotalSurcharges
• 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

PackageBaseCharge Property (UPSShip Class)

Actual Base Charge applicable to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageBaseCharge(INT iPackageIdx);

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

QString GetPackageBaseCharge(int iPackageIdx);

Default Value

""

Remarks

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl 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 the 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 the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

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 read-only and not available at design time.

Data Type

String

PackageCODAmount Property (UPSShip 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_upsship_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getpackagedescription(void* lpObj, int packageidx);
int dshippingsdk_upsship_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

PackageHeight Property (UPSShip 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_upsship_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getpackageid(void* lpObj, int packageidx);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_upsship_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

PackageType Property (UPSShip 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_upsship_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_upsship_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

PackageReference Property (UPSShip Class)

Indicates the package reference type and value, that associates this package (assigned by the customer).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageReference(int iPackageIdx);
int SetPackageReference(int iPackageIdx, const char* lpszPackageReference);

Unicode (Windows)
LPWSTR GetPackageReference(INT iPackageIdx);
INT SetPackageReference(INT iPackageIdx, LPCWSTR lpszPackageReference);

char* dshippingsdk_upsship_getpackagereference(void* lpObj, int packageidx);
int dshippingsdk_upsship_setpackagereference(void* lpObj, int packageidx, const char* lpszPackageReference);

QString GetPackageReference(int iPackageIdx);
int SetPackageReference(int iPackageIdx, QString qsPackageReference);

Default Value

""

Remarks

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the PackageReference should be set to: CN:123456; IN:123; SN:12;.

Reference information may also be used to track packages by reference.

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the PackageReference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track packages by reference.

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

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

PackageReturnReceipt Property (UPSShip Class)

Image of the receipt for a return shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageReturnReceipt(int iPackageIdx, char* &lpPackageReturnReceipt, int &lenPackageReturnReceipt);

Unicode (Windows)
INT GetPackageReturnReceipt(INT iPackageIdx, LPSTR &lpPackageReturnReceipt, INT &lenPackageReturnReceipt);

int dshippingsdk_upsship_getpackagereturnreceipt(void* lpObj, int packageidx, char** lpPackageReturnReceipt, int* lenPackageReturnReceipt);

QByteArray GetPackageReturnReceipt(int iPackageIdx);

Default Value

""

Remarks

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the PackageReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

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

PackageReturnReceiptFile Property (UPSShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageReturnReceiptFile(int iPackageIdx);
int SetPackageReturnReceiptFile(int iPackageIdx, const char* lpszPackageReturnReceiptFile);

Unicode (Windows)
LPWSTR GetPackageReturnReceiptFile(INT iPackageIdx);
INT SetPackageReturnReceiptFile(INT iPackageIdx, LPCWSTR lpszPackageReturnReceiptFile);

char* dshippingsdk_upsship_getpackagereturnreceiptfile(void* lpObj, int packageidx);
int dshippingsdk_upsship_setpackagereturnreceiptfile(void* lpObj, int packageidx, const char* lpszPackageReturnReceiptFile);

QString GetPackageReturnReceiptFile(int iPackageIdx);
int SetPackageReturnReceiptFile(int iPackageIdx, QString qsPackageReturnReceiptFile);

Default Value

""

Remarks

Filename and location to save the PackageReturnReceipt of this package to. This is applicable only if using UPS.

When the PackageReturnReceiptFile is set to a valid path and filename, the contents of the PackageReturnReceipt are written to disk upon successful response (if a return shipment).

The PackageReturnReceiptFile has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

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

PackageShippingLabel Property (UPSShip 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_upsship_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 (UPSShip 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_upsship_getpackageshippinglabelfile(void* lpObj, int packageidx);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_upsship_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

PackageSpecialServices Property (UPSShip Class)

Contains the collection of special services offered on the package level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPackageSpecialServices(int iPackageIdx);
int SetPackageSpecialServices(int iPackageIdx, int64 lPackageSpecialServices);

Unicode (Windows)
LONG64 GetPackageSpecialServices(INT iPackageIdx);
INT SetPackageSpecialServices(INT iPackageIdx, LONG64 lPackageSpecialServices);

int64 dshippingsdk_upsship_getpackagespecialservices(void* lpObj, int packageidx);
int dshippingsdk_upsship_setpackagespecialservices(void* lpObj, int packageidx, int64 lPackageSpecialServices);

qint64 GetPackageSpecialServices(int iPackageIdx);
int SetPackageSpecialServices(int iPackageIdx, qint64 lPackageSpecialServices);

Default Value

0

Remarks

Contains the collection of special services offered on the package level. Valid values are:

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the PackageSpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below for FedEx:

• Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
• Dangerous Goods: Indicates that this package contains dangerous goods. When the PackageSpecialServices contains this flag, then the PackageDangerousGoodsAccessible is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
• Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
• Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
• Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
• COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the PackageCODAmount and PackageCODType must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the PackageSpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below:

• Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
• Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the PackageCODAmount and PackageCODType, PackageSignatureType, and PackageInsuredValue.

This property is not applicable to USPS or 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

Long64

PackageTotalSurcharges Property (UPSShip Class)

Total Actual Surcharges applicable to this package.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetPackageTotalSurcharges(INT iPackageIdx);

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

QString GetPackageTotalSurcharges(int iPackageIdx);

Default Value

""

Remarks

Total Actual Surcharges applicable to this package.

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

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, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

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 read-only and not available at design time.

Data Type

String

PackageTrackingNumber Property (UPSShip 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_upsship_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 (UPSShip 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_upsship_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_upsship_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

PayorAccountNumber Property (UPSShip Class)

The account number of the party responsible for payment (shipping charges, or duties and taxes).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorAccountNumber();
int SetPayorAccountNumber(const char* lpszPayorAccountNumber);

Unicode (Windows)
LPWSTR GetPayorAccountNumber();
INT SetPayorAccountNumber(LPCWSTR lpszPayorAccountNumber);

char* dshippingsdk_upsship_getpayoraccountnumber(void* lpObj);
int dshippingsdk_upsship_setpayoraccountnumber(void* lpObj, const char* lpszPayorAccountNumber);

QString GetPayorAccountNumber();
int SetPayorAccountNumber(QString qsPayorAccountNumber);

Default Value

""

Remarks

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to PayorAccountNumber.

Data Type

String

PayorType Property (UPSShip Class)

Method of payment for shipment, or duties and taxes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPayorType();
int SetPayorType(int iPayorType);

Unicode (Windows)
INT GetPayorType();
INT SetPayorType(INT iPayorType);

PT_SENDER(0), 
PT_RECIPIENT(1), 
PT_THIRD_PARTY(2), 
PT_COLLECT(3), 
PT_CONSIGNEE(4)

int dshippingsdk_upsship_getpayortype(void* lpObj);
int dshippingsdk_upsship_setpayortype(void* lpObj, int iPayorType);

int GetPayorType();
int SetPayorType(int iPayorType);

Default Value

0

Remarks

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this property is set to a value other than 0 (ptSender), the PayorAccountNumber and PayorCountryCode are required to be provided in the request as well. Otherwise, those will default to FedExAccountNumber and SenderCountryCode.

For UPS, when set to ptSender, the PayorAccountNumber is automatically set to UPSAccountNumber. When ptRecipient is specified, PayorAccountNumber and PayorZipCode are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the PayorAccountNumber, PayorZipCode and PayorCountryCode are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

Data Type

Integer

PayorZipCode Property (UPSShip Class)

Payor's postal code (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorZipCode();
int SetPayorZipCode(const char* lpszPayorZipCode);

Unicode (Windows)
LPWSTR GetPayorZipCode();
INT SetPayorZipCode(LPCWSTR lpszPayorZipCode);

char* dshippingsdk_upsship_getpayorzipcode(void* lpObj);
int dshippingsdk_upsship_setpayorzipcode(void* lpObj, const char* lpszPayorZipCode);

QString GetPayorZipCode();
int SetPayorZipCode(QString qsPayorZipCode);

Default Value

""

Remarks

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS PayorAccountNumber's pickup address. This should be the same as it was entered in the UPS system when this account was set up.

It can be provided in a ship request only if the PayorType is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

Data Type

String

PickupContainerType Property (UPSShip Class)

The type of container to be picked up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPickupContainerType();
int SetPickupContainerType(int iPickupContainerType);

Unicode (Windows)
INT GetPickupContainerType();
INT SetPickupContainerType(INT iPickupContainerType);

PCC_PACKAGE(0), 
PCC_LETTER(1), 
PCC_PALLET(2)

int dshippingsdk_upsship_getpickupcontainertype(void* lpObj);
int dshippingsdk_upsship_setpickupcontainertype(void* lpObj, int iPickupContainerType);

int GetPickupContainerType();
int SetPickupContainerType(int iPickupContainerType);

Default Value

0

Remarks

This indicates what type of container is being picked up.

Note the pccPallet is only valid if ServiceType is set to stUPSWorldwideExpressFreight.

Data Type

Integer

PickupEarliestTime Property (UPSShip Class)

The earliest time a shipment is ready to be picked up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPickupEarliestTime();
int SetPickupEarliestTime(const char* lpszPickupEarliestTime);

Unicode (Windows)
LPWSTR GetPickupEarliestTime();
INT SetPickupEarliestTime(LPCWSTR lpszPickupEarliestTime);

char* dshippingsdk_upsship_getpickupearliesttime(void* lpObj);
int dshippingsdk_upsship_setpickupearliesttime(void* lpObj, const char* lpszPickupEarliestTime);

QString GetPickupEarliestTime();
int SetPickupEarliestTime(QString qsPickupEarliestTime);

Default Value

""

Remarks

This is required when calling SchedulePickup. This contains the earliest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

Data Type

String

PickupLatestTime Property (UPSShip Class)

The latest time a shipment can be picked up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPickupLatestTime();
int SetPickupLatestTime(const char* lpszPickupLatestTime);

Unicode (Windows)
LPWSTR GetPickupLatestTime();
INT SetPickupLatestTime(LPCWSTR lpszPickupLatestTime);

char* dshippingsdk_upsship_getpickuplatesttime(void* lpObj);
int dshippingsdk_upsship_setpickuplatesttime(void* lpObj, const char* lpszPickupLatestTime);

QString GetPickupLatestTime();
int SetPickupLatestTime(QString qsPickupLatestTime);

Default Value

""

Remarks

This is required when calling SchedulePickup. This contains the latest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

Data Type

String

PickupPaymentMethod Property (UPSShip Class)

The method of payment for a pickup.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPickupPaymentMethod();
int SetPickupPaymentMethod(int iPickupPaymentMethod);

Unicode (Windows)
INT GetPickupPaymentMethod();
INT SetPickupPaymentMethod(INT iPickupPaymentMethod);

PPM_NONE(0), 
PPM_ACCOUNT(1), 
PPM_TRACKING_NUMBER(2), 
PPM_CHECK_OR_MONEY_ORDER(3)

int dshippingsdk_upsship_getpickuppaymentmethod(void* lpObj);
int dshippingsdk_upsship_setpickuppaymentmethod(void* lpObj, int iPickupPaymentMethod);

int GetPickupPaymentMethod();
int SetPickupPaymentMethod(int iPickupPaymentMethod);

Default Value

1

Remarks

This indicates how the pickup will be paid for.

The valid values are as follows:

Data Type

Integer

ProxyAuthScheme Property (UPSShip 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_upsship_getproxyauthscheme(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getproxyautodetect(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getproxypassword(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getproxyport(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getproxyserver(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getproxyssl(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getproxyuser(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getrecipientaddress1(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getrecipientaddress2(void* lpObj);
int dshippingsdk_upsship_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

RecipientAddressFlags Property (UPSShip Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientAddressFlags();
int SetRecipientAddressFlags(int iRecipientAddressFlags);

Unicode (Windows)
INT GetRecipientAddressFlags();
INT SetRecipientAddressFlags(INT iRecipientAddressFlags);

int dshippingsdk_upsship_getrecipientaddressflags(void* lpObj);
int dshippingsdk_upsship_setrecipientaddressflags(void* lpObj, int iRecipientAddressFlags);

int GetRecipientAddressFlags();
int SetRecipientAddressFlags(int iRecipientAddressFlags);

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (UPSShip 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_upsship_getrecipientcity(void* lpObj);
int dshippingsdk_upsship_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 (UPSShip 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_upsship_getrecipientcountrycode(void* lpObj);
int dshippingsdk_upsship_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.