UPSFreightShip Class

Properties   Methods   Events   Config Settings   Errors  

Provides UPS Freight Shipment service.

Class Name

DShippingSDK_UPSFreightShip

Procedural Interface

 dshippingsdk_upsfreightship_open();
 dshippingsdk_upsfreightship_close($res);
 dshippingsdk_upsfreightship_register_callback($res, $id, $function);
 dshippingsdk_upsfreightship_get_last_error($res);
 dshippingsdk_upsfreightship_get_last_error_code($res);
 dshippingsdk_upsfreightship_set($res, $id, $index, $value);
 dshippingsdk_upsfreightship_get($res, $id, $index);
 dshippingsdk_upsfreightship_do_config($res, $configurationstring);
 dshippingsdk_upsfreightship_do_getshipmentdocuments($res);
 dshippingsdk_upsfreightship_do_reset($res);

Remarks

The UPSFreightShip class allows labels and documents to be generated for a freight shipment. To use the class, populate Documents to specify the type of documents requested. Specify the sender, recipient, commodity and UPS account information before calling GetShipmentDocuments. For instance:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

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.

BillableWeight Property (DShippingSDK_UPSFreightShip Class)

Represents the billable weight associated with the shipment.

Object Oriented Interface

public function getBillableWeight();

Procedural Interface

dshippingsdk_upsfreightship_get($res, 1 );

Default Value

''

Remarks

This property is read-only.

Data Type

String

BOLID Property (DShippingSDK_UPSFreightShip Class)

The retrieval key for the stored BOL (Bill of Lading).

Object Oriented Interface

public function getBOLID();

Procedural Interface

dshippingsdk_upsfreightship_get($res, 2 );

Default Value

''

Remarks

This property holds the retrieval key for the stored BOL (Bill of Lading) as returned by the server.

This property is read-only.

Data Type

String

ChargeCount Property (DShippingSDK_UPSFreightShip Class)

The number of records in the Charge arrays.

Object Oriented Interface

public function getChargeCount();


public function setChargeCount($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 3 );


