USPSShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a USPS shipping label for any of USPS domestic services complete with addresses and barcode, or manage pickups. To get a label with USPS, postage must be paid. To get a label with postage you must use ppNone , ppEndicia , or ppStamps as your PostageProvider . Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS (or Electronic Verification System) Label API allows high-volume package mailers and package consolidators to document and pay postage, including special service fees, using electronic manifest files.

Class Name

DShippingSDK_USPSShip

Procedural Interface

 dshippingsdk_uspsship_open();
 dshippingsdk_uspsship_close($res);
 dshippingsdk_uspsship_register_callback($res, $id, $function);
 dshippingsdk_uspsship_get_last_error($res);
 dshippingsdk_uspsship_get_last_error_code($res);
 dshippingsdk_uspsship_set($res, $id, $index, $value);
 dshippingsdk_uspsship_get($res, $id, $index);
 dshippingsdk_uspsship_do_cancelpackage($res, $barcodenumber);
 dshippingsdk_uspsship_do_cancelpickup($res, $confirmationnumber);
 dshippingsdk_uspsship_do_changepickup($res, $confirmationnumber);
 dshippingsdk_uspsship_do_config($res, $configurationstring);
 dshippingsdk_uspsship_do_getpackagelabel($res);
 dshippingsdk_uspsship_do_pickupavailability($res);
 dshippingsdk_uspsship_do_pickupinquiry($res, $confirmationnumber);
 dshippingsdk_uspsship_do_reset($res);
 dshippingsdk_uspsship_do_schedulepickup($res);

Remarks

Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any other special services you want to associate the shipment (such as Return Shipment, etc.).

This is useful if you have your own Postnet barcode generating software.

In addition, the class can submit a request for your carrier to pick up packages from your current location. You can schedule multiple pickups and edit or cancel previously submitted pickups, and even electronically determine if carrier pickup is available at your current address.

The following methods are available for scheduling carrier pickups:

Postage Provider Notes

ppNone

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

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

ppEndicia

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

• Set PostageProvider to ppEndicia.
• Set USPSAccountNumber to your production account number (provided by Endicia).
• Set USPSPassword to your production password (provided by Endicia).

Testing

The components come with a built in sandbox account for your use. To use that account with the components...

• Set PostageProvider to ppEndicia.
• Set EndiciaTestMode to either 1 or 2.

In all cases the class will send requests to the correct server without setting USPSServer.

ppStamps

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

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AddressServiceRequest Property (DShippingSDK_USPSShip Class)

Indicates if an address service request is made.

Object Oriented Interface

public function getAddressServiceRequest();


public function setAddressServiceRequest($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 1 );


dshippingsdk_uspsship_set($res, 1, $value );

Default Value

false

Remarks

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

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

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

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

Data Type

Boolean

BarcodeNumber Property (DShippingSDK_USPSShip Class)

Barcode number associated with label's barcode.

Object Oriented Interface

public function getBarcodeNumber();

Procedural Interface

