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.

Class Name

DShippingSDK_UPSShipIntl

Procedural Interface

 dshippingsdk_upsshipintl_open();
 dshippingsdk_upsshipintl_close($res);
 dshippingsdk_upsshipintl_register_callback($res, $id, $function);
 dshippingsdk_upsshipintl_get_last_error($res);
 dshippingsdk_upsshipintl_get_last_error_code($res);
 dshippingsdk_upsshipintl_set($res, $id, $index, $value);
 dshippingsdk_upsshipintl_get($res, $id, $index);
 dshippingsdk_upsshipintl_do_cancelpackage($res, $mastertrackingnumber, $packagetrackingnumber);
 dshippingsdk_upsshipintl_do_cancelpickup($res, $confirmationnumber);
 dshippingsdk_upsshipintl_do_cancelshipment($res, $mastertrackingnumber);
 dshippingsdk_upsshipintl_do_config($res, $configurationstring);
 dshippingsdk_upsshipintl_do_getshipmentlabels($res);
 dshippingsdk_upsshipintl_do_reset($res);
 dshippingsdk_upsshipintl_do_schedulepickup($res);

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 (DShippingSDK_UPSShipIntl Class)

Street name.

Object Oriented Interface

public function getAccountAddress1();


public function setAccountAddress1($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 1 );


dshippingsdk_upsshipintl_set($res, 1, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getAccountAddress2();


public function setAccountAddress2($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 2 );


dshippingsdk_upsshipintl_set($res, 2, $value );

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 (DShippingSDK_UPSShipIntl Class)

Name of city, town, etc.

Object Oriented Interface

public function getAccountCity();


public function setAccountCity($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 4 );


dshippingsdk_upsshipintl_set($res, 4, $value );

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 (DShippingSDK_UPSShipIntl Class)

Country code.

Object Oriented Interface

public function getAccountCountryCode();


public function setAccountCountryCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 5 );


dshippingsdk_upsshipintl_set($res, 5, $value );

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 (DShippingSDK_UPSShipIntl Class)

State or province code.

Object Oriented Interface

public function getAccountState();


public function setAccountState($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 6 );


dshippingsdk_upsshipintl_set($res, 6, $value );

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 (DShippingSDK_UPSShipIntl Class)

Postal code.

Object Oriented Interface

public function getAccountZipCode();


public function setAccountZipCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 7 );


dshippingsdk_upsshipintl_set($res, 7, $value );

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 (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getAccountCompany();


public function setAccountCompany($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 8 );


dshippingsdk_upsshipintl_set($res, 8, $value );

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 (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getAccountEmail();


public function setAccountEmail($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 9 );


dshippingsdk_upsshipintl_set($res, 9, $value );

Default Value

''

Remarks

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

Data Type

String

AccountFax Property (DShippingSDK_UPSShipIntl Class)

Recipient's fax number.

Object Oriented Interface

public function getAccountFax();


public function setAccountFax($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 10 );


dshippingsdk_upsshipintl_set($res, 10, $value );

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 (DShippingSDK_UPSShipIntl Class)

Sender's first name.

Object Oriented Interface

public function getAccountFirstName();


public function setAccountFirstName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 11 );


dshippingsdk_upsshipintl_set($res, 11, $value );

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 (DShippingSDK_UPSShipIntl Class)

Person's last name.

Object Oriented Interface

public function getAccountLastName();


public function setAccountLastName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 12 );


dshippingsdk_upsshipintl_set($res, 12, $value );

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 (DShippingSDK_UPSShipIntl Class)

Middle initial.

Object Oriented Interface

public function getAccountMiddleInitial();


public function setAccountMiddleInitial($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 13 );


dshippingsdk_upsshipintl_set($res, 13, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

AccountPhone Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getAccountPhone();


public function setAccountPhone($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 14 );


dshippingsdk_upsshipintl_set($res, 14, $value );

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 (DShippingSDK_UPSShipIntl Class)

Image of a COD Turn In Page.

Object Oriented Interface

public function getCODReport();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 15 );

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 (DShippingSDK_UPSShipIntl Class)

Filename and location to save the CODReport to.

Object Oriented Interface

public function getCODReportFile();


public function setCODReportFile($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 16 );


dshippingsdk_upsshipintl_set($res, 16, $value );

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 (DShippingSDK_UPSShipIntl Class)

The total amount to be collected on shipment level.

Object Oriented Interface

public function getCODTotalAmount();


public function setCODTotalAmount($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 17 );


dshippingsdk_upsshipintl_set($res, 17, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCODType();


public function setCODType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 18 );


dshippingsdk_upsshipintl_set($res, 18, $value );

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 (DShippingSDK_UPSShipIntl Class)

Commercial Invoice comments to be uploaded to customs.

Object Oriented Interface

public function getCommercialInvoiceComments();


public function setCommercialInvoiceComments($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 19 );


dshippingsdk_upsshipintl_set($res, 19, $value );

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 (DShippingSDK_UPSShipIntl Class)

Date when the Invoice is created.

Object Oriented Interface

public function getCommercialInvoiceDate();


public function setCommercialInvoiceDate($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 20 );


dshippingsdk_upsshipintl_set($res, 20, $value );

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 (DShippingSDK_UPSShipIntl Class)

Cost to transport the shipment.

Object Oriented Interface

public function getCommercialInvoiceFreightCharge();


public function setCommercialInvoiceFreightCharge($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 21 );