dshippingsdk_upsfreightship_set($res, 3, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChargeDescription
• ChargeType
• ChargeValue

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

This property is not available at design time.

Data Type

Integer

ChargeType Property (DShippingSDK_UPSFreightShip Class)

Indicates the type of the charge.

Object Oriented Interface

public function getChargeType($chargeindex);


public function setChargeType($chargeindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 4 , $chargeindex);


dshippingsdk_upsfreightship_set($res, 4, $value , $chargeindex);

Default Value

''

Remarks

Indicates the type of the charge. A partial list of possible values are:

The $chargeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

ChargeDescription Property (DShippingSDK_UPSFreightShip Class)

The description of the rate.

Object Oriented Interface

public function getChargeDescription($chargeindex);


public function setChargeDescription($chargeindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 5 , $chargeindex);


dshippingsdk_upsfreightship_set($res, 5, $value , $chargeindex);

Default Value

''

Remarks

The description of the rate. The text description is provided by the class based on the value in ChargeType. If a description is not know for the ChargeType this property will hold an empty string. Possible values are:

The $chargeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

ChargeValue Property (DShippingSDK_UPSFreightShip Class)

The value of the charge type specified by ChargeType .

Object Oriented Interface

public function getChargeValue($chargeindex);


public function setChargeValue($chargeindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 6 , $chargeindex);


dshippingsdk_upsfreightship_set($res, 6, $value , $chargeindex);

Default Value

''

Remarks

The value of the charge type specified by ChargeType.

The $chargeindex parameter specifies the index of the item in the array. The size of the array is controlled by the ChargeCount property.

This property is not available at design time.

Data Type

String

CODPayorType Property (DShippingSDK_UPSFreightShip Class)

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

Object Oriented Interface

public function getCODPayorType();


public function setCODPayorType($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 7 );


dshippingsdk_upsfreightship_set($res, 7, $value );

Default Value

0

Remarks

This property specifies the type of COD payment. Possible values are:

Data Type

Integer

CODRemitToAddress1 Property (DShippingSDK_UPSFreightShip Class)

Street name.

Object Oriented Interface

public function getCODRemitToAddress1();


public function setCODRemitToAddress1($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 8 );


dshippingsdk_upsfreightship_set($res, 8, $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 CODRemitToAddress1 should not exceed 35 characters.

Data Type

String

CODRemitToAddress2 Property (DShippingSDK_UPSFreightShip Class)

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

Object Oriented Interface

public function getCODRemitToAddress2();


public function setCODRemitToAddress2($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 9 );


dshippingsdk_upsfreightship_set($res, 9, $value );

Default Value

''

Remarks

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

Data Type

String

CODRemitToCity Property (DShippingSDK_UPSFreightShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getCODRemitToCity();


public function setCODRemitToCity($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 11 );


dshippingsdk_upsfreightship_set($res, 11, $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

CODRemitToState Property (DShippingSDK_UPSFreightShip Class)

State or province code.

Object Oriented Interface

public function getCODRemitToState();


public function setCODRemitToState($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 13 );


dshippingsdk_upsfreightship_set($res, 13, $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

CODRemitToZipCode Property (DShippingSDK_UPSFreightShip Class)

Postal code.

Object Oriented Interface

public function getCODRemitToZipCode();


public function setCODRemitToZipCode($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 14 );


dshippingsdk_upsfreightship_set($res, 14, $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 CODRemitToCity and CODRemitToState are not present.

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

Data Type

String

CODRemitToCompany Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getCODRemitToCompany();


public function setCODRemitToCompany($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 15 );


dshippingsdk_upsfreightship_set($res, 15, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either CODRemitToFirstName and CODRemitToLastName or CODRemitToCompany are required to be provided.

Data Type

String

CODRemitToEmail Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getCODRemitToEmail();


public function setCODRemitToEmail($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 16 );


dshippingsdk_upsfreightship_set($res, 16, $value );

Default Value

''

Remarks

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

Data Type

String

CODRemitToFax Property (DShippingSDK_UPSFreightShip Class)

Recipient's fax number.

Object Oriented Interface

public function getCODRemitToFax();


public function setCODRemitToFax($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 17 );


dshippingsdk_upsfreightship_set($res, 17, $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

CODRemitToFirstName Property (DShippingSDK_UPSFreightShip Class)

Sender's first name.

Object Oriented Interface

public function getCODRemitToFirstName();


public function setCODRemitToFirstName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 18 );


dshippingsdk_upsfreightship_set($res, 18, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either CODRemitToFirstName and CODRemitToLastName or CODRemitToCompany must be sent.

Data Type

String

CODRemitToLastName Property (DShippingSDK_UPSFreightShip Class)

Person's last name.

Object Oriented Interface

public function getCODRemitToLastName();


public function setCODRemitToLastName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 19 );


dshippingsdk_upsfreightship_set($res, 19, $value );

Default Value

''

Remarks

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

Data Type

String

CODRemitToMiddleInitial Property (DShippingSDK_UPSFreightShip Class)

Middle initial.

Object Oriented Interface

public function getCODRemitToMiddleInitial();


public function setCODRemitToMiddleInitial($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 20 );


dshippingsdk_upsfreightship_set($res, 20, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

CODRemitToPhone Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getCODRemitToPhone();


public function setCODRemitToPhone($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 21 );


dshippingsdk_upsfreightship_set($res, 21, $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

CODTotalAmount Property (DShippingSDK_UPSFreightShip Class)

The total amount of additional fees.

Object Oriented Interface

public function getCODTotalAmount();


public function setCODTotalAmount($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 22 );


dshippingsdk_upsfreightship_set($res, 22, $value );

Default Value

''

Remarks

UPS Freight handles your payment collections upon delivery and sends the payment to you (if applicable) for an additional charge.

Data Type

String

CODType Property (DShippingSDK_UPSFreightShip 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_upsfreightship_get($res, 23 );


dshippingsdk_upsfreightship_set($res, 23, $value );

Default Value

0

Remarks

This property specifies the type of COD requested. Possible values are:

Data Type

Integer

CommodityCount Property (DShippingSDK_UPSFreightShip Class)

The number of records in the Commodity arrays.

Object Oriented Interface

public function getCommodityCount();


public function setCommodityCount($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 24 );


dshippingsdk_upsfreightship_set($res, 24, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CommodityDescription
• CommodityFreightClass
• CommodityFreightIsHazardous
• CommodityFreightNMFC
• CommodityFreightNMFCSub
• CommodityFreightPackagingType
• CommodityNumberOfPieces
• 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_UPSFreightShip Class)

Complete and accurate description of this commodity line item.

Object Oriented Interface

public function getCommodityDescription($commodityindex);


public function setCommodityDescription($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 25 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 25, $value , $commodityindex);

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 $commodityindex 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

CommodityFreightClass Property (DShippingSDK_UPSFreightShip Class)

Indicates the freight class of the commodity.

Object Oriented Interface

public function getCommodityFreightClass($commodityindex);


public function setCommodityFreightClass($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 27 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 27, $value , $commodityindex);

Default Value

''

Remarks

Indicates the freight class of the commodity.

The following table lists freight classes available from UPS freight services.

NOTE: This field is only applicable to UPS freight.

The $commodityindex 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

CommodityFreightIsHazardous Property (DShippingSDK_UPSFreightShip Class)

Identifies if the Commodity item is hazardous.

Object Oriented Interface

public function getCommodityFreightIsHazardous($commodityindex);


public function setCommodityFreightIsHazardous($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 28 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 28, $value , $commodityindex);

Default Value

false

Remarks

Identifies if the Commodity item is hazardous.

NOTE: This field is only applicable to UPS freight.

The $commodityindex 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

Boolean

CommodityFreightNMFC Property (DShippingSDK_UPSFreightShip Class)

Identifies the National Motor Freight Classification numbers.

Object Oriented Interface

public function getCommodityFreightNMFC($commodityindex);


public function setCommodityFreightNMFC($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 29 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 29, $value , $commodityindex);

Default Value

''

Remarks

Identifies the National Motor Freight Classification numbers.

NOTE: This field is only applicable to UPS freight.

The $commodityindex 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

CommodityFreightNMFCSub Property (DShippingSDK_UPSFreightShip Class)

Identifies the sub code of National Motor Freight Classification numbers.

Object Oriented Interface

public function getCommodityFreightNMFCSub($commodityindex);


public function setCommodityFreightNMFCSub($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 30 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 30, $value , $commodityindex);

Default Value

''

Remarks

Identifies the sub code of National Motor Freight Classification numbers.

NOTE: This field is only applicable to UPS freight.

The $commodityindex 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

CommodityFreightPackagingType Property (DShippingSDK_UPSFreightShip Class)

Identifies the Commodity item's packaging type.

Object Oriented Interface

public function getCommodityFreightPackagingType($commodityindex);


public function setCommodityFreightPackagingType($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 31 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 31, $value , $commodityindex);

Default Value

0

Remarks

Identifies the Commodity item's packaging type. Possible values are:

NOTE: This field is only applicable to UPS freight.

The $commodityindex 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

CommodityNumberOfPieces Property (DShippingSDK_UPSFreightShip Class)

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

Object Oriented Interface

public function getCommodityNumberOfPieces($commodityindex);


public function setCommodityNumberOfPieces($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 34 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 34, $value , $commodityindex);

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 $commodityindex 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

CommodityValue Property (DShippingSDK_UPSFreightShip Class)

The value of an individual item being shipped.

Object Oriented Interface

public function getCommodityValue($commodityindex);


public function setCommodityValue($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 40 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 40, $value , $commodityindex);

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 $commodityindex 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_UPSFreightShip 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($commodityindex);


public function setCommodityWeight($commodityindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 41 , $commodityindex);


dshippingsdk_upsfreightship_set($res, 41, $value , $commodityindex);

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 $commodityindex 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

DimensionalWeight Property (DShippingSDK_UPSFreightShip Class)

Represents the dimensional weight associated with the shipment.

Object Oriented Interface

public function getDimensionalWeight();

Procedural Interface

dshippingsdk_upsfreightship_get($res, 42 );

Default Value

''

Remarks

The dimensional weight as calculated by the server and returned in the response.

This property is read-only.

Data Type

String

DocumentCount Property (DShippingSDK_UPSFreightShip Class)

The number of records in the Document arrays.

Object Oriented Interface

public function getDocumentCount();


public function setDocumentCount($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 43 );


dshippingsdk_upsfreightship_set($res, 43, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DocumentFile
• DocumentFileName
• DocumentLabelsPerPage
• DocumentPrintFormat
• DocumentPrintSize
• DocumentType

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

This property is not available at design time.

Data Type

Integer

DocumentType Property (DShippingSDK_UPSFreightShip Class)

Specifies the type of document that is requested.

Object Oriented Interface

public function getDocumentType($documentindex);


public function setDocumentType($documentindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 44 , $documentindex);


dshippingsdk_upsfreightship_set($res, 44, $value , $documentindex);

Default Value

0

Remarks

Specifies the type of document that is requested. Possible values are:

The default value is ftcLabel (0).

The $documentindex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

DocumentFile Property (DShippingSDK_UPSFreightShip Class)

The decoded binary label file.

Object Oriented Interface

public function getDocumentFile($documentindex);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 45 , $documentindex);

Default Value

''

Remarks

The decoded binary label file.

The $documentindex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

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

Data Type

Binary String

DocumentFileName Property (DShippingSDK_UPSFreightShip Class)

Specifies where the file will be written.

Object Oriented Interface

public function getDocumentFileName($documentindex);


public function setDocumentFileName($documentindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 46 , $documentindex);


dshippingsdk_upsfreightship_set($res, 46, $value , $documentindex);

Default Value

''

Remarks

Specifies where the file will be written. This property must be set before calling GetShipmentDocuments. It should contain the full path and filename to which the returned document will be written when GetShipmentDocuments is called.

The $documentindex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

String

DocumentLabelsPerPage Property (DShippingSDK_UPSFreightShip Class)

This specifies the number of labels per page in the returned label file.

Object Oriented Interface

public function getDocumentLabelsPerPage($documentindex);


public function setDocumentLabelsPerPage($documentindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 47 , $documentindex);


dshippingsdk_upsfreightship_set($res, 47, $value , $documentindex);

Default Value

0

Remarks

This specifies the number of labels per page in the returned label file. Possible values are:

Required when DocumentType is fitLabel. Otherwise it is ignored.

The $documentindex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

DocumentPrintFormat Property (DShippingSDK_UPSFreightShip Class)

Specifies the print format of the label.

Object Oriented Interface

public function getDocumentPrintFormat($documentindex);


public function setDocumentPrintFormat($documentindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 48 , $documentindex);


dshippingsdk_upsfreightship_set($res, 48, $value , $documentindex);

Default Value

0

Remarks

Specifies the print format of the label. Possible values are:

Required when DocumentType is fitLabel. Otherwise it is ignored.

The $documentindex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

DocumentPrintSize Property (DShippingSDK_UPSFreightShip Class)

Specifies the requested print size of the label.

Object Oriented Interface

public function getDocumentPrintSize($documentindex);


public function setDocumentPrintSize($documentindex, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 49 , $documentindex);


dshippingsdk_upsfreightship_set($res, 49, $value , $documentindex);

Default Value

0

Remarks

Specifies the requested print size of the label. Possible values are:

Required when DocumentType is fitLabel. Otherwise it is ignored.

The $documentindex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCount property.

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (DShippingSDK_UPSFreightShip 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_upsfreightship_get($res, 50 );


dshippingsdk_upsfreightship_set($res, 50, $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_UPSFreightShip Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 51 );


dshippingsdk_upsfreightship_set($res, 51, $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_UPSFreightShip 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_upsfreightship_get($res, 52 );


dshippingsdk_upsfreightship_set($res, 52, $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_UPSFreightShip 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_upsfreightship_get($res, 53 );


dshippingsdk_upsfreightship_set($res, 53, $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_UPSFreightShip 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_upsfreightship_get($res, 54 );


dshippingsdk_upsfreightship_set($res, 54, $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_UPSFreightShip 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_upsfreightship_get($res, 55 );


dshippingsdk_upsfreightship_set($res, 55, $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

HandlingUnit Property (DShippingSDK_UPSFreightShip Class)

Describe the Handling Units (Movable Pieces) in this Shipment.

Object Oriented Interface

public function getHandlingUnit();


public function setHandlingUnit($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 56 );


dshippingsdk_upsfreightship_set($res, 56, $value );

Default Value

''

Remarks

The first 4 codes are valid for handling unit one and the last two are valid for handling unit two. The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example: SKD:1; OTH:1'.

Data Type

String

HazMatContactName Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact name for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Object Oriented Interface

public function getHazMatContactName();


public function setHazMatContactName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 57 );


dshippingsdk_upsfreightship_set($res, 57, $value );

Default Value

''

Remarks

This property hold the name of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and CommodityFreightIsHazardous is true.

Data Type

String

HazMatContactPhone Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact phone for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Object Oriented Interface

public function getHazMatContactPhone();


public function setHazMatContactPhone($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 58 );


dshippingsdk_upsfreightship_set($res, 58, $value );

Default Value

''

Remarks

This property hold the phone number of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and CommodityFreightIsHazardous is true.

Data Type

String

NotifyCount Property (DShippingSDK_UPSFreightShip Class)

The number of records in the Notify arrays.

Object Oriented Interface

public function getNotifyCount();


public function setNotifyCount($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 59 );


dshippingsdk_upsfreightship_set($res, 59, $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_UPSFreightShip 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_upsfreightship_get($res, 60 , $notifyidx);


dshippingsdk_upsfreightship_set($res, 60, $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_UPSFreightShip Class)

Email address of the recipient to be notified.

Object Oriented Interface

public function getNotifyEmail($notifyidx);


public function setNotifyEmail($notifyidx, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 61 , $notifyidx);


dshippingsdk_upsfreightship_set($res, 61, $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_UPSFreightShip 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_upsfreightship_get($res, 62 , $notifyidx);


dshippingsdk_upsfreightship_set($res, 62, $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_UPSFreightShip Class)

Identifies the type of notification requested.

Object Oriented Interface

public function getNotifyFlags($notifyidx);


public function setNotifyFlags($notifyidx, $value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 64 , $notifyidx);


dshippingsdk_upsfreightship_set($res, 64, $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

OverSeasLegHeight Property (DShippingSDK_UPSFreightShip Class)

The height of the shipment.

Object Oriented Interface

public function getOverSeasLegHeight();


public function setOverSeasLegHeight($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 66 );


dshippingsdk_upsfreightship_set($res, 66, $value );

Default Value

0

Remarks

The height of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

OverSeasLegLength Property (DShippingSDK_UPSFreightShip Class)

The length of the shipment.

Object Oriented Interface

public function getOverSeasLegLength();


public function setOverSeasLegLength($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 67 );


dshippingsdk_upsfreightship_set($res, 67, $value );

Default Value

0

Remarks

The length of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

OverSeasLegPricePerCubicFoot Property (DShippingSDK_UPSFreightShip Class)

The price per CubicFoot.

Object Oriented Interface

public function getOverSeasLegPricePerCubicFoot();


public function setOverSeasLegPricePerCubicFoot($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 68 );


dshippingsdk_upsfreightship_set($res, 68, $value );

Default Value

''

Remarks

The price per CubicFoot.

Data Type

String

OverSeasLegPricePerCWT Property (DShippingSDK_UPSFreightShip Class)

Price per Hundredweight.

Object Oriented Interface

public function getOverSeasLegPricePerCWT();


public function setOverSeasLegPricePerCWT($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 69 );


dshippingsdk_upsfreightship_set($res, 69, $value );

Default Value

''

Remarks

Price per Hundredweight. For shipments with Puerto Rico as a destination, you may specify this amount before shipping.

Data Type

String

OverSeasLegTotalCubicFeet Property (DShippingSDK_UPSFreightShip Class)

Total cubic weight of the shipment, obtained by multiplying width by height by depth.

Object Oriented Interface

public function getOverSeasLegTotalCubicFeet();


public function setOverSeasLegTotalCubicFeet($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 70 );


dshippingsdk_upsfreightship_set($res, 70, $value );

Default Value

''

Remarks

Total cubic weight of the shipment, obtained by multiplying width by height by depth. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this amount before shipping.

Data Type

String

OverSeasLegWidth Property (DShippingSDK_UPSFreightShip Class)

The width of the shipment.

Object Oriented Interface

public function getOverSeasLegWidth();


public function setOverSeasLegWidth($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 71 );


dshippingsdk_upsfreightship_set($res, 71, $value );

Default Value

0

Remarks

The width of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer

PayorAddress1 Property (DShippingSDK_UPSFreightShip Class)

Street name.

Object Oriented Interface

public function getPayorAddress1();


public function setPayorAddress1($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 73 );


dshippingsdk_upsfreightship_set($res, 73, $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. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorAddress2 Property (DShippingSDK_UPSFreightShip Class)

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

Object Oriented Interface

public function getPayorAddress2();


public function setPayorAddress2($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 74 );


dshippingsdk_upsfreightship_set($res, 74, $value );

Default Value

''

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorCity Property (DShippingSDK_UPSFreightShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getPayorCity();


public function setPayorCity($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 75 );


dshippingsdk_upsfreightship_set($res, 75, $value );

Default Value

''

Remarks

Name of city, town, etc.

Data Type

String

PayorCountryCode Property (DShippingSDK_UPSFreightShip 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_upsfreightship_get($res, 76 );


dshippingsdk_upsfreightship_set($res, 76, $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

PayorName Property (DShippingSDK_UPSFreightShip Class)

Identifies the payor's name.

Object Oriented Interface

public function getPayorName();


public function setPayorName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 77 );


dshippingsdk_upsfreightship_set($res, 77, $value );

Default Value

''

Remarks

Identifies the payor's name.

PayorName is required only if PayorType is set to 'THIRDPARTY'.

Note: This property is only applicable to UPSFreightRates and UPSFreightShip.

Data Type

String

PayorType Property (DShippingSDK_UPSFreightShip Class)

Method of payment for shipment, or duties and taxes.

Object Oriented Interface

public function getPayorType();


public function setPayorType($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 78 );


dshippingsdk_upsfreightship_set($res, 78, $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

PayorState Property (DShippingSDK_UPSFreightShip Class)

State or province code.

Object Oriented Interface

public function getPayorState();


public function setPayorState($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 79 );


dshippingsdk_upsfreightship_set($res, 79, $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

PayorZipCode Property (DShippingSDK_UPSFreightShip Class)

Payor's postal code (if applicable).

Object Oriented Interface

public function getPayorZipCode();


public function setPayorZipCode($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 80 );


dshippingsdk_upsfreightship_set($res, 80, $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

PickupRequesterCompany Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getPickupRequesterCompany();


public function setPickupRequesterCompany($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 81 );


dshippingsdk_upsfreightship_set($res, 81, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either PickupRequesterFirstName and PickupRequesterLastName or PickupRequesterCompany are required to be provided.

Data Type

String

PickupRequesterEmail Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getPickupRequesterEmail();


public function setPickupRequesterEmail($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 82 );


dshippingsdk_upsfreightship_set($res, 82, $value );

Default Value

''

Remarks

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

Data Type

String

PickupRequesterFax Property (DShippingSDK_UPSFreightShip Class)

Recipient's fax number.

Object Oriented Interface

public function getPickupRequesterFax();


public function setPickupRequesterFax($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 83 );


dshippingsdk_upsfreightship_set($res, 83, $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

PickupRequesterFirstName Property (DShippingSDK_UPSFreightShip Class)

Sender's first name.

Object Oriented Interface

public function getPickupRequesterFirstName();


public function setPickupRequesterFirstName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 84 );


dshippingsdk_upsfreightship_set($res, 84, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either PickupRequesterFirstName and PickupRequesterLastName or PickupRequesterCompany must be sent.

Data Type

String

PickupRequesterLastName Property (DShippingSDK_UPSFreightShip Class)

Person's last name.

Object Oriented Interface

public function getPickupRequesterLastName();


public function setPickupRequesterLastName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 85 );


dshippingsdk_upsfreightship_set($res, 85, $value );

Default Value

''

Remarks

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

Data Type

String

PickupRequesterMiddleInitial Property (DShippingSDK_UPSFreightShip Class)

Middle initial.

Object Oriented Interface

public function getPickupRequesterMiddleInitial();


public function setPickupRequesterMiddleInitial($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 86 );


dshippingsdk_upsfreightship_set($res, 86, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

PickupRequesterPhone Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getPickupRequesterPhone();


public function setPickupRequesterPhone($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 87 );


dshippingsdk_upsfreightship_set($res, 87, $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

ProxyAuthScheme Property (DShippingSDK_UPSFreightShip 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_upsfreightship_get($res, 88 );


dshippingsdk_upsfreightship_set($res, 88, $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_UPSFreightShip 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_upsfreightship_get($res, 89 );


dshippingsdk_upsfreightship_set($res, 89, $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_UPSFreightShip 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_upsfreightship_get($res, 90 );


dshippingsdk_upsfreightship_set($res, 90, $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_UPSFreightShip 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_upsfreightship_get($res, 91 );


dshippingsdk_upsfreightship_set($res, 91, $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_UPSFreightShip 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_upsfreightship_get($res, 92 );


dshippingsdk_upsfreightship_set($res, 92, $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_UPSFreightShip 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_upsfreightship_get($res, 93 );


dshippingsdk_upsfreightship_set($res, 93, $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_UPSFreightShip Class)

This property contains a user name, if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 94 );


dshippingsdk_upsfreightship_set($res, 94, $value );

Default Value

''

Remarks

This property contains a user name, 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

RecipientAddress1 Property (DShippingSDK_UPSFreightShip Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 95 );


dshippingsdk_upsfreightship_set($res, 95, $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_UPSFreightShip 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_upsfreightship_get($res, 96 );


dshippingsdk_upsfreightship_set($res, 96, $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_UPSFreightShip Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getRecipientAddressFlags();


public function setRecipientAddressFlags($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 97 );


dshippingsdk_upsfreightship_set($res, 97, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (DShippingSDK_UPSFreightShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 98 );


dshippingsdk_upsfreightship_set($res, 98, $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_UPSFreightShip Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 99 );


dshippingsdk_upsfreightship_set($res, 99, $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_UPSFreightShip Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 100 );


dshippingsdk_upsfreightship_set($res, 100, $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_UPSFreightShip Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 101 );


dshippingsdk_upsfreightship_set($res, 101, $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_UPSFreightShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getRecipientCompany();


public function setRecipientCompany($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 102 );


dshippingsdk_upsfreightship_set($res, 102, $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_UPSFreightShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getRecipientEmail();


public function setRecipientEmail($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 103 );


dshippingsdk_upsfreightship_set($res, 103, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientFax Property (DShippingSDK_UPSFreightShip Class)

Recipient's fax number.

Object Oriented Interface

public function getRecipientFax();


public function setRecipientFax($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 104 );


dshippingsdk_upsfreightship_set($res, 104, $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_UPSFreightShip Class)

Sender's first name.

Object Oriented Interface

public function getRecipientFirstName();


public function setRecipientFirstName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 105 );


dshippingsdk_upsfreightship_set($res, 105, $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_UPSFreightShip Class)

Person's last name.

Object Oriented Interface

public function getRecipientLastName();


public function setRecipientLastName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 106 );


dshippingsdk_upsfreightship_set($res, 106, $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_UPSFreightShip Class)

Middle initial.

Object Oriented Interface

public function getRecipientMiddleInitial();


public function setRecipientMiddleInitial($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 107 );


dshippingsdk_upsfreightship_set($res, 107, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getRecipientPhone();


public function setRecipientPhone($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 108 );


dshippingsdk_upsfreightship_set($res, 108, $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

ReferenceCount Property (DShippingSDK_UPSFreightShip Class)

The number of records in the Reference arrays.

Object Oriented Interface

public function getReferenceCount();

Procedural Interface

dshippingsdk_upsfreightship_get($res, 109 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceNumber
• ReferenceNumberOfCartons
• ReferenceType
• ReferenceWeight

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

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

Data Type

Integer

ReferenceNumber Property (DShippingSDK_UPSFreightShip Class)

The reference number.

Object Oriented Interface

public function getReferenceNumber($referenceindex);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 110 , $referenceindex);

Default Value

''

Remarks

The reference number.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

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

Data Type

String

ReferenceNumberOfCartons Property (DShippingSDK_UPSFreightShip Class)

The number of cartons.

Object Oriented Interface

public function getReferenceNumberOfCartons($referenceindex);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 111 , $referenceindex);

Default Value

0

Remarks

The number of cartons.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

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

Data Type

Integer

ReferenceType Property (DShippingSDK_UPSFreightShip Class)

The type of the reference number.

Object Oriented Interface

public function getReferenceType($referenceindex);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 112 , $referenceindex);

Default Value

0

Remarks

The type of the reference number. Possible values are:

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

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

Data Type

Integer

ReferenceWeight Property (DShippingSDK_UPSFreightShip Class)

The weight.

Object Oriented Interface

public function getReferenceWeight($referenceindex);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 113 , $referenceindex);

Default Value

'0'

Remarks

The weight.

The $referenceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

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

Data Type

String

SenderAddress1 Property (DShippingSDK_UPSFreightShip Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 114 );


dshippingsdk_upsfreightship_set($res, 114, $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_UPSFreightShip 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_upsfreightship_get($res, 115 );


dshippingsdk_upsfreightship_set($res, 115, $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_UPSFreightShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 117 );


dshippingsdk_upsfreightship_set($res, 117, $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_UPSFreightShip Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 118 );


dshippingsdk_upsfreightship_set($res, 118, $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_UPSFreightShip Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 119 );


dshippingsdk_upsfreightship_set($res, 119, $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_UPSFreightShip Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 120 );


dshippingsdk_upsfreightship_set($res, 120, $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_UPSFreightShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getSenderCompany();


public function setSenderCompany($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 121 );


dshippingsdk_upsfreightship_set($res, 121, $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_UPSFreightShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getSenderEmail();


public function setSenderEmail($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 122 );


dshippingsdk_upsfreightship_set($res, 122, $value );

Default Value

''

Remarks

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

Data Type

String

SenderFax Property (DShippingSDK_UPSFreightShip Class)

Recipient's fax number.

Object Oriented Interface

public function getSenderFax();


public function setSenderFax($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 123 );


dshippingsdk_upsfreightship_set($res, 123, $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_UPSFreightShip Class)

Sender's first name.

Object Oriented Interface

public function getSenderFirstName();


public function setSenderFirstName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 124 );


dshippingsdk_upsfreightship_set($res, 124, $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_UPSFreightShip Class)

Person's last name.

Object Oriented Interface

public function getSenderLastName();


public function setSenderLastName($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 125 );


dshippingsdk_upsfreightship_set($res, 125, $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_UPSFreightShip Class)

Middle initial.

Object Oriented Interface

public function getSenderMiddleInitial();


public function setSenderMiddleInitial($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 126 );


dshippingsdk_upsfreightship_set($res, 126, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (DShippingSDK_UPSFreightShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getSenderPhone();


public function setSenderPhone($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 127 );


dshippingsdk_upsfreightship_set($res, 127, $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_UPSFreightShip Class)

The service selected for the shipment.

Object Oriented Interface

public function getServiceType();


public function setServiceType($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 128 );


dshippingsdk_upsfreightship_set($res, 128, $value );

Default Value

0

Remarks

Specifies the service to be used for the shipment.

Valid values for UPS Freight are:

Data Type

Integer

ShipmentNumber Property (DShippingSDK_UPSFreightShip Class)

The shipment number assigned to the shipment.

Object Oriented Interface

public function getShipmentNumber();

Procedural Interface

dshippingsdk_upsfreightship_get($res, 129 );

Default Value

''

Remarks

This property contains a 9 character shipment number returned in the response.

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (DShippingSDK_UPSFreightShip Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 131 );


dshippingsdk_upsfreightship_set($res, 131, $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_UPSFreightShip Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 159 );


dshippingsdk_upsfreightship_set($res, 159, $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_UPSFreightShip 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_upsfreightship_get($res, 175 );


dshippingsdk_upsfreightship_set($res, 175, $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 are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_UPSFreightShip 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_upsfreightship_get($res, 176 );


dshippingsdk_upsfreightship_set($res, 176, $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_UPSFreightShip Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 177 );


dshippingsdk_upsfreightship_set($res, 177, $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_UPSFreightShip 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_upsfreightship_get($res, 178 );


dshippingsdk_upsfreightship_set($res, 178, $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 displayed below.

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

Data Type

String

SSLProvider Property (DShippingSDK_UPSFreightShip Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 186 );


dshippingsdk_upsfreightship_set($res, 186, $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_UPSFreightShip Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_upsfreightship_get($res, 188 );

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_UPSFreightShip Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 215 );


dshippingsdk_upsfreightship_set($res, 215, $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

TotalCharge Property (DShippingSDK_UPSFreightShip Class)

Represents the total shipment charge.

Object Oriented Interface

public function getTotalCharge();

Procedural Interface

dshippingsdk_upsfreightship_get($res, 216 );

Default Value

''

Remarks

This property holds the total charge associated with the shipment. The value is represented in dollars and cents with two decimal places. For instance "1500.25".

This property is read-only.

Data Type

String

UPSAccountNumber Property (DShippingSDK_UPSFreightShip Class)

The shipper's UPS account number.

Object Oriented Interface

public function getUPSAccountNumber();


public function setUPSAccountNumber($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 217 );


dshippingsdk_upsfreightship_set($res, 217, $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_UPSFreightShip Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getUPSAuthorizationToken();


public function setUPSAuthorizationToken($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 218 );


dshippingsdk_upsfreightship_set($res, 218, $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_UPSFreightShip Class)

URL for the UPS server where the requests are sent.

Object Oriented Interface

public function getUPSServer();


public function setUPSServer($value);

Procedural Interface

dshippingsdk_upsfreightship_get($res, 219 );


dshippingsdk_upsfreightship_set($res, 219, $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 componernt will send the requests to the preset production end-point. You can utilize the TestMode Config to switch from production to testing.

The following URLs may be used for testing:

Data Type

String

Config Method (DShippingSDK_UPSFreightShip Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetShipmentDocuments Method (DShippingSDK_UPSFreightShip Class)

Generates a shipping label using one of domestic UPS services.

Object Oriented Interface

public function doGetShipmentDocuments();

Procedural Interface

dshippingsdk_upsfreightship_do_getshipmentdocuments($res);

Remarks

The following properties must be set before calling this method:

• UPSServer (required)
• UPSAuthorizationToken (required)
• UPSAccountNumber (required)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• DocumentFileName
• DocumentLabelsPerPage
• DocumentPrintFormat
• DocumentPrintSize
• DocumentType (required)
• CommodityDescription (required)
• CommodityFreightClass (required for ground shipments)
• CommodityFreightIsHazardous
• CommodityFreightNMFC
• CommodityFreightNMFCSub
• CommodityNumberOfPieces (required)
• CommodityFreightPackagingType (required)
• CommodityValue (required)
• CommodityWeight (required)
• WeightUnit (required; defaults to LBS)

Documents specifies information about the requested documents, including the type of document being requested, formatting information, and the filename to which the document will be saved.

Upon successful response, the following properties will be populated:

• BOLID
• ShipmentNumber
• BillableWeight
• ChargeType
• ChargeDescription
• ChargeValue
• TotalCharge

The documents will be written to the filenames set in DocumentFileName.

Code example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

Reset Method (DShippingSDK_UPSFreightShip Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_upsfreightship_do_reset($res);

Remarks

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

Error Event (DShippingSDK_UPSFreightShip Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_upsfreightship_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_UPSFreightShip Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_upsfreightship_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_UPSFreightShip Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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_UPSFreightShip Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (UPSFreightShip 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.

UPSFreightShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UPSFreightShip Class)

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