dshippingsdk_uspsship_get($res, 2 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

Contents Property (DShippingSDK_USPSShip Class)

Type of the contents in the package.

Object Oriented Interface

public function getContents();


public function setContents($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 3 );


dshippingsdk_uspsship_set($res, 3, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

CountExpress Property (DShippingSDK_USPSShip Class)

The number of Express Mail packages to be picked up.

Object Oriented Interface

public function getCountExpress();


public function setCountExpress($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 4 );


dshippingsdk_uspsship_set($res, 4, $value );

Default Value

0

Remarks

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

The maximum count is 999 packages.

Data Type

Integer

CountInternational Property (DShippingSDK_USPSShip Class)

The number of International Mail packages to be picked up.

Object Oriented Interface

public function getCountInternational();


public function setCountInternational($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 5 );


dshippingsdk_uspsship_set($res, 5, $value );

Default Value

0

Remarks

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

The maximum count is 999 packages.

Data Type

Integer

CountOther Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getCountOther();


public function setCountOther($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 6 );


dshippingsdk_uspsship_set($res, 6, $value );

Default Value

0

Remarks

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

The maximum count is 999 packages.

Data Type

Integer

CountPriority Property (DShippingSDK_USPSShip Class)

The number of Priority Mail packages to be picked up.

Object Oriented Interface

public function getCountPriority();


public function setCountPriority($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 7 );


dshippingsdk_uspsship_set($res, 7, $value );

Default Value

0

Remarks

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

The maximum count is 999 packages.

Data Type

Integer

CustomerId Property (DShippingSDK_USPSShip Class)

User-assigned number for internal use.

Object Oriented Interface

public function getCustomerId();


public function setCustomerId($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 8 );


dshippingsdk_uspsship_set($res, 8, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

CustomerReceipt Property (DShippingSDK_USPSShip Class)

Image of the Customer Online Record.

Object Oriented Interface

public function getCustomerReceipt();

Procedural Interface

dshippingsdk_uspsship_get($res, 9 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

Binary String

CustomerReceiptFile Property (DShippingSDK_USPSShip Class)

Filename for CustomerReceipt (optional).

Object Oriented Interface

public function getCustomerReceiptFile();


public function setCustomerReceiptFile($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 10 );


dshippingsdk_uspsship_set($res, 10, $value );

Default Value

''

Remarks

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

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

Data Type

String

DeliveryOption Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getDeliveryOption();


public function setDeliveryOption($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 11 );


dshippingsdk_uspsship_set($res, 11, $value );

Default Value

1

Remarks

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

The default value for this property is edoNormal.

Possible values are as follows:

Data Type

Integer

ExtraServices Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getExtraServices();


public function setExtraServices($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 12 );


dshippingsdk_uspsship_set($res, 12, $value );

Default Value

0

Remarks

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

Data Type

Long64

FirewallAutoDetect Property (DShippingSDK_USPSShip 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_uspsship_get($res, 13 );


dshippingsdk_uspsship_set($res, 13, $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_USPSShip Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 14 );


dshippingsdk_uspsship_set($res, 14, $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_USPSShip 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_uspsship_get($res, 15 );


dshippingsdk_uspsship_set($res, 15, $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_USPSShip 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_uspsship_get($res, 16 );


dshippingsdk_uspsship_set($res, 16, $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_USPSShip 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_uspsship_get($res, 17 );


dshippingsdk_uspsship_set($res, 17, $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_USPSShip 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_uspsship_get($res, 18 );


dshippingsdk_uspsship_set($res, 18, $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

InsuranceCost Property (DShippingSDK_USPSShip Class)

Insurance fee for the package being shipped.

Object Oriented Interface

public function getInsuranceCost();

Procedural Interface

dshippingsdk_uspsship_get($res, 19 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

LabelImageType Property (DShippingSDK_USPSShip Class)

Type of label image.

Object Oriented Interface

public function getLabelImageType();


public function setLabelImageType($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 20 );


dshippingsdk_uspsship_set($res, 20, $value );

Default Value

0

Remarks

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

Valid values for USPS (eVSLabels):

• sitTIF (1)
• sitPDF (3)

Valid values for Endicia:

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

Valid values for Stamps.com:

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

Data Type

Integer

LabelOption Property (DShippingSDK_USPSShip Class)

Indicates type of label the USPS Server will return.

Object Oriented Interface

public function getLabelOption();


public function setLabelOption($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 21 );


dshippingsdk_uspsship_set($res, 21, $value );

Default Value

''

Remarks

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

Data Type

String

Machinable Property (DShippingSDK_USPSShip Class)

Indicates if shipment is machinable or not.

Object Oriented Interface

public function getMachinable();


public function setMachinable($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 22 );


dshippingsdk_uspsship_set($res, 22, $value );

Default Value

0

Remarks

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

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

Possible values are as follows:

Data Type

Integer

MailingLocation Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getMailingLocation();


public function setMailingLocation($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 23 );


dshippingsdk_uspsship_set($res, 23, $value );

Default Value

''

Remarks

The value of this property is optional.

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

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

Data Type

String

NotifyCount Property (DShippingSDK_USPSShip Class)

The number of records in the Notify arrays.

Object Oriented Interface

public function getNotifyCount();


public function setNotifyCount($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 24 );


dshippingsdk_uspsship_set($res, 24, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyEmail
• NotifyName
• NotifyType

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

This property is not available at design time.

Data Type

Integer

NotifyEmail Property (DShippingSDK_USPSShip Class)

Email address of the recipient to be notified.

Object Oriented Interface

public function getNotifyEmail($notifyidx);


public function setNotifyEmail($notifyidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 26 , $notifyidx);


dshippingsdk_uspsship_set($res, 26, $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

NotifyName Property (DShippingSDK_USPSShip Class)

The name associated with the notification.

Object Oriented Interface

public function getNotifyName($notifyidx);


public function setNotifyName($notifyidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 28 , $notifyidx);


dshippingsdk_uspsship_set($res, 28, $value , $notifyidx);

Default Value

''

Remarks

The name associated with the notification.

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

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

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

This property is not available at design time.

Data Type

String

NotifyType Property (DShippingSDK_USPSShip Class)

Identifies the set of valid email notification recipient types.

Object Oriented Interface

public function getNotifyType($notifyidx);


public function setNotifyType($notifyidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 30 , $notifyidx);


dshippingsdk_uspsship_set($res, 30, $value , $notifyidx);

Default Value

0

Remarks

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

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

For USPS, only the rtShipper and rtRecipient are valid.

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

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

This property is not available at design time.

Data Type

Integer

PackageLocation Property (DShippingSDK_USPSShip Class)

The location of pickup.

Object Oriented Interface

public function getPackageLocation();


public function setPackageLocation($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 31 );


dshippingsdk_uspsship_set($res, 31, $value );

Default Value

0

Remarks

This property is required when the following methods are called:

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

and it is retrieved in the:

• PickupInquiry method call.

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

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

Data Type

Integer

PackageCount Property (DShippingSDK_USPSShip Class)

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 32 );


dshippingsdk_uspsship_set($res, 32, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

PackageCODAmount Property (DShippingSDK_USPSShip Class)

The COD monetary value for the package.

Object Oriented Interface

public function getPackageCODAmount($packageidx);


public function setPackageCODAmount($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 34 , $packageidx);


dshippingsdk_uspsship_set($res, 34, $value , $packageidx);

Default Value

''

Remarks

The COD monetary value for the package.

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

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

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

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

This property is not applicable to USPS packages.

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

This is not applicable for Canada Post.

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

This property is not available at design time.

Data Type

String

PackageCODType Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPackageCODType($packageidx);


public function setPackageCODType($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 37 , $packageidx);


dshippingsdk_uspsship_set($res, 37, $value , $packageidx);

Default Value

0

Remarks

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

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

Valid values are:

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

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

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

This property is not available at design time.

Data Type

Integer

PackageDescription Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPackageDescription($packageidx);


public function setPackageDescription($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 40 , $packageidx);


dshippingsdk_uspsship_set($res, 40, $value , $packageidx);

Default Value

''

Remarks

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

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

This does not apply for USPS and Canada Post.

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

This property is not available at design time.

Data Type

String

PackageGirth Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPackageGirth($packageidx);


public function setPackageGirth($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 41 , $packageidx);


dshippingsdk_uspsship_set($res, 41, $value , $packageidx);

Default Value

0

Remarks

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

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

PackageHeight Property (DShippingSDK_USPSShip Class)

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 42 , $packageidx);


dshippingsdk_uspsship_set($res, 42, $value , $packageidx);

Default Value

0

Remarks

The height of the package to be shipped.

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

This property is not available at design time.

Data Type

Integer

PackageId Property (DShippingSDK_USPSShip Class)

An 8-digit Unique Parcel Identification Number.

Object Oriented Interface

public function getPackageId($packageidx);


public function setPackageId($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 43 , $packageidx);


dshippingsdk_uspsship_set($res, 43, $value , $packageidx);

Default Value

''

Remarks

An 8-digit Unique Parcel Identification Number.

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

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

This property is not available at design time.

Data Type

String

PackageInsuredValue Property (DShippingSDK_USPSShip Class)

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 44 , $packageidx);


dshippingsdk_uspsship_set($res, 44, $value , $packageidx);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

PackageLength Property (DShippingSDK_USPSShip Class)

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 45 , $packageidx);


dshippingsdk_uspsship_set($res, 45, $value , $packageidx);

Default Value

0

Remarks

The length of the package to be shipped.

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

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

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

This property is not available at design time.

Data Type

Integer

PackageNetCharge Property (DShippingSDK_USPSShip Class)

Actual Net Charge applicable to this package.

Object Oriented Interface

public function getPackageNetCharge($packageidx);


public function setPackageNetCharge($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 46 , $packageidx);


dshippingsdk_uspsship_set($res, 46, $value , $packageidx);

Default Value

''

Remarks

Actual Net Charge applicable to this package.

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

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

PackageType Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPackageType($packageidx);


public function setPackageType($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 47 , $packageidx);


dshippingsdk_uspsship_set($res, 47, $value , $packageidx);

Default Value

0

Remarks

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

Possible values are:

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

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

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

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

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

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

Also the following restrictions apply when using UPS Mail Innovations:

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

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

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

This property is not available at design time.

Data Type

Integer

PackageShippingLabel Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPackageShippingLabel($packageidx);

Procedural Interface

dshippingsdk_uspsship_get($res, 52 , $packageidx);

Default Value

''

Remarks

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

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

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

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

Data Type

Binary String

PackageShippingLabelFile Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPackageShippingLabelFile($packageidx);


public function setPackageShippingLabelFile($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 53 , $packageidx);


dshippingsdk_uspsship_set($res, 53, $value , $packageidx);

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

PackageSignatureType Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPackageSignatureType($packageidx);


public function setPackageSignatureType($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 55 , $packageidx);


dshippingsdk_uspsship_set($res, 55, $value , $packageidx);

Default Value

0

Remarks

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

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

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

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

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

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

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

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

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

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

This does not apply for Canada Post.

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

This property is not available at design time.

Data Type

Integer

PackageSize Property (DShippingSDK_USPSShip Class)

Size of the package being mailed.

Object Oriented Interface

public function getPackageSize($packageidx);


public function setPackageSize($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 56 , $packageidx);


dshippingsdk_uspsship_set($res, 56, $value , $packageidx);

Default Value

0

Remarks

Size of the package being mailed.

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

See below for valid entries:

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

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

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

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

This property is not available at design time.

Data Type

Integer

PackageTrackingNumber Property (DShippingSDK_USPSShip Class)

Tracking number assigned to this package.

Object Oriented Interface

public function getPackageTrackingNumber($packageidx);

Procedural Interface

dshippingsdk_uspsship_get($res, 60 , $packageidx);

Default Value

''

Remarks

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

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

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

Data Type

String

PackageWeight Property (DShippingSDK_USPSShip Class)

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 61 , $packageidx);


dshippingsdk_uspsship_set($res, 61, $value , $packageidx);

Default Value

'0.0'

Remarks

Weight of this package.

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

PackageWidth Property (DShippingSDK_USPSShip Class)

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_uspsship_get($res, 62 , $packageidx);


dshippingsdk_uspsship_set($res, 62, $value , $packageidx);

Default Value

0

Remarks

The width of the package to be shipped.

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

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

This property is not available at design time.

Data Type

Integer

PermitIssuingPOCity Property (DShippingSDK_USPSShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getPermitIssuingPOCity();


public function setPermitIssuingPOCity($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 66 );


dshippingsdk_uspsship_set($res, 66, $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

PermitIssuingPOState Property (DShippingSDK_USPSShip Class)

State or province code.

Object Oriented Interface

public function getPermitIssuingPOState();


public function setPermitIssuingPOState($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 68 );


dshippingsdk_uspsship_set($res, 68, $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

PermitIssuingPOZipCode Property (DShippingSDK_USPSShip Class)

Postal code.

Object Oriented Interface

public function getPermitIssuingPOZipCode();


public function setPermitIssuingPOZipCode($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 69 );


dshippingsdk_uspsship_set($res, 69, $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 PermitIssuingPOCity and PermitIssuingPOState are not present.

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

Data Type

String

PermitNumber Property (DShippingSDK_USPSShip Class)

Permit number to print Postage Due labels.

Object Oriented Interface

public function getPermitNumber();


public function setPermitNumber($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 70 );


dshippingsdk_uspsship_set($res, 70, $value );

Default Value

''

Remarks

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

Data Type

String

PostageDueAddress1 Property (DShippingSDK_USPSShip Class)

Street name.

Object Oriented Interface

public function getPostageDueAddress1();


public function setPostageDueAddress1($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 71 );


dshippingsdk_uspsship_set($res, 71, $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 PostageDueAddress1 should not exceed 35 characters.

Data Type

String

PostageDueCity Property (DShippingSDK_USPSShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getPostageDueCity();


public function setPostageDueCity($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 74 );


dshippingsdk_uspsship_set($res, 74, $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

PostageDueState Property (DShippingSDK_USPSShip Class)

State or province code.

Object Oriented Interface

public function getPostageDueState();


public function setPostageDueState($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 76 );


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

PostageDueZipCode Property (DShippingSDK_USPSShip Class)

Postal code.

Object Oriented Interface

public function getPostageDueZipCode();


public function setPostageDueZipCode($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 77 );


dshippingsdk_uspsship_set($res, 77, $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 PostageDueCity and PostageDueState are not present.

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

Data Type

String

PostageProvider Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPostageProvider();


public function setPostageProvider($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 78 );


dshippingsdk_uspsship_set($res, 78, $value );

Default Value

0

Remarks

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

• Set USPSUserId
• Set USPSPassword
• Set USPSServer

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

For Production

• Set USPSAccountNumber
• Set USPSPassword

For Testing

• Set EndiciaTestMode

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

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

Data Type

Integer

PostalZone Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPostalZone();

Procedural Interface

dshippingsdk_uspsship_get($res, 79 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

PriceOption Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getPriceOption();


public function setPriceOption($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 80 );


dshippingsdk_uspsship_set($res, 80, $value );

Default Value

2

Remarks

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

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

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

Possible values are as follows:

Data Type

Integer

ProxyAuthScheme Property (DShippingSDK_USPSShip 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_uspsship_get($res, 81 );


dshippingsdk_uspsship_set($res, 81, $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_USPSShip 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_uspsship_get($res, 82 );


dshippingsdk_uspsship_set($res, 82, $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_USPSShip 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_uspsship_get($res, 83 );


dshippingsdk_uspsship_set($res, 83, $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_USPSShip 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_uspsship_get($res, 84 );


dshippingsdk_uspsship_set($res, 84, $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_USPSShip 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_uspsship_get($res, 85 );


dshippingsdk_uspsship_set($res, 85, $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_USPSShip 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_uspsship_get($res, 86 );


dshippingsdk_uspsship_set($res, 86, $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_USPSShip Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 87 );


dshippingsdk_uspsship_set($res, 87, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

RecipientAddress1 Property (DShippingSDK_USPSShip Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 88 );


dshippingsdk_uspsship_set($res, 88, $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_USPSShip 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_uspsship_get($res, 89 );


dshippingsdk_uspsship_set($res, 89, $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

RecipientCity Property (DShippingSDK_USPSShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 91 );


dshippingsdk_uspsship_set($res, 91, $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_USPSShip Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 92 );


dshippingsdk_uspsship_set($res, 92, $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_USPSShip Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 93 );


dshippingsdk_uspsship_set($res, 93, $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_USPSShip Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 94 );


dshippingsdk_uspsship_set($res, 94, $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_USPSShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getRecipientCompany();


public function setRecipientCompany($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 95 );


dshippingsdk_uspsship_set($res, 95, $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_USPSShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getRecipientEmail();


public function setRecipientEmail($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 96 );


dshippingsdk_uspsship_set($res, 96, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientFax Property (DShippingSDK_USPSShip Class)

Recipient's fax number.

Object Oriented Interface

public function getRecipientFax();


public function setRecipientFax($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 97 );


dshippingsdk_uspsship_set($res, 97, $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_USPSShip Class)

Sender's first name.

Object Oriented Interface

public function getRecipientFirstName();


public function setRecipientFirstName($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 98 );


dshippingsdk_uspsship_set($res, 98, $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_USPSShip Class)

Person's last name.

Object Oriented Interface

public function getRecipientLastName();


public function setRecipientLastName($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 99 );


dshippingsdk_uspsship_set($res, 99, $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_USPSShip Class)

Middle initial.

Object Oriented Interface

public function getRecipientMiddleInitial();


public function setRecipientMiddleInitial($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 100 );


dshippingsdk_uspsship_set($res, 100, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (DShippingSDK_USPSShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getRecipientPhone();


public function setRecipientPhone($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 101 );


dshippingsdk_uspsship_set($res, 101, $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

RMABarcode Property (DShippingSDK_USPSShip Class)

Indicates whether to print the RMANumber as a barcode on the label.

Object Oriented Interface

public function getRMABarcode();


public function setRMABarcode($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 102 );


dshippingsdk_uspsship_set($res, 102, $value );

Default Value

false

Remarks

The RMA number entered by the user through the RMANumber property can also appear as a US128C barcode on the label. If you wish to see the number displayed as a barcode on the label, set this property to True. Enter False if no barcode is desired.

Data Type

Boolean

RMANumber Property (DShippingSDK_USPSShip Class)

Return Materials Authorization number.

Object Oriented Interface

public function getRMANumber();


public function setRMANumber($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 103 );


dshippingsdk_uspsship_set($res, 103, $value );

Default Value

''

Remarks

The value of this optional property may be any combination of alphanumerical characters, up to a maximum length of 30. If entered, this number will appear on the Return Label.

Assigning an RMA number to each package at the time an agreement is made with a customer (to have merchandise returned), enables retailers to provide a closed-loop correlation between receipt of returned packages and records of the order, typically kept in an order-processing database.

Data Type

String

SenderAddress1 Property (DShippingSDK_USPSShip Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 104 );


dshippingsdk_uspsship_set($res, 104, $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_USPSShip 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_uspsship_get($res, 105 );


dshippingsdk_uspsship_set($res, 105, $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_USPSShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 107 );


dshippingsdk_uspsship_set($res, 107, $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

SenderState Property (DShippingSDK_USPSShip Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 109 );


dshippingsdk_uspsship_set($res, 109, $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_USPSShip Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 110 );


dshippingsdk_uspsship_set($res, 110, $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_USPSShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getSenderCompany();


public function setSenderCompany($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 111 );


dshippingsdk_uspsship_set($res, 111, $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_USPSShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getSenderEmail();


public function setSenderEmail($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 112 );


dshippingsdk_uspsship_set($res, 112, $value );

Default Value

''

Remarks

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

Data Type

String

SenderFax Property (DShippingSDK_USPSShip Class)

Recipient's fax number.

Object Oriented Interface

public function getSenderFax();


public function setSenderFax($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 113 );


dshippingsdk_uspsship_set($res, 113, $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_USPSShip Class)

Sender's first name.

Object Oriented Interface

public function getSenderFirstName();


public function setSenderFirstName($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 114 );


dshippingsdk_uspsship_set($res, 114, $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_USPSShip Class)

Person's last name.

Object Oriented Interface

public function getSenderLastName();


public function setSenderLastName($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 115 );


dshippingsdk_uspsship_set($res, 115, $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_USPSShip Class)

Middle initial.

Object Oriented Interface

public function getSenderMiddleInitial();


public function setSenderMiddleInitial($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 116 );


dshippingsdk_uspsship_set($res, 116, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (DShippingSDK_USPSShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getSenderPhone();


public function setSenderPhone($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 117 );


dshippingsdk_uspsship_set($res, 117, $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

SeparateReceipt Property (DShippingSDK_USPSShip Class)

Indicates whether you want the shipping label and Customer Online Label Record be printed on two separate pages.

Object Oriented Interface

public function getSeparateReceipt();


public function setSeparateReceipt($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 118 );


dshippingsdk_uspsship_set($res, 118, $value );

Default Value

false

Remarks

The value of this property is optional on all methods calls. Use SeparateReceipt property to request shipping label & Customer Online Record be printed on 2 separate pages. Enter True if you want this option, or False is you want those to be printed on the same single page. False is assumed if no value is entered.

Data Type

Boolean

ServiceType Property (DShippingSDK_USPSShip Class)

Identifies the USPS service type (applicable to US domestic shipments) to use in a ship request.

Object Oriented Interface

public function getServiceType();


public function setServiceType($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 119 );


dshippingsdk_uspsship_set($res, 119, $value );

Default Value

0

Remarks

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

Valid values for USPS are:

Please note that the ServiceType stUSPSBPM (74) is no longer supported by Endicia.

This property is not available at design time.

Data Type

Integer

ShipDate Property (DShippingSDK_USPSShip Class)

Date package will be mailed.

Object Oriented Interface

public function getShipDate();


public function setShipDate($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 120 );


dshippingsdk_uspsship_set($res, 120, $value );

Default Value

''

Remarks

You can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. For USPS, the ship date may be today plus 0 to 3 days in advance. Enter the date in either format: yyyy-MM-dd, such as 2022-08-14, or MM/dd/yyyy, such as 08/14/2022.

This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.

Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2022-08-14.

This property is also returned after the following carrier pickup methods are called:

• PickupAvailability
• SchedulePickup
• ChangePickup
• PickupInquiry

This indicates the date on which the packages will be picked up from the specified location.

Data Type

String

ShipmentSpecialServices Property (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 121 );


dshippingsdk_uspsship_set($res, 121, $value );

Default Value

0

Remarks

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

Data Type

Long64

SSLAcceptServerCertEncoded Property (DShippingSDK_USPSShip Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 123 );


dshippingsdk_uspsship_set($res, 123, $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_USPSShip Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 151 );


dshippingsdk_uspsship_set($res, 151, $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_USPSShip 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_uspsship_get($res, 167 );


dshippingsdk_uspsship_set($res, 167, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_USPSShip 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_uspsship_get($res, 168 );


dshippingsdk_uspsship_set($res, 168, $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_USPSShip Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 169 );


dshippingsdk_uspsship_set($res, 169, $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_USPSShip 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_uspsship_get($res, 170 );


dshippingsdk_uspsship_set($res, 170, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DShippingSDK_USPSShip Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 178 );


dshippingsdk_uspsship_set($res, 178, $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_USPSShip Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_uspsship_get($res, 180 );

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

StandardizeAddress Property (DShippingSDK_USPSShip Class)

Checks the delivery address against the USPS Address Matching System.

Object Oriented Interface

public function getStandardizeAddress();


public function setStandardizeAddress($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 207 );


dshippingsdk_uspsship_set($res, 207, $value );

Default Value

false

Remarks

Set StandardizeAddress to True if you want the class to check the delivery address for accuracy. Identified errors will be returned to allow you to correct them.

Data Type

Boolean

Timeout Property (DShippingSDK_USPSShip Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 208 );


dshippingsdk_uspsship_set($res, 208, $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

TotalWeight Property (DShippingSDK_USPSShip Class)

The estimated weight for the package to be picked up.

Object Oriented Interface

public function getTotalWeight();


public function setTotalWeight($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 209 );


dshippingsdk_uspsship_set($res, 209, $value );

Default Value

0

Remarks

Enter the total estimated aggregate weight (in pounds) of all packages being picked up.

This property is required when the following methods are called:

• SchedulePickup
• ChangePickup

and retrieved in the:

• PickupInquiry method call.

Data Type

Integer

TransactionId Property (DShippingSDK_USPSShip Class)

The transaction Id.

Object Oriented Interface

public function getTransactionId();


public function setTransactionId($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 210 );


dshippingsdk_uspsship_set($res, 210, $value );

Default Value

''

Remarks

This property is only used for Endicia labels, and is defined as a unique Id for the partner's end-user's transaction. This can be an invoice number or transaction number.

Data Type

String

USPSAccountNumber Property (DShippingSDK_USPSShip Class)

The shipper's Endicia account number.

Object Oriented Interface

public function getUSPSAccountNumber();


public function setUSPSAccountNumber($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 211 );


dshippingsdk_uspsship_set($res, 211, $value );

Default Value

''

Remarks

The shipper's Endicia account number.

This property is only used when shipping with Endicia and will take a production account number. During testing please set EndiciaTestMode which will automatically use a sandbox account. During testing this property does not need to be set.

Data Type

String

USPSPassword Property (DShippingSDK_USPSShip Class)

Password to use for logging in to the USPS Server .

Object Oriented Interface

public function getUSPSPassword();


public function setUSPSPassword($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 212 );


dshippingsdk_uspsship_set($res, 212, $value );

Default Value

''

Remarks

Password to use for logging in to the USPS Server.

This password is provided to you by USPS when you register for service. The password is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Note, the Password property has been depreciated by USPS, and remains only for backwards compatibility.

When PostageProvider has been set to ppEndicia, this must be the pass phrase associated with your postage account that was supplied to you by Endicia upon registration.

Data Type

String

USPSServer Property (DShippingSDK_USPSShip Class)

URL for the USPS server where the requests are sent.

Object Oriented Interface

public function getUSPSServer();


public function setUSPSServer($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 213 );


dshippingsdk_uspsship_set($res, 213, $value );

Default Value

'https://secure.shippingapis.com/ShippingAPI.dll'

Remarks

URL for the USPS server where the requests are sent.

When PostageProvider has been set to ppEndicia, the live production URL will be set automatically. For testing please set EndiciaTestMode.

When PostageProvider has been set to ppStamps, the live production URL will be set automatically. For testing please set StampsTestMode.

There are two different live and test URLs that have been provided by the US Postal service for use with the Webtools APIs (and these classs). There is one plaintext URL and one SSL-secured URL for both live and testing. These URLs are listed below, along with the classs that use them.

Live Servers:

Test Servers:

These test servers return CANNED RESPONSES. They will only accept a specific set of data, and will only return one pre-formed response. Any transaction that does not contain the exact data they expect will cause an error to be generated. Because of these limitations we strongly recommend you test using a live account.

Note that the label components must use the live server for testing, but with the Certify configuration setting set to True. There is no need to set Certify with Endicia or Stamps.com. Set EndiciaTestMode or StampsTestMode instead.

Data Type

String

USPSUserId Property (DShippingSDK_USPSShip Class)

User Id for logging in to the USPS WebTools or Stamps.

Object Oriented Interface

public function getUSPSUserId();


public function setUSPSUserId($value);

Procedural Interface

dshippingsdk_uspsship_get($res, 214 );


dshippingsdk_uspsship_set($res, 214, $value );

Default Value

''

Remarks

User Id for logging in to the USPS WebTools or Stamps.com Server.

This User Id is provided to you by USPS or Stamps.com when you register for service. The UserId is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. During testing set StampsTestMode to use the built-in sandbox account. This field is not used by Endicia.

Data Type

String

CancelPackage Method (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function doCancelPackage($barcodenumber);

Procedural Interface

dshippingsdk_uspsship_do_cancelpackage($res, $barcodenumber);

Remarks

The Cancel request allows an eVS label to be removed from processing. This functionality is available only if the eVS label is pending inclusion in the Shipping Services.

The BarcodeNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the PackageTrackingNumber assigned to the package by USPS server when the GetPackageLabel method was called.

If the BarcodeNumber entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from USPS about the request to cancel the eVS Label.

CancelPickup Method (DShippingSDK_USPSShip Class)

Cancels a scheduled Carrier Pickup request.

Object Oriented Interface

public function doCancelPickup($confirmationnumber);

Procedural Interface

dshippingsdk_uspsship_do_cancelpickup($res, $confirmationnumber);

Remarks

When the CancelPickup method is called, the exact data from the original SchedulePickup request must be entered.

You must enter the following information:

• ConfirmationNumber (required)
• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode(required)

The confirmation number alone cannot be used to cancel or change a scheduled pickup. You must also supply address information that is identical to what was originally entered when the pickup was scheduled with SchedulePickup.

If the information entered is valid (matches the existing record and is within the time frames available for cancellation), this method fills the original pickup address and tracking number as well as the Status property.

You may submit your cancellation to your pickup request anytime before 2:00 AM CST on the day of pickup to take effect. Otherwise, your Carrier Pickup request cannot be canceled online.

If you miss the deadline for canceling your pickup, or if you did not save the ConfirmationNumber or address information, you should put a note at the PackageLocation you specified in the original SchedulePickup request explaining that you wish to cancel the pickup.

The return value for this method is a string containing the status of the cancellation.

ChangePickup Method (DShippingSDK_USPSShip Class)

Changes requested data in your original Pickup Schedule request and schedules a new pickup.

Object Oriented Interface

public function doChangePickup($confirmationnumber);

Procedural Interface

dshippingsdk_uspsship_do_changepickup($res, $confirmationnumber);

Remarks

When the ChangePickup method is called, the exact data from the original SchedulePickup request must be entered, with whatever changes you wish to enter. It is recommended that you first send a PickupInquiry to fill all the properties, edit the property you wish to change, and then submit a ChangePickup request.

At the minimum, you must enter the pickup address information, number of packages for the service requested, estimated weight, package location, weight, special pickup instructions and confirmation number. The confirmation number alone cannot be used to cancel or change a scheduled pickup.

The name and phone number of the sender can be changed, along with the number and types of package services, weight, and the location of the pickup.

Address data and the confirmation number cannot be changed and must be identical to the original SchedulePickup request (supplied to and returned by SchedulePickup method when first called).

After a successful call, this method fills the following properties:

• ConfirmationNumber (required)
• SenderFirstName (required)
• SenderLastName (required)
• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode(required)
• SenderPhone (optional)
• TotalWeight (required - value may be changed from the original request)
• CountExpress (optional if CountPriority is provided - value may be changed from the original request)
• CountPriority (optional if CountExpress is provided - value may be changed from the original request)
• CountInternational (optional - value may be changed from the original request)
• CountOther (optional - value may be changed from the original request)
• PackageLocation (required - value may be changed from the original request)
• SpecialInstructions (optional - value may be changed from the original request)

To verify the accuracy of your data, you can call the PickupInquiry method. However, the confirmation number cannot be retrieved online. If you need to change or cancel your Carrier Pickup request, please leave notification (at the Package Location you indicated in your Carrier Pickup request) that provides details of your Carrier Pickup change or cancellation.

If the information entered is valid (matches the existing record and is within the time frames available for pickup change), this method will return the Status of the request and fill the sender's information and pickup address (properties listed above), and also the following properties:

• TotalWeight
• CountExpress
• CountPriority
• CountInternational
• CountOther
• PackageLocation
• SpecialInstructions
• ConfirmationNumber
• ShipDate
• CarrierRoute

You may submit your changes to your pickup request anytime before 2:00 AM CST on the day of pickup to take effect. Otherwise, your Carrier Pickup request cannot be changed online.

Config Method (DShippingSDK_USPSShip Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetPackageLabel Method (DShippingSDK_USPSShip Class)

Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.

Object Oriented Interface

public function doGetPackageLabel();

Procedural Interface

dshippingsdk_uspsship_do_getpackagelabel($res);

Remarks

When this method is called, the following properties are used to construct the request:

• USPSServer (required)
• USPSAccountNumber (required for Endicia shipments)
• USPSUserId (required)
• USPSPassword (required)
• LabelImageType (required)
• SenderAddress (required)
• SenderContact (optional)
• RecipientAddress (required)
• RecipientContact (optional)
• Packages (required)
• ServiceType (required)
• ExtraServices (optional)
• Contents (required)
• ContentDescription (optional)
• PriceOption (optional)
• Machinable (optional)
• DeliveryOption (optional)
• Notify (optional)
• PackageNumber (optional)
• TotalPackages (optional)
• ShipDate (optional)
• HoldForManifest (optional)
• MailingLocation (optional)
• CustomerId (optional)
• CRID (optional)
• MID (optional)
• LogisticsManagerMID (optional)

This method fills in the following properties:

• PackageTrackingNumber
• BarcodeNumber
• PackageShippingLabel
• PackageNetCharge (only for Endicia and Express labels);
• ShipDate (only for Endicia)
• CustomerReceipt

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

PickupAvailability Method (DShippingSDK_USPSShip Class)

Checks the availability of a Carrier Pickup service for the given address.

Object Oriented Interface

public function doPickupAvailability();

Procedural Interface

dshippingsdk_uspsship_do_pickupavailability($res);

Remarks

The PickupAvailability method requires the values for the following properties:

• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode (either the ZipCode or City and State are required)

After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your packages:

• ShipDate
• CarrierRoute

PickupInquiry Method (DShippingSDK_USPSShip Class)

Retrieves the data submitted in your original SchedulePickup request.

Object Oriented Interface

public function doPickupInquiry($confirmationnumber);

Procedural Interface

dshippingsdk_uspsship_do_pickupinquiry($res, $confirmationnumber);

Remarks

This method requires: the exact pickup address and confirmation number returned in the SchedulePickup request (when the SchedulePickup method was called). This method will fill the following properties:

• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode (either the ZipCode or City and State are required)
• ConfirmationNumber (required)

On valid request, returns the information that was originally entered in SchedulePickup call: the sender's information and pickup address (properties listed above) and also the following:

• TotalWeight
• CountExpress
• CountPriority
• CountInternational
• CountOther
• ShipDate
• ConfirmationNumber
• PackageLocation
• SpecialInstructions

The PickupInquiry method is very useful for the ChangePickup request. PickupInquiry will retrieve the data from your original request, and you can then change whatever properties you like and then call ChangePickup.

Reset Method (DShippingSDK_USPSShip Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_uspsship_do_reset($res);

Remarks

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

SchedulePickup Method (DShippingSDK_USPSShip Class)

Schedules a Carrier Pickup and provides the user a confirmation number for the scheduled pickup.

Object Oriented Interface

public function doSchedulePickup();

Procedural Interface

dshippingsdk_uspsship_do_schedulepickup($res);

Remarks

This method allows users to make a Carrier Pickup request.

The SchedulePickup method requires the values for the following properties:

• SenderFirstName (required)
• SenderLastName (required)
• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode(required)
• SenderPhone (required)
• TotalWeight (required)
• CountExpress (optional if CountPriority is provided)
• CountPriority (optional if CountExpress is provided)
• CountInternational (optional)
• CountOther (optional)
• PackageLocation (required)
• SpecialInstructions (optional)

After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your

• ShipDate
• CarrierRoute

Prior to making a SchedulePickup call, it is recommended to first call the PickupAvailability method to confirm that the pickup service is available.

There must be at least one Express Mail Package or Priority Mail package to make this call a valid request. Either one of the CountPriority, CountExpress, CountInternational or CountOther properties are required for a valid request.

The Confirmation Number will be returned after a successful request.

Error Event (DShippingSDK_USPSShip Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_uspsship_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_USPSShip Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_uspsship_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_USPSShip Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

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

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

SSLStatus Event (DShippingSDK_USPSShip Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

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

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

USPSShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (USPSShip Class)

USPSShip Errors

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

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

SOAP Errors

	169   Invalid param index (out of range).
	170   Invalid namespace index (out of range).
	171   Method not found. Please specify a valid Method.
	172   No method URI. Please specify a valid MethodURI.
	173   SOAP Fault. See FaultCode and/or FaultString for details.

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

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.