dshippingsdk_upsshipintl_set($res, 21, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommercialInvoiceInsurance();


public function setCommercialInvoiceInsurance($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 22 );


dshippingsdk_upsshipintl_set($res, 22, $value );

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 (DShippingSDK_UPSShipIntl Class)

Customer's assigned invoice number.

Object Oriented Interface

public function getCommercialInvoiceNumber();


public function setCommercialInvoiceNumber($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 23 );


dshippingsdk_upsshipintl_set($res, 23, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommercialInvoicePurpose();


public function setCommercialInvoicePurpose($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 24 );


dshippingsdk_upsshipintl_set($res, 24, $value );

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 (DShippingSDK_UPSShipIntl Class)

Indicates the rights to the seller from the buyer.

Object Oriented Interface

public function getCommercialInvoiceTerms();


public function setCommercialInvoiceTerms($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 25 );


dshippingsdk_upsshipintl_set($res, 25, $value );

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 (DShippingSDK_UPSShipIntl Class)

The number of records in the Commodity arrays.

Object Oriented Interface

public function getCommodityCount();


public function setCommodityCount($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 26 );


dshippingsdk_upsshipintl_set($res, 26, $value );

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 (DShippingSDK_UPSShipIntl Class)

Complete and accurate description of this commodity line item.

Object Oriented Interface

public function getCommodityDescription($commodityidx);


public function setCommodityDescription($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 27 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 27, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

Indicates the export type.

Object Oriented Interface

public function getCommodityExportType($commodityidx);


public function setCommodityExportType($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 28 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 28, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityHarmonizedCode($commodityidx);


public function setCommodityHarmonizedCode($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 34 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 34, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityManufacturer($commodityidx);


public function setCommodityManufacturer($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 35 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 35, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityNumberOfPieces($commodityidx);


public function setCommodityNumberOfPieces($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 36 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 36, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityQuantity($commodityidx);


public function setCommodityQuantity($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 39 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 39, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityQuantityUnit($commodityidx);


public function setCommodityQuantityUnit($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 40 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 40, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityScheduleBCode($commodityidx);


public function setCommodityScheduleBCode($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 41 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 41, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityUnitPrice($commodityidx);


public function setCommodityUnitPrice($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 42 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 42, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

The value of an individual item being shipped.

Object Oriented Interface

public function getCommodityValue($commodityidx);


public function setCommodityValue($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 43 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 43, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getCommodityWeight($commodityidx);


public function setCommodityWeight($commodityidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 44 , $commodityidx);


dshippingsdk_upsshipintl_set($res, 44, $value , $commodityidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getDutiesPayorAccountNumber();


public function setDutiesPayorAccountNumber($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 45 );


dshippingsdk_upsshipintl_set($res, 45, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getDutiesPayorCountryCode();


public function setDutiesPayorCountryCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 49 );


dshippingsdk_upsshipintl_set($res, 49, $value );

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 (DShippingSDK_UPSShipIntl Class)

Method of payment for shipment, or duties and taxes.

Object Oriented Interface

public function getDutiesPayorType();


public function setDutiesPayorType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 51 );


dshippingsdk_upsshipintl_set($res, 51, $value );

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 (DShippingSDK_UPSShipIntl Class)

Payor's postal code (if applicable).

Object Oriented Interface

public function getDutiesPayorZipCode();


public function setDutiesPayorZipCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 53 );


dshippingsdk_upsshipintl_set($res, 53, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 54 );


dshippingsdk_upsshipintl_set($res, 54, $value );

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 (DShippingSDK_UPSShipIntl Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 55 );


dshippingsdk_upsshipintl_set($res, 55, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 56 );


dshippingsdk_upsshipintl_set($res, 56, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 57 );


dshippingsdk_upsshipintl_set($res, 57, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 58 );


dshippingsdk_upsshipintl_set($res, 58, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 59 );


dshippingsdk_upsshipintl_set($res, 59, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getFormTypes();


public function setFormTypes($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 60 );


dshippingsdk_upsshipintl_set($res, 60, $value );

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 (DShippingSDK_UPSShipIntl Class)

Image of the international forms.

Object Oriented Interface

public function getInternationalForms();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 61 );

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 (DShippingSDK_UPSShipIntl Class)

Filename and location to save the InternationalForms to.

Object Oriented Interface

public function getInternationalFormsFile();


public function setInternationalFormsFile($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 62 );


dshippingsdk_upsshipintl_set($res, 62, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getLabelImageType();


public function setLabelImageType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 63 );


dshippingsdk_upsshipintl_set($res, 63, $value );

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 (DShippingSDK_UPSShipIntl Class)

Tracking number assigned to the whole MPS shipment.

Object Oriented Interface

public function getMasterTrackingNumber();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 64 );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getNAFTABlanketPeriod();


public function setNAFTABlanketPeriod($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 65 );


dshippingsdk_upsshipintl_set($res, 65, $value );

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 (DShippingSDK_UPSShipIntl Class)

Preference Criteria for NAFTA Certificate of Origin documents.

Object Oriented Interface

public function getNAFTAPreferenceCriteria();


public function setNAFTAPreferenceCriteria($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 66 );


dshippingsdk_upsshipintl_set($res, 66, $value );

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 (DShippingSDK_UPSShipIntl Class)

Producer information for NAFTA Certificate of Origin documents.

Object Oriented Interface

public function getNAFTAProducerInfo();


public function setNAFTAProducerInfo($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 67 );


dshippingsdk_upsshipintl_set($res, 67, $value );

Default Value

0

Remarks

This property is required when the FormTypes property includes the NAFTA flag.

From UPS documentation, specify: piYes - If shipper is the producer of the good. If not, state No depending on whether this certificate was based upon: piNo1 - Knowledge of whether the good qualifies as an originating good. piNo2 - Reliance on the producer's written representation (other than a Certificate of Origin) that the good qualifies as an originating good. piNo3 - A completed and signed Certificate for the good voluntarily provided to the exporter by the producer.

Data Type

Integer

NotifyCount Property (DShippingSDK_UPSShipIntl Class)

The number of records in the Notify arrays.

Object Oriented Interface

public function getNotifyCount();


public function setNotifyCount($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 68 );


dshippingsdk_upsshipintl_set($res, 68, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getNotifyAggregate($notifyidx);


public function setNotifyAggregate($notifyidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 69 , $notifyidx);


dshippingsdk_upsshipintl_set($res, 69, $value , $notifyidx);

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

The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients field can have up to 6 recipient emails).

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 (DShippingSDK_UPSShipIntl Class)

Email address of the recipient to be notified.

Object Oriented Interface

public function getNotifyEmail($notifyidx);


public function setNotifyEmail($notifyidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 70 , $notifyidx);


dshippingsdk_upsshipintl_set($res, 70, $value , $notifyidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getNotifyMessage($notifyidx);


public function setNotifyMessage($notifyidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 71 , $notifyidx);


dshippingsdk_upsshipintl_set($res, 71, $value , $notifyidx);

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 (DShippingSDK_UPSShipIntl Class)

Identifies the type of notification requested.

Object Oriented Interface

public function getNotifyFlags($notifyidx);


public function setNotifyFlags($notifyidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 73 , $notifyidx);


dshippingsdk_upsshipintl_set($res, 73, $value , $notifyidx);

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

To use Estimated Delivery with FedEx, the APIVersion configuration setting must be set to 19 or higher.

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 (DShippingSDK_UPSShipIntl Class)

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 75 );


dshippingsdk_upsshipintl_set($res, 75, $value );

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 (DShippingSDK_UPSShipIntl Class)

Actual Base Charge applicable to this package.

Object Oriented Interface

public function getPackageBaseCharge($packageidx);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 76 , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

The COD monetary value for the package.

Object Oriented Interface

public function getPackageCODAmount($packageidx);


public function setPackageCODAmount($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 77 , $packageidx);


dshippingsdk_upsshipintl_set($res, 77, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageCODType($packageidx);


public function setPackageCODType($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 80 , $packageidx);


dshippingsdk_upsshipintl_set($res, 80, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageDescription($packageidx);


public function setPackageDescription($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 83 , $packageidx);


dshippingsdk_upsshipintl_set($res, 83, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 85 , $packageidx);


dshippingsdk_upsshipintl_set($res, 85, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

An 8-digit Unique Parcel Identification Number.

Object Oriented Interface

public function getPackageId($packageidx);


public function setPackageId($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 86 , $packageidx);


dshippingsdk_upsshipintl_set($res, 86, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 87 , $packageidx);


dshippingsdk_upsshipintl_set($res, 87, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 88 , $packageidx);


dshippingsdk_upsshipintl_set($res, 88, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageType($packageidx);


public function setPackageType($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 90 , $packageidx);


dshippingsdk_upsshipintl_set($res, 90, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageReference($packageidx);


public function setPackageReference($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 92 , $packageidx);


dshippingsdk_upsshipintl_set($res, 92, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

Image of the receipt for a return shipment.

Object Oriented Interface

public function getPackageReturnReceipt($packageidx);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 93 , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageReturnReceiptFile($packageidx);


public function setPackageReturnReceiptFile($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 94 , $packageidx);


dshippingsdk_upsshipintl_set($res, 94, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageShippingLabel($packageidx);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 95 , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageShippingLabelFile($packageidx);


public function setPackageShippingLabelFile($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 96 , $packageidx);


dshippingsdk_upsshipintl_set($res, 96, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageSignatureType($packageidx);


public function setPackageSignatureType($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 98 , $packageidx);


dshippingsdk_upsshipintl_set($res, 98, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPackageSpecialServices($packageidx);


public function setPackageSpecialServices($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 100 , $packageidx);


dshippingsdk_upsshipintl_set($res, 100, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

Total Actual Surcharges applicable to this package.

Object Oriented Interface

public function getPackageTotalSurcharges($packageidx);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 102 , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

Tracking number assigned to this package.

Object Oriented Interface

public function getPackageTrackingNumber($packageidx);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 103 , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 104 , $packageidx);


dshippingsdk_upsshipintl_set($res, 104, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 105 , $packageidx);


dshippingsdk_upsshipintl_set($res, 105, $value , $packageidx);

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPayorAccountNumber();


public function setPayorAccountNumber($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 106 );


dshippingsdk_upsshipintl_set($res, 106, $value );

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

PayorCountryCode Property (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPayorCountryCode();


public function setPayorCountryCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 110 );


dshippingsdk_upsshipintl_set($res, 110, $value );

Default Value

'US'

Remarks

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

When shipping via FedEx Express, the PayorCountryCode is required to be provided in the ship request only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the PayorCountryCode is required only if PayorType 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

PayorType Property (DShippingSDK_UPSShipIntl Class)

Method of payment for shipment, or duties and taxes.

Object Oriented Interface

public function getPayorType();


public function setPayorType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 112 );


dshippingsdk_upsshipintl_set($res, 112, $value );

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 (DShippingSDK_UPSShipIntl Class)

Payor's postal code (if applicable).

Object Oriented Interface

public function getPayorZipCode();


public function setPayorZipCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 114 );


dshippingsdk_upsshipintl_set($res, 114, $value );

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

PickupEarliestTime Property (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getPickupEarliestTime();


public function setPickupEarliestTime($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 115 );


dshippingsdk_upsshipintl_set($res, 115, $value );

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 (DShippingSDK_UPSShipIntl Class)

The latest time a shipment can be picked up.

Object Oriented Interface

public function getPickupLatestTime();


public function setPickupLatestTime($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 116 );


dshippingsdk_upsshipintl_set($res, 116, $value );

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

ProxyAuthScheme Property (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 117 );


dshippingsdk_upsshipintl_set($res, 117, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 118 );


dshippingsdk_upsshipintl_set($res, 118, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 119 );


dshippingsdk_upsshipintl_set($res, 119, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 120 );


dshippingsdk_upsshipintl_set($res, 120, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 121 );


dshippingsdk_upsshipintl_set($res, 121, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 122 );


dshippingsdk_upsshipintl_set($res, 122, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 123 );


dshippingsdk_upsshipintl_set($res, 123, $value );

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 (DShippingSDK_UPSShipIntl Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 124 );


dshippingsdk_upsshipintl_set($res, 124, $value );

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 (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getRecipientAddress2();


public function setRecipientAddress2($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 125 );


dshippingsdk_upsshipintl_set($res, 125, $value );

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 (DShippingSDK_UPSShipIntl Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getRecipientAddressFlags();


public function setRecipientAddressFlags($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 126 );


dshippingsdk_upsshipintl_set($res, 126, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (DShippingSDK_UPSShipIntl Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 127 );


dshippingsdk_upsshipintl_set($res, 127, $value );

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 (DShippingSDK_UPSShipIntl Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 128 );


dshippingsdk_upsshipintl_set($res, 128, $value );

Default Value

'US'

Remarks

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

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

* Not supported by USPS

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

Data Type

String

RecipientState Property (DShippingSDK_UPSShipIntl Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 129 );


dshippingsdk_upsshipintl_set($res, 129, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientZipCode Property (DShippingSDK_UPSShipIntl Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 130 );


dshippingsdk_upsshipintl_set($res, 130, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

RecipientCompany Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getRecipientCompany();


public function setRecipientCompany($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 131 );


dshippingsdk_upsshipintl_set($res, 131, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientEmail Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getRecipientEmail();


public function setRecipientEmail($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 132 );


dshippingsdk_upsshipintl_set($res, 132, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientFax Property (DShippingSDK_UPSShipIntl Class)

Recipient's fax number.

Object Oriented Interface

public function getRecipientFax();


public function setRecipientFax($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 133 );


dshippingsdk_upsshipintl_set($res, 133, $value );

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

RecipientFirstName Property (DShippingSDK_UPSShipIntl Class)

Sender's first name.

Object Oriented Interface

public function getRecipientFirstName();


public function setRecipientFirstName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 134 );


dshippingsdk_upsshipintl_set($res, 134, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either RecipientFirstName and RecipientLastName or RecipientCompany must be sent.

Data Type

String

RecipientLastName Property (DShippingSDK_UPSShipIntl Class)

Person's last name.

Object Oriented Interface

public function getRecipientLastName();


public function setRecipientLastName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 135 );


dshippingsdk_upsshipintl_set($res, 135, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientMiddleInitial Property (DShippingSDK_UPSShipIntl Class)

Middle initial.

Object Oriented Interface

public function getRecipientMiddleInitial();


public function setRecipientMiddleInitial($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 136 );


dshippingsdk_upsshipintl_set($res, 136, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getRecipientPhone();


public function setRecipientPhone($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 137 );


dshippingsdk_upsshipintl_set($res, 137, $value );

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

SEDECCNNumber Property (DShippingSDK_UPSShipIntl Class)

Export Control Classification Number.

Object Oriented Interface

public function getSEDECCNNumber();


public function setSEDECCNNumber($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 138 );


dshippingsdk_upsshipintl_set($res, 138, $value );

Default Value

''

Remarks

Export Control Classification Number. This number identifies categories, product groups, strategic level of control, and country groups. Some products have an ECCN number.

This is required for SED forms only when the SEDExceptionCode is set to one of the following values: CIV, CTP, ENC, KMI, LVS.

Required length: 8 characters.

Data Type

String

SEDEntryNumber Property (DShippingSDK_UPSShipIntl Class)

The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks).

Object Oriented Interface

public function getSEDEntryNumber();


public function setSEDEntryNumber($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 139 );


dshippingsdk_upsshipintl_set($res, 139, $value );

Default Value

''

Remarks

The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks).

This is required for SED forms only if the SEDInBondCode is set to a value other than 0 (ibcNotInBond).

Maximum length: 25.

Data Type

String

SEDExceptionCode Property (DShippingSDK_UPSShipIntl Class)

License exception code.

Object Oriented Interface

public function getSEDExceptionCode();


public function setSEDExceptionCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 140 );


dshippingsdk_upsshipintl_set($res, 140, $value );

Default Value

0

Remarks

License exception code.

If this is set to 0 (ecUnspecified), then the SEDLicenseNumber and the SEDLicenseDate are required to be provided in the request. SEDLicenseNumber and SEDExceptionCode are mutually exclusive.

Valid values are:

Data Type

Integer

SEDFiledByUPS Property (DShippingSDK_UPSShipIntl Class)

Indicates whether or not UPS will file SED on shipper's behalf.

Object Oriented Interface

public function getSEDFiledByUPS();


public function setSEDFiledByUPS($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 141 );


dshippingsdk_upsshipintl_set($res, 141, $value );

Default Value

false

Remarks

Indicates whether or not UPS will file SED on shipper's behalf. This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set).

If False (default value), it indicates that SED will be filed by the shipper, not UPS. If True, it indicates that UPS will file SED on shipper's behalf.

Data Type

Boolean

SEDInBondCode Property (DShippingSDK_UPSShipIntl Class)

Indicates whether the shipment is being transported under bond.

Object Oriented Interface

public function getSEDInBondCode();


public function setSEDInBondCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 142 );


dshippingsdk_upsshipintl_set($res, 142, $value );

Default Value

0

Remarks

Indicates whether the shipment is being transported under bond.

This is required when SED form is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set).

Valid values are:

When SEDInBondCode is set to a value other than ibcNotInBond, the SEDEntryNumber is required to be provided in the request.

Data Type

Integer

SEDLicenseDate Property (DShippingSDK_UPSShipIntl Class)

License date.

Object Oriented Interface

public function getSEDLicenseDate();


public function setSEDLicenseDate($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 143 );


dshippingsdk_upsshipintl_set($res, 143, $value );

Default Value

''

Remarks

License date.

This is required for SED forms only if the SEDLicenseNumber is provided in the request.

Format: YYYYMMDD

Data Type

String

SEDLicenseNumber Property (DShippingSDK_UPSShipIntl Class)

The license number that authorizes ship product.

Object Oriented Interface

public function getSEDLicenseNumber();


public function setSEDLicenseNumber($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 144 );


dshippingsdk_upsshipintl_set($res, 144, $value );

Default Value

''

Remarks

The license number that authorizes ship product.

This is required for SED forms only if the SEDExceptionCode is not provided in the request. SEDLicenseNumber and SEDExceptionCode are mutually exclusive. If the product is not licensable, a valid SEDExceptionCode needs to be entered. If shipping different products that are covered under different licenses or license exceptions, then separate SEDs must be created.

Maximum length: 35.

Data Type

String

SEDPointOfOrigin Property (DShippingSDK_UPSShipIntl Class)

Indicates the state or zone number from where the exports are leaving.

Object Oriented Interface

public function getSEDPointOfOrigin();


public function setSEDPointOfOrigin($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 145 );


dshippingsdk_upsshipintl_set($res, 145, $value );

Default Value

''

Remarks

Indicates the state or zone number from where the exports are leaving.

This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set). This should contain one of the following:

• The two-digit U.S. Postal Service abbreviation for the state from which the goods were shipped to the port of export.
• The state that is the source for the good with the highest value. The state of consolidation.
• The Foreign Trade Zone number of the zone from where the exports are leaving. If the goods were shipped from Puerto Rico, enter PR.

Maximum length: 5.

Data Type

String

SEDShipperTaxId Property (DShippingSDK_UPSShipIntl Class)

Shipper's Tax Identification Number.

Object Oriented Interface

public function getSEDShipperTaxId();


public function setSEDShipperTaxId($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 146 );


dshippingsdk_upsshipintl_set($res, 146, $value );

Default Value

''

Remarks

Shipper's Tax Identification Number.

This is required for SED forms only.

Maximum length: 15 characters.

Data Type

String

SEDTransportType Property (DShippingSDK_UPSShipIntl Class)

Indicates the type of transport by which the goods are exported.

Object Oriented Interface

public function getSEDTransportType();


public function setSEDTransportType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 147 );


dshippingsdk_upsshipintl_set($res, 147, $value );

Default Value

'Air'

Remarks

Indicates the type of transport by which the goods are exported.

This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set).

Possible values: Air, AirContainerized, Auto FixedTransportInstallations Mail, PassengerHandcarried Pedestrian, Rail, RailContainerized, RoadOther, SeaBarge, SeaContainerized SeaNoncontainerized, Truck, TruckContainerized.

Data Type

String

SenderAddress1 Property (DShippingSDK_UPSShipIntl Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 148 );


dshippingsdk_upsshipintl_set($res, 148, $value );

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

Data Type

String

SenderAddress2 Property (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getSenderAddress2();


public function setSenderAddress2($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 149 );


dshippingsdk_upsshipintl_set($res, 149, $value );

Default Value

''

Remarks

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

Data Type

String

SenderCity Property (DShippingSDK_UPSShipIntl Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 151 );


dshippingsdk_upsshipintl_set($res, 151, $value );

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

SenderCountryCode Property (DShippingSDK_UPSShipIntl Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 152 );


dshippingsdk_upsshipintl_set($res, 152, $value );

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

SenderState Property (DShippingSDK_UPSShipIntl Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 153 );


dshippingsdk_upsshipintl_set($res, 153, $value );

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

SenderZipCode Property (DShippingSDK_UPSShipIntl Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 154 );


dshippingsdk_upsshipintl_set($res, 154, $value );

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 SenderCity and SenderState are not present.

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

Data Type

String

SenderCompany Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getSenderCompany();


public function setSenderCompany($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 155 );


dshippingsdk_upsshipintl_set($res, 155, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either SenderFirstName and SenderLastName or SenderCompany are required to be provided.

Data Type

String

SenderEmail Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getSenderEmail();


public function setSenderEmail($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 156 );


dshippingsdk_upsshipintl_set($res, 156, $value );

Default Value

''

Remarks

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

Data Type

String

SenderFax Property (DShippingSDK_UPSShipIntl Class)

Recipient's fax number.

Object Oriented Interface

public function getSenderFax();


public function setSenderFax($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 157 );


dshippingsdk_upsshipintl_set($res, 157, $value );

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

SenderFirstName Property (DShippingSDK_UPSShipIntl Class)

Sender's first name.

Object Oriented Interface

public function getSenderFirstName();


public function setSenderFirstName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 158 );


dshippingsdk_upsshipintl_set($res, 158, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent.

Data Type

String

SenderLastName Property (DShippingSDK_UPSShipIntl Class)

Person's last name.

Object Oriented Interface

public function getSenderLastName();


public function setSenderLastName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 159 );


dshippingsdk_upsshipintl_set($res, 159, $value );

Default Value

''

Remarks

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

Data Type

String

SenderMiddleInitial Property (DShippingSDK_UPSShipIntl Class)

Middle initial.

Object Oriented Interface

public function getSenderMiddleInitial();


public function setSenderMiddleInitial($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 160 );


dshippingsdk_upsshipintl_set($res, 160, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getSenderPhone();


public function setSenderPhone($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 161 );


dshippingsdk_upsshipintl_set($res, 161, $value );

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

ServiceType Property (DShippingSDK_UPSShipIntl Class)

Identifies the UPS service type (applicable to international shipments) to use in a ship request.

Object Oriented Interface

public function getServiceType();


public function setServiceType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 162 );


dshippingsdk_upsshipintl_set($res, 162, $value );

Default Value

0

Remarks

This property is required to be provided in a ship request when the GetShipmentLabels method is called.

Note that the availability and the description of UPS services depend on the country of origin. Possible values of ServiceType and their corresponding availability to each group country origin are listed below:

This property is not available at design time.

Data Type

Integer

ShipDate Property (DShippingSDK_UPSShipIntl Class)

The date the user requests UPS to pickup the package from the origin.

Object Oriented Interface

public function getShipDate();


public function setShipDate($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 163 );


dshippingsdk_upsshipintl_set($res, 163, $value );

Default Value

''

Remarks

This is required to be provided in a ship request only if UPS On-Call Pickup service is requested (i.e., when the corresponding flag for On-Call Pickup (0x01000000) is present in ShipmentSpecialServices). This date should not be a past date or a date more than 10 days in the future. If not provided, then it defaults to the current date.

This should be entered in this format: YYYYMMDD.

Note: It is not valid if this pickup date is the same day for shipment(s) going from Germany to Germany using UPS Standard service. Error 129090 will be returned in this case.

Data Type

String

ShipmentDescription Property (DShippingSDK_UPSShipIntl Class)

A textual description of goods for the whole shipment.

Object Oriented Interface

public function getShipmentDescription();


public function setShipmentDescription($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 164 );


dshippingsdk_upsshipintl_set($res, 164, $value );

Default Value

''

Remarks

This is applicable to international shipments only. Provide a detailed description of items being shipped for documents and non-documents, such as 'annual reports', '9 mm steel screws', etc..

This is required to be provided in a ship request if all of the listed conditions are true:

• the SenderCountryCode and RecipientCountryCode are not the same;
• the SenderCountryCode and/or RecipientCountryCode are not in the European Union; or the SenderCountryCode and RecipientCountryCode are both in the European Union; and ServiceType is not 'UPS Standard'.
• the packaging type of any packages contained in the shipment is not 'UPS Letter';

Maximum length: 35 characters.

Data Type

String

ShipmentReference Property (DShippingSDK_UPSShipIntl Class)

Customer-defined number (that may or may not be unique) used to identify the whole shipment.

Object Oriented Interface

public function getShipmentReference();


public function setShipmentReference($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 165 );


dshippingsdk_upsshipintl_set($res, 165, $value );

Default Value

''

Remarks

This is applicable to international shipments only. Valid if the origin/destination pair is not US/US or PR/PR.

This is optional to be provided in a ship request (when the GetShipmentLabels method is called). You can enter up to two customer references on shipment 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 shipment, the ShipmentReference 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 shipment by reference.

Data Type

String

ShipmentSpecialServices Property (DShippingSDK_UPSShipIntl Class)

Contains the collection of special services offered by UPS on shipment level.

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 166 );


dshippingsdk_upsshipintl_set($res, 166, $value );

Default Value

0

Remarks

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

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

• Hold for Pickup: This indicates that UPS should deliver your package to the UPS Customer Center you choose and then call the recipient when the package is ready.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Dropoff: This requests that UPs provide their liftgate services unload a shipment when unloading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Pickup: This requests that UPs provide their liftgate services load a shipment when loading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Return Shipment: This is applicable to return shipments only. Indicates that the ship request is made for Print Return Label (PRL). With this option you can print a return label to include in an outbound shipment, or provide a label to your customer separately.

  If you want to arrange for UPS to mail a return label to your customer, you can use the ReturnPrintAndMail config setting.

  If you want to arrange for UPS to email a return label to your customer, you can use the ElectronicReturnLabel config setting.

  If you want to arrange for UPS to make one attempt to pick up the package to be returned, you can use the ReturnServiceFirstAttempt config setting.

  If you want to arrange for UPS to make three attempts to pick up the package to be returned, you can use the ReturnServiceThirdAttempt config setting.

  Using the last 4 options: in the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.

  For return shipments, one of the following conditions must be met on AccountCountryCode, SenderCountryCode and RecipientCountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The PackageDescription is required to be provided in the request for each package contained in the shipment. The PackageType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only.

  Also please note that when you set this option that only the return label is being printed, you must submit a separate request to print the shipping label.

• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is not available for return shipments.
• Saturday Pickup: The presence indicates Saturdary pickup is requested. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair.
• Return of Document: This may also be referred to as the Return of Invoice service and is unique to Poland. If set UPS will use their Return of Document service to return the signed invoice to the shipper.
• Commercial Invoice Removal: When set this will indicate that the commercial invoice should be removed before delivery, thus not revealing the value of the contents to the recipient.
• Carbon Neutral: This is required to make a shipment that is carbon neutral.
• Exchange Forward: This is required in order to make exchange forward shipments.
• Dropoff at UPS Facility: When set this indicates that the package will be dropped off at a UPS Facility.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Deliver To Addressee Only: When set this requires that the addressee be the one who takes final delivery of the package being held at a UPS Access Point

  This accessorial is only valid when ShipmentIndicationType is set to 1.

• Direct Delivery Only: When set this will ensure that the package is delivered to the ShipTo address on the shipping label.

  This accessorial is not valid when ShipmentIndicationType is set.

Data Type

Long64

ShipmentVoidStatus Property (DShippingSDK_UPSShipIntl Class)

Status description of shipment void request.

Object Oriented Interface

public function getShipmentVoidStatus();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 167 );

Default Value

''

Remarks

Upon successful response, this is populated when the CancelShipment or CancelPackage method is called.

This property is read-only.

Data Type

String

SoldToAddress1 Property (DShippingSDK_UPSShipIntl Class)

Street name.

Object Oriented Interface

public function getSoldToAddress1();


public function setSoldToAddress1($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 168 );


dshippingsdk_upsshipintl_set($res, 168, $value );

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

Data Type

String

SoldToAddress2 Property (DShippingSDK_UPSShipIntl Class)

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

Object Oriented Interface

public function getSoldToAddress2();


public function setSoldToAddress2($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 169 );


dshippingsdk_upsshipintl_set($res, 169, $value );

Default Value

''

Remarks

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

Data Type

String

SoldToCity Property (DShippingSDK_UPSShipIntl Class)

Name of city, town, etc.

Object Oriented Interface

public function getSoldToCity();


public function setSoldToCity($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 171 );


dshippingsdk_upsshipintl_set($res, 171, $value );

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

SoldToCountryCode Property (DShippingSDK_UPSShipIntl Class)

Country code.

Object Oriented Interface

public function getSoldToCountryCode();


public function setSoldToCountryCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 172 );


dshippingsdk_upsshipintl_set($res, 172, $value );

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

SoldToState Property (DShippingSDK_UPSShipIntl Class)

State or province code.

Object Oriented Interface

public function getSoldToState();


public function setSoldToState($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 173 );


dshippingsdk_upsshipintl_set($res, 173, $value );

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

SoldToZipCode Property (DShippingSDK_UPSShipIntl Class)

Postal code.

Object Oriented Interface

public function getSoldToZipCode();


public function setSoldToZipCode($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 174 );


dshippingsdk_upsshipintl_set($res, 174, $value );

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 SoldToCity and SoldToState are not present.

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

Data Type

String

SoldToCompany Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getSoldToCompany();


public function setSoldToCompany($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 175 );


dshippingsdk_upsshipintl_set($res, 175, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either SoldToFirstName and SoldToLastName or SoldToCompany are required to be provided.

Data Type

String

SoldToEmail Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getSoldToEmail();


public function setSoldToEmail($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 176 );


dshippingsdk_upsshipintl_set($res, 176, $value );

Default Value

''

Remarks

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

Data Type

String

SoldToFax Property (DShippingSDK_UPSShipIntl Class)

Recipient's fax number.

Object Oriented Interface

public function getSoldToFax();


public function setSoldToFax($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 177 );


dshippingsdk_upsshipintl_set($res, 177, $value );

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

SoldToFirstName Property (DShippingSDK_UPSShipIntl Class)

Sender's first name.

Object Oriented Interface

public function getSoldToFirstName();


public function setSoldToFirstName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 178 );


dshippingsdk_upsshipintl_set($res, 178, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either SoldToFirstName and SoldToLastName or SoldToCompany must be sent.

Data Type

String

SoldToLastName Property (DShippingSDK_UPSShipIntl Class)

Person's last name.

Object Oriented Interface

public function getSoldToLastName();


public function setSoldToLastName($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 179 );


dshippingsdk_upsshipintl_set($res, 179, $value );

Default Value

''

Remarks

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

Data Type

String

SoldToMiddleInitial Property (DShippingSDK_UPSShipIntl Class)

Middle initial.

Object Oriented Interface

public function getSoldToMiddleInitial();


public function setSoldToMiddleInitial($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 180 );


dshippingsdk_upsshipintl_set($res, 180, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SoldToPhone Property (DShippingSDK_UPSShipIntl Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getSoldToPhone();


public function setSoldToPhone($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 181 );


dshippingsdk_upsshipintl_set($res, 181, $value );

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

SSLAcceptServerCertEncoded Property (DShippingSDK_UPSShipIntl Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 183 );


dshippingsdk_upsshipintl_set($res, 183, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DShippingSDK_UPSShipIntl Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 211 );


dshippingsdk_upsshipintl_set($res, 211, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DShippingSDK_UPSShipIntl Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 227 );


dshippingsdk_upsshipintl_set($res, 227, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_UPSShipIntl Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 228 );


dshippingsdk_upsshipintl_set($res, 228, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (DShippingSDK_UPSShipIntl Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 229 );


dshippingsdk_upsshipintl_set($res, 229, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (DShippingSDK_UPSShipIntl Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 230 );


dshippingsdk_upsshipintl_set($res, 230, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (DShippingSDK_UPSShipIntl Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 238 );


dshippingsdk_upsshipintl_set($res, 238, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DShippingSDK_UPSShipIntl Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 240 );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (DShippingSDK_UPSShipIntl Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 267 );


dshippingsdk_upsshipintl_set($res, 267, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalBaseCharge Property (DShippingSDK_UPSShipIntl Class)

The total base charge applied to the whole shipment (specific to the AccountNumber ).

Object Oriented Interface

public function getTotalBaseCharge();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 268 );

Default Value

''

Remarks

In a MPS ship request, this represents the total base charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackageBaseCharge at index=0.

This property is read-only.

Data Type

String

TotalCustomsValue Property (DShippingSDK_UPSShipIntl Class)

Total customs value for the shipment.

Object Oriented Interface

public function getTotalCustomsValue();


public function setTotalCustomsValue($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 269 );


dshippingsdk_upsshipintl_set($res, 269, $value );

Default Value

'1'

Remarks

The TotalCustomsValue is required to be provided in an international shipment request only if the following requirements are met:

• the SenderCountryCode is US;
• the RecipientCountryCode is either CA (Canada) or PR (PuertoRico);
• the shipment does not contain any package of UPS Letter type;

If Commercial Invoice is requested (i.e., one of the FormTypes is set to Invoice), this value should match the invoice line total on the invoice form. If not it will be replaced by the actual calculated invoice line total. It represents the sum of the values of all commodities included in the shipment.

Format: Whole number, no decimal position (e.g. 100) with maximum length of 8 digits. Possible values: 1 to 99999999.

Data Type

String

TotalNetCharge Property (DShippingSDK_UPSShipIntl Class)

The total net charge (transportation charge + options charges) applied to the whole shipment (specific to the AccountNumber ).

Object Oriented Interface

public function getTotalNetCharge();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 270 );

Default Value

''

Remarks

In a MPS ship request, this represents the total net charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackageNetCharge at index=0.

This property is read-only.

Data Type

String

TotalSurcharges Property (DShippingSDK_UPSShipIntl Class)

The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).

Object Oriented Interface

public function getTotalSurcharges();

Procedural Interface

dshippingsdk_upsshipintl_get($res, 271 );

Default Value

''

Remarks

In a MPS ship request, this represents the total surcharges applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackageTotalSurcharges at index=0.

This property is read-only.

Data Type

String

UPSAccountNumber Property (DShippingSDK_UPSShipIntl Class)

The shipper's UPS account number.

Object Oriented Interface

public function getUPSAccountNumber();


public function setUPSAccountNumber($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 272 );


dshippingsdk_upsshipintl_set($res, 272, $value );

Default Value

''

Remarks

The shipper's UPS account number.

This property describes the shipper's 6- or 10- digit UPS account number.

Data Type

String

UPSAuthorizationToken Property (DShippingSDK_UPSShipIntl Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getUPSAuthorizationToken();


public function setUPSAuthorizationToken($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 273 );


dshippingsdk_upsshipintl_set($res, 273, $value );

Default Value

''

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

UPSServer Property (DShippingSDK_UPSShipIntl Class)

URL for the UPS server where the requests are sent.

Object Oriented Interface

public function getUPSServer();


public function setUPSServer($value);

Procedural Interface

dshippingsdk_upsshipintl_get($res, 274 );


dshippingsdk_upsshipintl_set($res, 274, $value );

Default Value

''

Remarks

URL for the UPS server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

The following URLs may be used for testing:

Data Type

String

CancelPackage Method (DShippingSDK_UPSShipIntl Class)

Cancels a single package by deleting it from the shipping log.

Object Oriented Interface

public function doCancelPackage($mastertrackingnumber, $packagetrackingnumber);

Procedural Interface

dshippingsdk_upsshipintl_do_cancelpackage($res, $mastertrackingnumber, $packagetrackingnumber);

Remarks

To cancel shipment of a single package, a void shipment request should be sent to UPS UPSServer by calling the CancelPackage method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the UPSServer to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the UPSServer should be sent to the URL provided as part of the certification process.

The TrackingNumber parameter identifies the package to be deleted from the shipping log.

This method will return the void status of the specified package.

To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.

CancelPickup Method (DShippingSDK_UPSShipIntl Class)

Cancel a pickup.

Object Oriented Interface

public function doCancelPickup($confirmationnumber);

Procedural Interface

dshippingsdk_upsshipintl_do_cancelpickup($res, $confirmationnumber);

Remarks

When called the pickup referenced by the ConfirmationNumber will be canceled.

To check the status of your cancel pickup request the CancelPickUpStatus config should be inspected.

CancelShipment Method (DShippingSDK_UPSShipIntl Class)

Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log.

Object Oriented Interface

public function doCancelShipment($mastertrackingnumber);

Procedural Interface

dshippingsdk_upsshipintl_do_cancelshipment($res, $mastertrackingnumber);

Remarks

To cancel an entire MPS shipment, a void shipment request should be sent to UPS Server by calling the CancelShipment method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the Server to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the Server should be sent to the URL provided as part of the certification process.

The MasterTrackingNumber parameter identifies the shipment that contains all packages to be deleted from shipping log.

To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.

Config Method (DShippingSDK_UPSShipIntl Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_upsshipintl_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetShipmentLabels Method (DShippingSDK_UPSShipIntl Class)

Generates a shipping label.

Object Oriented Interface

public function doGetShipmentLabels();

Procedural Interface

dshippingsdk_upsshipintl_do_getshipmentlabels($res);

Remarks

When this method is called, the following properties must have been set:

• UPSServer (required)
• UPSAuthorizationToken (required)
• UPSAccountNumber (required)
• ServiceType (required)
• AccountContact (conditional)
• AccountAddress (conditional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• SoldToContact (conditional)
• SoldToAddress (conditional)
• Payor (required)
• ShipmentSpecialServices (optional)
• ShipmentDescription (conditional)
• ShipmentReference (conditional)
• Packages (required)
• LabelImageType (required)
• Notify (optional)
• FormTypes (optional)
• CommercialInvoice (optional)
• Commodities (conditional)
• CODReportFile (optional)
• CODTotalAmount (optional)
• CODType (optional)
• WeightUnit (required; defaults to LB)
• Documents (optional)

The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the Commodities (required, regardless of the Documents value).

Upon successful response, the following properties might be populated:

• MasterTrackingNumber (if MPS)
• PackageTrackingNumber for each package included in the shipment;
• PackageShippingLabel for each package included in the shipment;
• PackageTotalSurcharges for each package included in the shipment (only guaranteed to be returned for shipments whose origin country is US or Puerto Rico);
• TotalNetCharge (applicable to the whole shipment);
• TotalBaseCharge (applicable to the whole shipment);
• TotalSurcharges (applicable to the whole shipment);

To print out the PackageShippingLabel, you can save it to the PackageShippingLabelFile file in LabelImageType format.

Reset Method (DShippingSDK_UPSShipIntl Class)

Resets the internal state of the class and all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_upsshipintl_do_reset($res);

Remarks

The Reset method does not have any parameters and does not return any value.

SchedulePickup Method (DShippingSDK_UPSShipIntl Class)

Schedules a pickup.

Object Oriented Interface

public function doSchedulePickup();

Procedural Interface

dshippingsdk_upsshipintl_do_schedulepickup($res);

Remarks

When called, this will request an OnCall Pickup from UPS and return the Pickup Confirmation Number.

The valid properties when calling this method are as follows:

• ServiceType (Required)
• PickupEarliestTime (Required)
• PickupLatestTime (Required)
• SenderFirstName (Optional, required if Company is not provided)
• SenderLastName (Optional, required if Company is not provided)
• SenderCompany (Optional, required if FirstName and/or LastName are not provided)
• SenderPhone (Required)
• SenderAddress1 (Required)
• PickupFloorNumber (Optional)
• PickupRoomNumber (Optional)
• SenderCity (Required)
• SenderState (Required, optional if outside US and Canada)
• SenderZipCode (Required)
• SenderCountryCode (Required)
• ShipDate (Required)

Please note that only SenderAddress1 is valid as the request only allows one address line.

Error Event (DShippingSDK_UPSShipIntl Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_upsshipintl_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (DShippingSDK_UPSShipIntl Class)

Notification returned by the server upon successful request (if applicable).

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_upsshipintl_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'message'

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (DShippingSDK_UPSShipIntl Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_upsshipintl_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (DShippingSDK_UPSShipIntl Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_upsshipintl_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (UPSShipIntl Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

UPSShipIntl Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UPSShipIntl Class)

UPSShipIntl Errors

	301   Operation interrupted (or timeout).
	432   Invalid index.
	527   Server Error Response.
	528   Property set with invalid data.
	560   Missing data.

The class may also return one of the following error codes, which are inherited from other classes.