UPSShipIntl Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

UPSShipIntl

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 special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery), and any other specific information on international shipments (such as Commercial Invoice, international forms required by Customs, 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, where the MasterTrackingNumber parameter identifies the shipment.

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 (UPSShipIntl 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_upsshipintl_getaccountaddress1(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountaddress2(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountcity(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountcountrycode(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountstate(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountzipcode(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountcompany(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountemail(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountfax(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountfirstname(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountlastname(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountmiddleinitial(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getaccountphone(void* lpObj);
int dshippingsdk_upsshipintl_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

CODReport Property (UPSShipIntl Class)

Image of a COD Turn In Page.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCODReport(char* &lpCODReport, int &lenCODReport);

Unicode (Windows)
INT GetCODReport(LPSTR &lpCODReport, INT &lenCODReport);

int dshippingsdk_upsshipintl_getcodreport(void* lpObj, char** lpCODReport, int* lenCODReport);

QByteArray GetCODReport();

Default Value

""

Remarks

This applies only to shipments within the European Union (EU) countries. It is the decoded binary image file of the COD report, stored in memory upon successful ship response. The report is generated in HTML format and it will automatically be saved to disk in the file designated by CODReportFile (if this is set to a valid path and filename).

This property is read-only.

Data Type

Binary String

CODReportFile Property (UPSShipIntl Class)

Filename and location to save the CODReport to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODReportFile();
int SetCODReportFile(const char* lpszCODReportFile);

Unicode (Windows)
LPWSTR GetCODReportFile();
INT SetCODReportFile(LPCWSTR lpszCODReportFile);

char* dshippingsdk_upsshipintl_getcodreportfile(void* lpObj);
int dshippingsdk_upsshipintl_setcodreportfile(void* lpObj, const char* lpszCODReportFile);

QString GetCODReportFile();
int SetCODReportFile(QString qsCODReportFile);

Default Value

""

Remarks

This applies only to shipments within the European Union (EU) countries. When applicable and the CODReportFile is set to a valid path and filename, the contents of the CODReport are written to disk upon successful response.

This has to have .html extension.

Data Type

String

CODTotalAmount Property (UPSShipIntl Class)

The total amount to be collected on shipment level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODTotalAmount();
int SetCODTotalAmount(const char* lpszCODTotalAmount);

Unicode (Windows)
LPWSTR GetCODTotalAmount();
INT SetCODTotalAmount(LPCWSTR lpszCODTotalAmount);

char* dshippingsdk_upsshipintl_getcodtotalamount(void* lpObj);
int dshippingsdk_upsshipintl_setcodtotalamount(void* lpObj, const char* lpszCODTotalAmount);

QString GetCODTotalAmount();
int SetCODTotalAmount(QString qsCODTotalAmount);

Default Value

""

Remarks

This indicates customer's input COD amount (prior to any accumulations: total collection amount minus transportation charges).

For MPS COD shipments (when Packages is greater than 1), the COD amount must be included on each package that uses COD service by setting the PackageCODAmount.

Format: Two explicit decimals (e.g.5.00).

Data Type

String

CODType Property (UPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCODType();
int SetCODType(int iCODType);

Unicode (Windows)
INT GetCODType();
INT SetCODType(INT iCODType);

CODTS_CASH(0), 
CODTS_CHECK(1)

int dshippingsdk_upsshipintl_getcodtype(void* lpObj);
int dshippingsdk_upsshipintl_setcodtype(void* lpObj, int iCODType);

int GetCODType();
int SetCODType(int iCODType);

Default Value

0

Remarks

This property identifies the type of funds UPS should collect upon shipment delivery. It is required to be provided in the request only if COD is requested (i.e., CODTotalAmount is set to a value other than "0.00").

Valid values are:

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

Data Type

Integer

CommercialInvoiceComments Property (UPSShipIntl Class)

Commercial Invoice comments to be uploaded to customs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceComments();
int SetCommercialInvoiceComments(const char* lpszCommercialInvoiceComments);

Unicode (Windows)
LPWSTR GetCommercialInvoiceComments();
INT SetCommercialInvoiceComments(LPCWSTR lpszCommercialInvoiceComments);

char* dshippingsdk_upsshipintl_getcommercialinvoicecomments(void* lpObj);
int dshippingsdk_upsshipintl_setcommercialinvoicecomments(void* lpObj, const char* lpszCommercialInvoiceComments);

QString GetCommercialInvoiceComments();
int SetCommercialInvoiceComments(QString qsCommercialInvoiceComments);

Default Value

""

Remarks

Commercial Invoice comments to be uploaded to customs. This can be any extra information about the current shipment and is optional.

Data Type

String

CommercialInvoiceDate Property (UPSShipIntl Class)

Date when the Invoice is created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceDate();
int SetCommercialInvoiceDate(const char* lpszCommercialInvoiceDate);

Unicode (Windows)
LPWSTR GetCommercialInvoiceDate();
INT SetCommercialInvoiceDate(LPCWSTR lpszCommercialInvoiceDate);

char* dshippingsdk_upsshipintl_getcommercialinvoicedate(void* lpObj);
int dshippingsdk_upsshipintl_setcommercialinvoicedate(void* lpObj, const char* lpszCommercialInvoiceDate);

QString GetCommercialInvoiceDate();
int SetCommercialInvoiceDate(QString qsCommercialInvoiceDate);

Default Value

""

Remarks

Date when the Invoice is created. This is optional for Partial Invoice, but required for Invoice form for forward shipments. For shipment with return service, the user input will be ignored, and the field will be blank on the invoice.

If not set, it will default to the ship date. Format is YYYYMMDD.

NOTE: This field is only valid for UPS.

Data Type

String

CommercialInvoiceFreightCharge Property (UPSShipIntl Class)

Cost to transport the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceFreightCharge();
int SetCommercialInvoiceFreightCharge(const char* lpszCommercialInvoiceFreightCharge);

Unicode (Windows)
LPWSTR GetCommercialInvoiceFreightCharge();
INT SetCommercialInvoiceFreightCharge(LPCWSTR lpszCommercialInvoiceFreightCharge);

char* dshippingsdk_upsshipintl_getcommercialinvoicefreightcharge(void* lpObj);
int dshippingsdk_upsshipintl_setcommercialinvoicefreightcharge(void* lpObj, const char* lpszCommercialInvoiceFreightCharge);

QString GetCommercialInvoiceFreightCharge();
int SetCommercialInvoiceFreightCharge(QString qsCommercialInvoiceFreightCharge);

Default Value

"0.00"

Remarks

Cost to transport the shipment. This is required if CommercialInvoiceTerms is set to Cfr, Cpt, Cif, or Cip. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

Data Type

String

CommercialInvoiceInsurance Property (UPSShipIntl Class)

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceInsurance();
int SetCommercialInvoiceInsurance(const char* lpszCommercialInvoiceInsurance);

Unicode (Windows)
LPWSTR GetCommercialInvoiceInsurance();
INT SetCommercialInvoiceInsurance(LPCWSTR lpszCommercialInvoiceInsurance);

char* dshippingsdk_upsshipintl_getcommercialinvoiceinsurance(void* lpObj);
int dshippingsdk_upsshipintl_setcommercialinvoiceinsurance(void* lpObj, const char* lpszCommercialInvoiceInsurance);

QString GetCommercialInvoiceInsurance();
int SetCommercialInvoiceInsurance(QString qsCommercialInvoiceInsurance);

Default Value

"0.00"

Remarks

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. This is required if CommercialInvoiceTerms is set to Cif or Cip.. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

Data Type

String

CommercialInvoiceNumber Property (UPSShipIntl Class)

Customer's assigned invoice number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceNumber();
int SetCommercialInvoiceNumber(const char* lpszCommercialInvoiceNumber);

Unicode (Windows)
LPWSTR GetCommercialInvoiceNumber();
INT SetCommercialInvoiceNumber(LPCWSTR lpszCommercialInvoiceNumber);

char* dshippingsdk_upsshipintl_getcommercialinvoicenumber(void* lpObj);
int dshippingsdk_upsshipintl_setcommercialinvoicenumber(void* lpObj, const char* lpszCommercialInvoiceNumber);

QString GetCommercialInvoiceNumber();
int SetCommercialInvoiceNumber(QString qsCommercialInvoiceNumber);

Default Value

""

Remarks

Customer's assigned invoice number. This is optional. If included in the request, this element prints on the shipping label and commercial invoice.

Data Type

String

CommercialInvoicePurpose Property (UPSShipIntl Class)

Reason to export the current international shipment Required for dutiable international express or ground shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommercialInvoicePurpose();
int SetCommercialInvoicePurpose(int iCommercialInvoicePurpose);

Unicode (Windows)
INT GetCommercialInvoicePurpose();
INT SetCommercialInvoicePurpose(INT iCommercialInvoicePurpose);

CIP_SOLD(0), 
CIP_GIFT(1), 
CIP_NOT_SOLD(2), 
CIP_PERSONAL_EFFECTS(3), 
CIP_RETURN(4), 
CIP_REPAIR(5), 
CIP_REPAIR_AND_RETURN(6), 
CIP_SAMPLE(7), 
CIP_INTER_COMPANY_DATA(8)

int dshippingsdk_upsshipintl_getcommercialinvoicepurpose(void* lpObj);
int dshippingsdk_upsshipintl_setcommercialinvoicepurpose(void* lpObj, int iCommercialInvoicePurpose);

int GetCommercialInvoicePurpose();
int SetCommercialInvoicePurpose(int iCommercialInvoicePurpose);

Default Value

0

Remarks

Reason to export the current international shipment

Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.

Valid values are:

Data Type

Integer

CommercialInvoiceTerms Property (UPSShipIntl Class)

Indicates the rights to the seller from the buyer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommercialInvoiceTerms();
int SetCommercialInvoiceTerms(int iCommercialInvoiceTerms);

Unicode (Windows)
INT GetCommercialInvoiceTerms();
INT SetCommercialInvoiceTerms(INT iCommercialInvoiceTerms);

CIT_FCA(0), 
CIT_FOB(1), 
CIT_FAS(2), 
CIT_CFR(3), 
CIT_CIF(4), 
CIT_CIP(5), 
CIT_CPT(6), 
CIT_DAF(7), 
CIT_DDP(8), 
CIT_DDU(9), 
CIT_DEQ(10), 
CIT_DES(11), 
CIT_EXW(12)

int dshippingsdk_upsshipintl_getcommercialinvoiceterms(void* lpObj);
int dshippingsdk_upsshipintl_setcommercialinvoiceterms(void* lpObj, int iCommercialInvoiceTerms);

int GetCommercialInvoiceTerms();
int SetCommercialInvoiceTerms(int iCommercialInvoiceTerms);

Default Value

0

Remarks

Indicates the rights to the seller from the buyer.

Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.

Valid values are:

Data Type

Integer

CommodityCount Property (UPSShipIntl Class)

The number of records in the Commodity arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

Unicode (Windows)
INT GetCommodityCount();
INT SetCommodityCount(INT iCommodityCount);

int dshippingsdk_upsshipintl_getcommoditycount(void* lpObj);
int dshippingsdk_upsshipintl_setcommoditycount(void* lpObj, int iCommodityCount);

int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CommodityDescription
• CommodityExportType
• CommodityHarmonizedCode
• CommodityManufacturer
• CommodityNumberOfPieces
• CommodityQuantity
• CommodityQuantityUnit
• CommodityScheduleBCode
• CommodityUnitPrice
• CommodityValue
• CommodityWeight

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

This property is not available at design time.

Data Type

Integer

CommodityDescription Property (UPSShipIntl Class)

Complete and accurate description of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityDescription(int iCommodityIdx);
int SetCommodityDescription(int iCommodityIdx, const char* lpszCommodityDescription);

Unicode (Windows)
LPWSTR GetCommodityDescription(INT iCommodityIdx);
INT SetCommodityDescription(INT iCommodityIdx, LPCWSTR lpszCommodityDescription);

char* dshippingsdk_upsshipintl_getcommoditydescription(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommoditydescription(void* lpObj, int commodityidx, const char* lpszCommodityDescription);

QString GetCommodityDescription(int iCommodityIdx);
int SetCommodityDescription(int iCommodityIdx, QString qsCommodityDescription);

Default Value

""

Remarks

Complete and accurate description of this commodity line item.

It is applicable to all international forms. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

For FedEx, if the shipment contains documents only (i.e., Documents is set to True), then the CommodityDescription has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityExportType Property (UPSShipIntl Class)

Indicates the export type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityExportType(int iCommodityIdx);
int SetCommodityExportType(int iCommodityIdx, int iCommodityExportType);

Unicode (Windows)
INT GetCommodityExportType(INT iCommodityIdx);
INT SetCommodityExportType(INT iCommodityIdx, INT iCommodityExportType);

ET_DOMESTIC(0), 
ET_FOREIGN(1), 
ET_FOREIGN_MILITARY(2)

int dshippingsdk_upsshipintl_getcommodityexporttype(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityexporttype(void* lpObj, int commodityidx, int iCommodityExportType);

int GetCommodityExportType(int iCommodityIdx);
int SetCommodityExportType(int iCommodityIdx, int iCommodityExportType);

Default Value

0

Remarks

Indicates the export type. Applicable and required for SED only.

Valid values are:

NOTE: This field is only applicable to UPS shipments.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityHarmonizedCode Property (UPSShipIntl Class)

Unique code representing this commodity line item (for imports only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityHarmonizedCode(int iCommodityIdx);
int SetCommodityHarmonizedCode(int iCommodityIdx, const char* lpszCommodityHarmonizedCode);

Unicode (Windows)
LPWSTR GetCommodityHarmonizedCode(INT iCommodityIdx);
INT SetCommodityHarmonizedCode(INT iCommodityIdx, LPCWSTR lpszCommodityHarmonizedCode);

char* dshippingsdk_upsshipintl_getcommodityharmonizedcode(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityharmonizedcode(void* lpObj, int commodityidx, const char* lpszCommodityHarmonizedCode);

QString GetCommodityHarmonizedCode(int iCommodityIdx);
int SetCommodityHarmonizedCode(int iCommodityIdx, QString qsCommodityHarmonizedCode);

Default Value

""

Remarks

Unique code representing this commodity line item (for imports only).

The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.

It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in CommodityDescription, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityHarmonizedCode is required for each commodity line item for shipments to EU countries.

At least one occurrence is required for U.S. Export shipments if the TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityManufacturer Property (UPSShipIntl Class)

Country code where the contents of this commodity line were produced, manufactured or grown in their final form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityManufacturer(int iCommodityIdx);
int SetCommodityManufacturer(int iCommodityIdx, const char* lpszCommodityManufacturer);

Unicode (Windows)
LPWSTR GetCommodityManufacturer(INT iCommodityIdx);
INT SetCommodityManufacturer(INT iCommodityIdx, LPCWSTR lpszCommodityManufacturer);

char* dshippingsdk_upsshipintl_getcommoditymanufacturer(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommoditymanufacturer(void* lpObj, int commodityidx, const char* lpszCommodityManufacturer);

QString GetCommodityManufacturer(int iCommodityIdx);
int SetCommodityManufacturer(int iCommodityIdx, QString qsCommodityManufacturer);

Default Value

"US"

Remarks

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the CommodityManufacturer is required to be entered.

In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the CommodityManufacturer and CommodityDescription are required to be provided in the request. If the CommodityManufacturer is not provided, it defaults to US.

When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The CommodityManufacturer has to be provided for each commodity item included in that international shipment.

In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice.

In USPS, the value of this property is optional, and is only used by commercial shippers. If PostageProvider is set to ppEndicia or ppStamps, then the format must be 2 charachters long (for example: US for United States, CA for Canada etc.).

Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.

Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityNumberOfPieces Property (UPSShipIntl Class)

The total number of packages, cartons, or containers for the commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityNumberOfPieces(int iCommodityIdx);
int SetCommodityNumberOfPieces(int iCommodityIdx, int iCommodityNumberOfPieces);

Unicode (Windows)
INT GetCommodityNumberOfPieces(INT iCommodityIdx);
INT SetCommodityNumberOfPieces(INT iCommodityIdx, INT iCommodityNumberOfPieces);

int dshippingsdk_upsshipintl_getcommoditynumberofpieces(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommoditynumberofpieces(void* lpObj, int commodityidx, int iCommodityNumberOfPieces);

int GetCommodityNumberOfPieces(int iCommodityIdx);
int SetCommodityNumberOfPieces(int iCommodityIdx, int iCommodityNumberOfPieces);

Default Value

1

Remarks

The total number of packages, cartons, or containers for the commodity line item.

In UPS, it is required and applicable to CO only.

In FedEx, if the Documents is set to False in ship request, the CommodityNumberOfPieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

This property is not applicable to USPS.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityQuantity Property (UPSShipIntl Class)

Number of units contained in this commodity line item measured in units specified by the QuantityUnit .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityQuantity(int iCommodityIdx);
int SetCommodityQuantity(int iCommodityIdx, int iCommodityQuantity);

Unicode (Windows)
INT GetCommodityQuantity(INT iCommodityIdx);
INT SetCommodityQuantity(INT iCommodityIdx, INT iCommodityQuantity);

int dshippingsdk_upsshipintl_getcommodityquantity(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityquantity(void* lpObj, int commodityidx, int iCommodityQuantity);

int GetCommodityQuantity(int iCommodityIdx);
int SetCommodityQuantity(int iCommodityIdx, int iCommodityQuantity);

Default Value

1

Remarks

Number of units contained in this commodity line item measured in units specified by the CommodityQuantityUnit. This is used in conjunction with the CommodityQuantityUnit and CommodityUnitPrice.

For FedEx, if the Documents is set to False in ship request, the CommodityQuantity is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

For UPS, these are all required for Invoice form type and optional for Partial Invoice (not applicable to other international form types).

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityQuantityUnit Property (UPSShipIntl Class)

Unit of measure used to express the Quantity of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityQuantityUnit(int iCommodityIdx);
int SetCommodityQuantityUnit(int iCommodityIdx, const char* lpszCommodityQuantityUnit);

Unicode (Windows)
LPWSTR GetCommodityQuantityUnit(INT iCommodityIdx);
INT SetCommodityQuantityUnit(INT iCommodityIdx, LPCWSTR lpszCommodityQuantityUnit);

char* dshippingsdk_upsshipintl_getcommodityquantityunit(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityquantityunit(void* lpObj, int commodityidx, const char* lpszCommodityQuantityUnit);

QString GetCommodityQuantityUnit(int iCommodityIdx);
int SetCommodityQuantityUnit(int iCommodityIdx, QString qsCommodityQuantityUnit);

Default Value

"EA"

Remarks

Unit of measure used to express the CommodityQuantity of this commodity line item.

For FedEx, if the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityQuantityUnit is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Here is a list of possible values for FedEx:

For UPS, this is required and applicable only to Invoice and Partial Invoice forms.

Here is a list of possible values for CommodityQuantityUnit:

This is not available for USPS.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityScheduleBCode Property (UPSShipIntl Class)

A unique 10-digit commodity classification code for the item being exported.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityScheduleBCode(int iCommodityIdx);
int SetCommodityScheduleBCode(int iCommodityIdx, const char* lpszCommodityScheduleBCode);

Unicode (Windows)
LPWSTR GetCommodityScheduleBCode(INT iCommodityIdx);
INT SetCommodityScheduleBCode(INT iCommodityIdx, LPCWSTR lpszCommodityScheduleBCode);

char* dshippingsdk_upsshipintl_getcommodityschedulebcode(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityschedulebcode(void* lpObj, int commodityidx, const char* lpszCommodityScheduleBCode);

QString GetCommodityScheduleBCode(int iCommodityIdx);
int SetCommodityScheduleBCode(int iCommodityIdx, QString qsCommodityScheduleBCode);

Default Value

""

Remarks

A unique 10-digit commodity classification code for the item being exported.

Before you can export a product from the United States, you must first determine its correct 10-digit Schedule B Classification Code. These codes are valid for only U.S. exports and are maintained by the U.S. Census Bureau. This is required to be provided in an international ship request only if SED is requested (i.e., one of the FormTypes is set to ftSED).

This property is only applicable to UPS shipments.

Current format: 10 digits.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityUnitPrice Property (UPSShipIntl Class)

Value of each QuantityUnit in Quantity of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityUnitPrice(int iCommodityIdx);
int SetCommodityUnitPrice(int iCommodityIdx, const char* lpszCommodityUnitPrice);

Unicode (Windows)
LPWSTR GetCommodityUnitPrice(INT iCommodityIdx);
INT SetCommodityUnitPrice(INT iCommodityIdx, LPCWSTR lpszCommodityUnitPrice);

char* dshippingsdk_upsshipintl_getcommodityunitprice(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityunitprice(void* lpObj, int commodityidx, const char* lpszCommodityUnitPrice);

QString GetCommodityUnitPrice(int iCommodityIdx);
int SetCommodityUnitPrice(int iCommodityIdx, QString qsCommodityUnitPrice);

Default Value

"1.00"

Remarks

Value of each CommodityQuantityUnit in CommodityQuantity of this commodity line item. This is used in conjunction with the CommodityQuantityUnit and CommodityQuantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

For FedEx, when the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityUnitPrice is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

For UPS, it is required and applicable to Invoice and Partial Invoice forms only.

For USPS, use the CommodityValue property instead.

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityValue Property (UPSShipIntl Class)

The value of an individual item being shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityValue(int iCommodityIdx);
int SetCommodityValue(int iCommodityIdx, const char* lpszCommodityValue);

Unicode (Windows)
LPWSTR GetCommodityValue(INT iCommodityIdx);
INT SetCommodityValue(INT iCommodityIdx, LPCWSTR lpszCommodityValue);

char* dshippingsdk_upsshipintl_getcommodityvalue(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityvalue(void* lpObj, int commodityidx, const char* lpszCommodityValue);

QString GetCommodityValue(int iCommodityIdx);
int SetCommodityValue(int iCommodityIdx, QString qsCommodityValue);

Default Value

""

Remarks

The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.

This property is only applicable to USPS and UPS freight.

Note: For USPS, the maximum value for this property is "99999.99".

Note: For UPS freight, the maximum value for this property is "99999999999999.99".

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityWeight Property (UPSShipIntl Class)

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityWeight(int iCommodityIdx);
int SetCommodityWeight(int iCommodityIdx, const char* lpszCommodityWeight);

Unicode (Windows)
LPWSTR GetCommodityWeight(INT iCommodityIdx);
INT SetCommodityWeight(INT iCommodityIdx, LPCWSTR lpszCommodityWeight);

char* dshippingsdk_upsshipintl_getcommodityweight(void* lpObj, int commodityidx);
int dshippingsdk_upsshipintl_setcommodityweight(void* lpObj, int commodityidx, const char* lpszCommodityWeight);

QString GetCommodityWeight(int iCommodityIdx);
int SetCommodityWeight(int iCommodityIdx, QString qsCommodityWeight);

Default Value

"0.00"

Remarks

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.

For FedEx, if the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityWeight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

For UPS, this is required and applicable to CO and SED forms only .

When using USPS and PostageProvider is set to ppNone, the format of this property must be "XX lbs YY oz", where XX is the number of pounds and YY is the number of ounces.

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).

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

DutiesPayorAccountNumber Property (UPSShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutiesPayorAccountNumber();
int SetDutiesPayorAccountNumber(const char* lpszDutiesPayorAccountNumber);

Unicode (Windows)
LPWSTR GetDutiesPayorAccountNumber();
INT SetDutiesPayorAccountNumber(LPCWSTR lpszDutiesPayorAccountNumber);

char* dshippingsdk_upsshipintl_getdutiespayoraccountnumber(void* lpObj);
int dshippingsdk_upsshipintl_setdutiespayoraccountnumber(void* lpObj, const char* lpszDutiesPayorAccountNumber);

QString GetDutiesPayorAccountNumber();
int SetDutiesPayorAccountNumber(QString qsDutiesPayorAccountNumber);

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 DutiesPayorPayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to DutiesPayorAccountNumber.

Data Type

String

DutiesPayorCountryCode Property (UPSShipIntl Class)

The country code for the payor of the shipment, or duties and taxes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutiesPayorCountryCode();
int SetDutiesPayorCountryCode(const char* lpszDutiesPayorCountryCode);

Unicode (Windows)
LPWSTR GetDutiesPayorCountryCode();
INT SetDutiesPayorCountryCode(LPCWSTR lpszDutiesPayorCountryCode);

char* dshippingsdk_upsshipintl_getdutiespayorcountrycode(void* lpObj);
int dshippingsdk_upsshipintl_setdutiespayorcountrycode(void* lpObj, const char* lpszDutiesPayorCountryCode);

QString GetDutiesPayorCountryCode();
int SetDutiesPayorCountryCode(QString qsDutiesPayorCountryCode);

Default Value

"US"

Remarks

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the DutiesPayorCountryCode is required to be provided in the ship request only if DutiesPayorPayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the DutiesPayorCountryCode is required only if DutiesPayorPayorType is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

Data Type

String

DutiesPayorType Property (UPSShipIntl Class)

Method of payment for shipment, or duties and taxes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDutiesPayorType();
int SetDutiesPayorType(int iDutiesPayorType);

Unicode (Windows)
INT GetDutiesPayorType();
INT SetDutiesPayorType(INT iDutiesPayorType);

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

int dshippingsdk_upsshipintl_getdutiespayortype(void* lpObj);
int dshippingsdk_upsshipintl_setdutiespayortype(void* lpObj, int iDutiesPayorType);

int GetDutiesPayorType();
int SetDutiesPayorType(int iDutiesPayorType);

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 DutiesPayorAccountNumber and DutiesPayorCountryCode 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 DutiesPayorAccountNumber is automatically set to UPSAccountNumber. When ptRecipient is specified, DutiesPayorAccountNumber and DutiesPayorZipCode 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 DutiesPayorAccountNumber, DutiesPayorZipCode and DutiesPayorCountryCode 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

DutiesPayorZipCode Property (UPSShipIntl Class)

Payor's postal code (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutiesPayorZipCode();
int SetDutiesPayorZipCode(const char* lpszDutiesPayorZipCode);

Unicode (Windows)
LPWSTR GetDutiesPayorZipCode();
INT SetDutiesPayorZipCode(LPCWSTR lpszDutiesPayorZipCode);

char* dshippingsdk_upsshipintl_getdutiespayorzipcode(void* lpObj);
int dshippingsdk_upsshipintl_setdutiespayorzipcode(void* lpObj, const char* lpszDutiesPayorZipCode);

QString GetDutiesPayorZipCode();
int SetDutiesPayorZipCode(QString qsDutiesPayorZipCode);

Default Value

""

Remarks

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS DutiesPayorAccountNumber'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 DutiesPayorPayorType is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

Data Type

String

FirewallAutoDetect Property (UPSShipIntl 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_upsshipintl_getfirewallautodetect(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getfirewalltype(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getfirewallhost(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getfirewallpassword(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getfirewallport(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl 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_upsshipintl_getfirewalluser(void* lpObj);
int dshippingsdk_upsshipintl_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

FormTypes Property (UPSShipIntl Class)

Contains the collection of types for international forms that can associate an international shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFormTypes();
int SetFormTypes(int iFormTypes);

Unicode (Windows)
INT GetFormTypes();
INT SetFormTypes(INT iFormTypes);

int dshippingsdk_upsshipintl_getformtypes(void* lpObj);
int dshippingsdk_upsshipintl_setformtypes(void* lpObj, int iFormTypes);

int GetFormTypes();
int SetFormTypes(int iFormTypes);

Default Value

0

Remarks

The FormTypes property is optional. Up to 6 international forms (such as Invoice, Shipper's Export Declaration, Certificate of Origin, NAFTA Certificate of Origin, etc.) can be requested within a ship request. To request any of the forms offered by UPS, you must set the FormTypes to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

For instance, to request both a Commercial Invoice and a CN22 you could set the property like below:

upsshipintl1.FormTypes = 0x00000011

Note: Invoice and Partial Invoice are mutually exclusive.

Data Type

Integer

InternationalForms Property (UPSShipIntl Class)

Image of the international forms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInternationalForms(char* &lpInternationalForms, int &lenInternationalForms);

Unicode (Windows)
INT GetInternationalForms(LPSTR &lpInternationalForms, INT &lenInternationalForms);

int dshippingsdk_upsshipintl_getinternationalforms(void* lpObj, char** lpInternationalForms, int* lenInternationalForms);

QByteArray GetInternationalForms();

Default Value

""

Remarks

This is the decoded binary image file of the international forms accompanying the shipment already requested via the FormTypes property (such as Invoice, SED, Certificate of Origin, etc.), stored in memory upon successful international ship response. If the InternationalFormsFile is set to a valid path and filename, the international forms are also saved to disk in PDF format.

This property is read-only.

Data Type

Binary String

InternationalFormsFile Property (UPSShipIntl Class)

Filename and location to save the InternationalForms to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInternationalFormsFile();
int SetInternationalFormsFile(const char* lpszInternationalFormsFile);

Unicode (Windows)
LPWSTR GetInternationalFormsFile();
INT SetInternationalFormsFile(LPCWSTR lpszInternationalFormsFile);

char* dshippingsdk_upsshipintl_getinternationalformsfile(void* lpObj);
int dshippingsdk_upsshipintl_setinternationalformsfile(void* lpObj, const char* lpszInternationalFormsFile);

QString GetInternationalFormsFile();
int SetInternationalFormsFile(QString qsInternationalFormsFile);

Default Value

""

Remarks

When the InternationalFormsFile is set to a valid path and filename, the contents of the InternationalForms are written to disk upon successful response.

The InternationalFormsFile has to have .pdf extension.

Data Type

String

LabelImageType Property (UPSShipIntl 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_upsshipintl_getlabelimagetype(void* lpObj);
int dshippingsdk_upsshipintl_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 (UPSShipIntl Class)

Tracking number assigned to the whole MPS shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMasterTrackingNumber();

Unicode (Windows)
LPWSTR GetMasterTrackingNumber();

char* dshippingsdk_upsshipintl_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

NAFTABlanketPeriod Property (UPSShipIntl Class)

Contains specific details on NAFTA CO (when this form is requested).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNAFTABlanketPeriod();
int SetNAFTABlanketPeriod(const char* lpszNAFTABlanketPeriod);

Unicode (Windows)
LPWSTR GetNAFTABlanketPeriod();
INT SetNAFTABlanketPeriod(LPCWSTR lpszNAFTABlanketPeriod);

char* dshippingsdk_upsshipintl_getnaftablanketperiod(void* lpObj);
int dshippingsdk_upsshipintl_setnaftablanketperiod(void* lpObj, const char* lpszNAFTABlanketPeriod);

QString GetNAFTABlanketPeriod();
int SetNAFTABlanketPeriod(QString qsNAFTABlanketPeriod);

Default Value

""

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if NAFTA CO international form is requested (i.e., one of the FormTypes is set to NAFTA).

This contains the begin date and the end date of the blanket period. The begin date is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). The end date is the date upon which the blanket period expires.

This is applicable and required to be provided in the request only if the NAFTA Certificate covers multiple shipments of identical goods as described in the ShipmentDescription that are imported into a NAFTA country for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between beginning and ending dates.

Format is: YYYYMMDD-YYYYMMDD

Data Type

String

NAFTAPreferenceCriteria Property (UPSShipIntl Class)

Preference Criteria for NAFTA Certificate of Origin documents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNAFTAPreferenceCriteria();
int SetNAFTAPreferenceCriteria(const char* lpszNAFTAPreferenceCriteria);

Unicode (Windows)
LPWSTR GetNAFTAPreferenceCriteria();
INT SetNAFTAPreferenceCriteria(LPCWSTR lpszNAFTAPreferenceCriteria);

char* dshippingsdk_upsshipintl_getnaftapreferencecriteria(void* lpObj);
int dshippingsdk_upsshipintl_setnaftapreferencecriteria(void* lpObj, const char* lpszNAFTAPreferenceCriteria);

QString GetNAFTAPreferenceCriteria();
int SetNAFTAPreferenceCriteria(QString qsNAFTAPreferenceCriteria);

Default Value

""

Remarks

This property is required when the FormTypes property includes the NAFTA flag. Valid values and their descriptions are listed from the UPS documentation:

Data Type

String

NAFTAProducerInfo Property (UPSShipIntl Class)

Producer information for NAFTA Certificate of Origin documents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNAFTAProducerInfo();
int SetNAFTAProducerInfo(int iNAFTAProducerInfo);

Unicode (Windows)
INT GetNAFTAProducerInfo();
INT SetNAFTAProducerInfo(INT iNAFTAProducerInfo);

PI_YES(0), 
PI_NO_1(1), 
PI_NO_2(2), 
PI_NO_3(3)

int dshippingsdk_upsshipintl_getnaftaproducerinfo(void* lpObj);
int dshippingsdk_upsshipintl_setnaftaproducerinfo(void* lpObj, int iNAFTAProducerInfo);

int GetNAFTAProducerInfo();
int SetNAFTAProducerInfo(int iNAFTAProducerInfo);