FedExShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a FedEx shipping label for any of FedEx domestic services complete with addresses and barcode, cancel a shipment or close out the FedEx Ground shipments.

Class Name

DShippingSDK_FedExShip

Procedural Interface

 dshippingsdk_fedexship_open();
 dshippingsdk_fedexship_close($res);
 dshippingsdk_fedexship_register_callback($res, $id, $function);
 dshippingsdk_fedexship_get_last_error($res);
 dshippingsdk_fedexship_get_last_error_code($res);
 dshippingsdk_fedexship_set($res, $id, $index, $value);
 dshippingsdk_fedexship_get($res, $id, $index);
 dshippingsdk_fedexship_do_cancelpickup($res, $confirmationnumber);
 dshippingsdk_fedexship_do_cancelshipment($res, $trackingnumber);
 dshippingsdk_fedexship_do_closegroundshipments($res);
 dshippingsdk_fedexship_do_config($res, $configurationstring);
 dshippingsdk_fedexship_do_cspversioncapture($res);
 dshippingsdk_fedexship_do_getpackagelabel($res, $index);
 dshippingsdk_fedexship_do_getshipmentlabels($res);
 dshippingsdk_fedexship_do_pickupavailability($res);
 dshippingsdk_fedexship_do_reprintdocuments($res);
 dshippingsdk_fedexship_do_reset($res);
 dshippingsdk_fedexship_do_schedulepickup($res);

Remarks

Generating a shipping label can be done by calling either the GetPackageLabel or GetShipmentLabels method. You will have to specify the package information, FedEx service to be used for shipping this package, origin and destination information, and any other special services associated with the shipment (such as Saturday Pickup, Saturday Delivery, Hold At Locations, etc.).

This class also allows you to delete packages included in the daily shipping log that have not already been tendered to FedEx by calling the CancelShipment method. The TrackingNumber parameter that identifies the shipment must be specified in the request along with the FedExDeveloperKey, FedExPassword, FedExAccountNumber, and FedExMeterNumber.

When shipping with FedEx Ground, you can close out your shipments and generate a FedEx Ground Close Manifest by calling CloseGroundShipments method.

To use this class, you must have a FedEx FedExAccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

NOTE: FedEx requires that all applications that print shipping labels pass a series of certification tests prior to being placed in production. The full version of FedEx Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package, you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.

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.

CarrierType Property (DShippingSDK_FedExShip Class)

The carrier type.

Object Oriented Interface

public function getCarrierType();


public function setCarrierType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 1 );


dshippingsdk_fedexship_set($res, 1, $value );

Default Value

1

Remarks

This specifies the carrier to be used when calling SchedulePickup, CancelPickup, or CloseSmartPostShipments.

The possible values are as follows:

Note: When calling CloseSmartPostShipments this property must be set to either ctFDXG (2) or ctFXSP (5).

Data Type

Integer

CloseDate Property (DShippingSDK_FedExShip Class)

Identifies the date up to which the unclosed FedEx Ground shipments are to be closed.

Object Oriented Interface

public function getCloseDate();


public function setCloseDate($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 2 );


dshippingsdk_fedexship_set($res, 2, $value );

Default Value

''

Remarks

Identifies the date up to which the unclosed FedEx Ground shipments are to be closed. The CloseDate and CloseTime are both required to be provided in a close operation request (when CloseGroundShipments method is called). If not provided, it will default to the current date.

This property is applicable for FedEx Ground services only. Format: YYYY-MM-DD (e.g. 2006-06-26).

Data Type

String

CloseReportFile Property (DShippingSDK_FedExShip Class)

File name of the report to be saved and/or printed by customer.

Object Oriented Interface

public function getCloseReportFile();


public function setCloseReportFile($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 3 );


dshippingsdk_fedexship_set($res, 3, $value );

Default Value

''

Remarks

File name of the report to be saved and/or printed by customer. A value (a name for the file) has to be assigned to this property if CloseReportType is set to a value other than 0 (Unspecified) when CloseGroundShipments is called. Depending on the value assigned to CloseReportType, the server response will include only one of the following reports: Manifest, MultiweightReport, COD Report or HazMatCertificate. The contents of any of these reports are written to disk in CloseReportFile. The file name must have the TXT extension.

This property is applicable for FedEx Ground services only.

Data Type

String

CloseReportType Property (DShippingSDK_FedExShip Class)

Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.

Object Oriented Interface

public function getCloseReportType();


public function setCloseReportType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 4 );


dshippingsdk_fedexship_set($res, 4, $value );

Default Value

0

Remarks

Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.

If this is set to a value other than 0 (Unspecified), the server with return that specific report from the last three closed shipping days. Otherwise, the server will return the shipment manifest along with all applicable reports.

When requesting a certain type of report, only one type can be returned per Close request. If you need multiple report types you will have to issue multiple CloseGroundShipments requests.

Valid report types are listed below:

This property is applicable for FedEx Ground services only.

NOTE: This only takes effect when calling ReprintDocuments.

Data Type

Integer

CloseTime Property (DShippingSDK_FedExShip Class)

Identifies the time up to which the unclosed FedEx Ground shipments are to be closed.

Object Oriented Interface

public function getCloseTime();


public function setCloseTime($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 5 );


dshippingsdk_fedexship_set($res, 5, $value );

Default Value

'19:00:00'

Remarks

Identifies the time up to which the unclosed FedEx Ground shipments are to be closed. The CloseDate and CloseTime are both required to be provided in a close operation request (when the CloseGroundShipments method is called).

Format: HH:MM:SS using a 24 hour clock. This property is applicable for FedEx Ground services only.

NOTE: This only takes effect when calling ReprintDocuments.

Data Type

String

CloseTrackingNumber Property (DShippingSDK_FedExShip Class)

Shipment Ground tracking number.

Object Oriented Interface

public function getCloseTrackingNumber();


public function setCloseTrackingNumber($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 6 );


dshippingsdk_fedexship_set($res, 6, $value );

Default Value

''

Remarks

Shipment Ground tracking number. Provided to obtain the manifest containing this tracking number. If you include the CloseTrackingNumber of a particular Ground shipment for which you want to print Ground reports (Manifest, C.O.D., Hazmat or Multiweight Detail), the report(s) requested in the CloseReportType element are returned.

Maximum length: 20 characters.

NOTE: This only takes effect when calling ReprintDocuments.

Data Type

String

CODLabel Property (DShippingSDK_FedExShip Class)

The label that is returned.

Object Oriented Interface

public function getCODLabel();

Procedural Interface

dshippingsdk_fedexship_get($res, 7 );

Default Value

''

Remarks

If CODLabelFile is not set the image for the COD label this will be used to store the COD label.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

This property is read-only.

Data Type

String

CODLabelFile Property (DShippingSDK_FedExShip Class)

The file the COD label should be written to.

Object Oriented Interface

public function getCODLabelFile();


public function setCODLabelFile($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 8 );


dshippingsdk_fedexship_set($res, 8, $value );

Default Value

''

Remarks

The COD label will be written to the file specified. If no file is specified then the image will be stored in memory in CODLabel.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

Data Type

String

CODTotalAmount Property (DShippingSDK_FedExShip Class)

The total amount to be collected on delivery.

Object Oriented Interface

public function getCODTotalAmount();


public function setCODTotalAmount($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 9 );


dshippingsdk_fedexship_set($res, 9, $value );

Default Value

''

Remarks

This indicates customer's total COD amount (prior to any accumulations: total collection amount minus transportation charges). The CODTotalAmount is required to be provided in a ship request only if the corresponding flag of COD is contained in the ShipmentSpecialServices property.

For Ground COD shipments, the COD amount must be included on each package that uses COD service by setting the PackageCODAmount and the corresponding flag of COD is contained in the PackageSpecialServices field.

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

Data Type

String

CODTrackingNumber Property (DShippingSDK_FedExShip Class)

Contains the tracking number for the COD return shipment.

Object Oriented Interface

public function getCODTrackingNumber();

Procedural Interface

dshippingsdk_fedexship_get($res, 10 );

Default Value

''

Remarks

When shipping COD via any of the domestic FedEx Express services, this is returned in the server response. This value can then be used to track the COD return package.

This property is read-only.

Data Type

String

CODType Property (DShippingSDK_FedExShip Class)

COD type.

Object Oriented Interface

public function getCODType();


public function setCODType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 11 );


dshippingsdk_fedexship_set($res, 11, $value );

Default Value

0

Remarks

This property identifies the type of funds FedEx should collect upon package delivery. It is required to be provided in a ship request only if the COD is present (requested) in the ShipmentSpecialServices.

Possible values are as follows:

Data Type

Integer

CompanyCloseTime Property (DShippingSDK_FedExShip Class)

The time your company closes.

Object Oriented Interface

public function getCompanyCloseTime();


public function setCompanyCloseTime($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 12 );


dshippingsdk_fedexship_set($res, 12, $value );

Default Value

''

Remarks

This property is required for PickupAvailability and SchedulePickup requests. The ShipTime can be used to set the ready time stamp for the pickup. The ShipTime and the CompanyCloseTime must allow a long enough time period for the pickup to occur.

Data Type

String

DeliveryDate Property (DShippingSDK_FedExShip Class)

Date on which shipment is expected to be delivered.

Object Oriented Interface

public function getDeliveryDate();

Procedural Interface

dshippingsdk_fedexship_get($res, 13 );

Default Value

''

Remarks

When either the GetPackageLabel or the GetShipmentLabels method is called, the DeliveryDate will be returned in the server reply. For international shipments, this information is limited to a number of international countries.

This property is read-only.

Data Type

String

FedExAccountNumber Property (DShippingSDK_FedExShip Class)

Account number for logging in to the FedEx Server .

Object Oriented Interface

public function getFedExAccountNumber();


public function setFedExAccountNumber($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 14 );


dshippingsdk_fedexship_set($res, 14, $value );

Default Value

''

Remarks

Account number for logging in to the FedEx Server. An FedExAccountNumber and FedExMeterNumber will be required with each input request a user makes to a FedEx server.

The FedExAccountNumber 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.

For all transaction whether they are Ground or Express service, you will need to pass your valid 9 digit FedEx account number.

Data Type

String

FedExAuthorizationToken Property (DShippingSDK_FedExShip Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getFedExAuthorizationToken();


public function setFedExAuthorizationToken($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 15 );


dshippingsdk_fedexship_set($res, 15, $value );

Default Value

''

Remarks

Authorization Token used to authenticate the request.

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

Data Type

String

FedExCSPProductId Property (DShippingSDK_FedExShip Class)

Identifies the CSP product.

Object Oriented Interface

public function getFedExCSPProductId();


public function setFedExCSPProductId($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 16 );


dshippingsdk_fedexship_set($res, 16, $value );

Default Value

''

Remarks

Identifies the CSP product.

This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: FedExAccountNumber, FedExMeterNumber, FedExDeveloperKey, FedExPassword, FedExCSPUserKey, FedExCSPUserPassword and FedExCSPProductVersion.

Data Type

String

FedExCSPProductVersion Property (DShippingSDK_FedExShip Class)

Identifies the CSP product version.

Object Oriented Interface

public function getFedExCSPProductVersion();


public function setFedExCSPProductVersion($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 17 );


dshippingsdk_fedexship_set($res, 17, $value );

Default Value

''

Remarks

Identifies the CSP product version.

This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: FedExAccountNumber, FedExMeterNumber, FedExDeveloperKey, FedExPassword, FedExCSPUserKey, FedExCSPUserPassword and FedExCSPProductId.

Data Type

String

FedExCSPUserKey Property (DShippingSDK_FedExShip Class)

CSP end user key.

Object Oriented Interface

public function getFedExCSPUserKey();


public function setFedExCSPUserKey($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 18 );


dshippingsdk_fedexship_set($res, 18, $value );

Default Value

''

Remarks

CSP end user key.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique FedExCSPUserKey and FedExCSPUserPassword that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (FedExDeveloperKey and FedExPassword respectively).

Data Type

String

FedExCSPUserPassword Property (DShippingSDK_FedExShip Class)

CSP end user password.

Object Oriented Interface

public function getFedExCSPUserPassword();


public function setFedExCSPUserPassword($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 19 );


dshippingsdk_fedexship_set($res, 19, $value );

Default Value

''

Remarks

CSP end user password.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique FedExCSPUserKey and FedExCSPUserPassword that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (FedExDeveloperKey and FedExPassword respectively).

Data Type

String

FedExDeveloperKey Property (DShippingSDK_FedExShip Class)

Identifying part of the authentication key used for the sender's identity.

Object Oriented Interface

public function getFedExDeveloperKey();


public function setFedExDeveloperKey($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 20 );


dshippingsdk_fedexship_set($res, 20, $value );

Default Value

''

Remarks

Identifying part of the authentication key used for the sender's identity.

The FedExDeveloperKey is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Developer Key is provided to you by FedEx after registration and it is the publicly known part of authentication credential. The Developer Key may also be referred to as an Authentication Key.

The FedExDeveloperKey, FedExAccountNumber, FedExMeterNumber, and FedExPassword will be required with each input request a user makes to a FedEx server. This 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.

Data Type

String

FedExLanguageCode Property (DShippingSDK_FedExShip Class)

Two-letter code for the language (e.

Object Oriented Interface

public function getFedExLanguageCode();


public function setFedExLanguageCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 21 );


dshippingsdk_fedexship_set($res, 21, $value );

Default Value

'en'

Remarks

Two-letter code for the language (e.g. en, fr, etc.).

This field allows you to assign the language code. Default value is en.

Data Type

String

FedExLocaleCode Property (DShippingSDK_FedExShip Class)

Two-letter code for the region (e.

Object Oriented Interface

public function getFedExLocaleCode();


public function setFedExLocaleCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 22 );


dshippingsdk_fedexship_set($res, 22, $value );

Default Value

'US'

Remarks

Two-letter code for the region (e.g. US, CA, etc.).

Some languages require a locale code to further identify the language. Default value is US.

Data Type

String

FedExMeterNumber Property (DShippingSDK_FedExShip Class)

Meter number to use for submitting requests to the FedEx Server .

Object Oriented Interface

public function getFedExMeterNumber();


public function setFedExMeterNumber($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 23 );


dshippingsdk_fedexship_set($res, 23, $value );

Default Value

''

Remarks

Meter number to use for submitting requests to the FedEx FedExServer.

An FedExAccountNumber and FedExMeterNumber will be required with each input request a user makes to a FedEx server. The Meter Number is provided to you by FedEx when you register for service. This 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.

Data Type

String

FedExPassword Property (DShippingSDK_FedExShip Class)

Secret part of authentication key used for the sender's identity.

Object Oriented Interface

public function getFedExPassword();


public function setFedExPassword($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 24 );


dshippingsdk_fedexship_set($res, 24, $value );

Default Value

''

Remarks

Secret part of authentication key used for the sender's identity.

The FedExPassword is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Password is provided to you by FedEx after registration and it is the private part of authentication credential, known only to the user and FedEx.

The FedExDeveloperKey, FedExAccountNumber, FedExMeterNumber, and FedExPassword will be required with each input request a user makes to a FedEx server. This 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.

Data Type

String

FedExServer Property (DShippingSDK_FedExShip Class)

URL for the FedEx Server where the requests are sent.

Object Oriented Interface

public function getFedExServer();


public function setFedExServer($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 25 );


dshippingsdk_fedexship_set($res, 25, $value );

Default Value

''

Remarks

URL for the FedEx Server where the requests are sent. This is required to be provided on each transaction request sent to FedEx along with FedExAccountNumber and FedExMeterNumber.

The full URL (including the URL scheme normally https://) should be supplied. All test requests are sent over SSL.

The server URL for the production will be provided to you by FedEx after your application has been approved/certified by FedEx Web Integration Solutions team.

Data Type

String

FirewallAutoDetect Property (DShippingSDK_FedExShip 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_fedexship_get($res, 26 );


dshippingsdk_fedexship_set($res, 26, $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_FedExShip Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 27 );


dshippingsdk_fedexship_set($res, 27, $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_FedExShip 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_fedexship_get($res, 28 );


dshippingsdk_fedexship_set($res, 28, $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_FedExShip 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_fedexship_get($res, 29 );


dshippingsdk_fedexship_set($res, 29, $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_FedExShip 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_fedexship_get($res, 30 );


dshippingsdk_fedexship_set($res, 30, $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_FedExShip 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_fedexship_get($res, 31 );


dshippingsdk_fedexship_set($res, 31, $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

FreightGuaranteeDate Property (DShippingSDK_FedExShip Class)

The date the freight shipment is guaranteed for.

Object Oriented Interface

public function getFreightGuaranteeDate();


public function setFreightGuaranteeDate($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 32 );


dshippingsdk_fedexship_set($res, 32, $value );

Default Value

''

Remarks

The date the freight shipment is guaranteed for.

The valid format for the date is YYYY-MM-DD

Data Type

String

FreightGuaranteeType Property (DShippingSDK_FedExShip Class)

Specifies what type of freight guarantee is requested.

Object Oriented Interface

public function getFreightGuaranteeType();


public function setFreightGuaranteeType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 33 );


dshippingsdk_fedexship_set($res, 33, $value );

Default Value

0

Remarks

Specifies what type of freight guarantee is requested.

The valid values are:

Data Type

Integer

HazMatCertificate Property (DShippingSDK_FedExShip Class)

Image of a Hazardous Materials certification report.

Object Oriented Interface

public function getHazMatCertificate();

Procedural Interface

dshippingsdk_fedexship_get($res, 34 );

Default Value

''

Remarks

This identifies the buffer containing the Hazardous Materials certification report for FedEx Ground HazMat shipments.

When calling the CloseGroundShipments method, the HazMatCertificate is returned when CloseReportType is set to 3 (HazMat).

The report is generated in TXT format. The report will automatically be saved to disk in the file designated by CloseReportFile.

This property is applicable for FedEx Ground services only.

This property is read-only.

Data Type

Binary String

HoldAtLocationAddress1 Property (DShippingSDK_FedExShip Class)

Street name.

Object Oriented Interface

public function getHoldAtLocationAddress1();


public function setHoldAtLocationAddress1($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 35 );


dshippingsdk_fedexship_set($res, 35, $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 HoldAtLocationAddress1 should not exceed 35 characters.

Data Type

String

HoldAtLocationAddress2 Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getHoldAtLocationAddress2();


public function setHoldAtLocationAddress2($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 36 );


dshippingsdk_fedexship_set($res, 36, $value );

Default Value

''

Remarks

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

Data Type

String

HoldAtLocationCity Property (DShippingSDK_FedExShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getHoldAtLocationCity();


public function setHoldAtLocationCity($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 38 );


dshippingsdk_fedexship_set($res, 38, $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

HoldAtLocationCountryCode Property (DShippingSDK_FedExShip Class)

Country code.

Object Oriented Interface

public function getHoldAtLocationCountryCode();


public function setHoldAtLocationCountryCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 39 );


dshippingsdk_fedexship_set($res, 39, $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

HoldAtLocationState Property (DShippingSDK_FedExShip Class)

State or province code.

Object Oriented Interface

public function getHoldAtLocationState();


public function setHoldAtLocationState($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 40 );


dshippingsdk_fedexship_set($res, 40, $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

HoldAtLocationZipCode Property (DShippingSDK_FedExShip Class)

Postal code.

Object Oriented Interface

public function getHoldAtLocationZipCode();


public function setHoldAtLocationZipCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 41 );


dshippingsdk_fedexship_set($res, 41, $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 HoldAtLocationCity and HoldAtLocationState are not present.

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

Data Type

String

HoldAtLocationContactCompany Property (DShippingSDK_FedExShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getHoldAtLocationContactCompany();


public function setHoldAtLocationContactCompany($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 42 );


dshippingsdk_fedexship_set($res, 42, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either HoldAtLocationContactFirstName and HoldAtLocationContactLastName or HoldAtLocationContactCompany are required to be provided.

Data Type

String

HoldAtLocationContactEmail Property (DShippingSDK_FedExShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getHoldAtLocationContactEmail();


public function setHoldAtLocationContactEmail($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 43 );


dshippingsdk_fedexship_set($res, 43, $value );

Default Value

''

Remarks

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

Data Type

String

HoldAtLocationContactFax Property (DShippingSDK_FedExShip Class)

Recipient's fax number.

Object Oriented Interface

public function getHoldAtLocationContactFax();


public function setHoldAtLocationContactFax($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 44 );


dshippingsdk_fedexship_set($res, 44, $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

HoldAtLocationContactFirstName Property (DShippingSDK_FedExShip Class)

Sender's first name.

Object Oriented Interface

public function getHoldAtLocationContactFirstName();


public function setHoldAtLocationContactFirstName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 45 );


dshippingsdk_fedexship_set($res, 45, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either HoldAtLocationContactFirstName and HoldAtLocationContactLastName or HoldAtLocationContactCompany must be sent.

Data Type

String

HoldAtLocationContactLastName Property (DShippingSDK_FedExShip Class)

Person's last name.

Object Oriented Interface

public function getHoldAtLocationContactLastName();


public function setHoldAtLocationContactLastName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 46 );


dshippingsdk_fedexship_set($res, 46, $value );

Default Value

''

Remarks

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

Data Type

String

HoldAtLocationContactMiddleInitial Property (DShippingSDK_FedExShip Class)

Middle initial.

Object Oriented Interface

public function getHoldAtLocationContactMiddleInitial();


public function setHoldAtLocationContactMiddleInitial($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 47 );


dshippingsdk_fedexship_set($res, 47, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

HoldAtLocationContactPhone Property (DShippingSDK_FedExShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getHoldAtLocationContactPhone();


public function setHoldAtLocationContactPhone($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 48 );


dshippingsdk_fedexship_set($res, 48, $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

HoldAtLocationPhone Property (DShippingSDK_FedExShip Class)

Phone number of the FedEx location where the shipment will be hold at.

Object Oriented Interface

public function getHoldAtLocationPhone();


public function setHoldAtLocationPhone($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 49 );


dshippingsdk_fedexship_set($res, 49, $value );

Default Value

''

Remarks

When your Hold at Location shipment is received at the designated FedEx station, you will be notified that your shipment is ready to be picked up. It is required to be provided in a HoldAtLocation request.

Data Type

String

HomeDeliveryDate Property (DShippingSDK_FedExShip Class)

Date for Ground Home Delivery service.

Object Oriented Interface

public function getHomeDeliveryDate();


public function setHomeDeliveryDate($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 50 );


dshippingsdk_fedexship_set($res, 50, $value );

Default Value

''

Remarks

The date when the Home Delivery Premium service is requested to happen. This is required when HomeDeliveryType is set to 1 (DateCertain). Valid dates are Monday through Saturday.

Format: YYYY-MM-DD.

Data Type

String

HomeDeliveryPhone Property (DShippingSDK_FedExShip Class)

The phone number of the delivery location.

Object Oriented Interface

public function getHomeDeliveryPhone();


public function setHomeDeliveryPhone($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 51 );


dshippingsdk_fedexship_set($res, 51, $value );

Default Value

''

Remarks

This is required when HomeDeliveryType is set to 0 (Appointment) or 1 (DateCertain). In a ship request, if this is not specified, it will default to RecipientPhone.

Data Type

String

HomeDeliveryType Property (DShippingSDK_FedExShip Class)

The type of Home Delivery Premium service being requested.

Object Oriented Interface

public function getHomeDeliveryType();


public function setHomeDeliveryType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 52 );


dshippingsdk_fedexship_set($res, 52, $value );

Default Value

0

Remarks

This property is required to be provided in a ship request when ServiceType is set to GroundHomeDelivery and ShipmentSpecialServices is set to Home Delivery Premium.

Possible values are as follows:

Data Type

Integer

InsuredValue Property (DShippingSDK_FedExShip Class)

Total insured amount.

Object Oriented Interface

public function getInsuredValue();


public function setInsuredValue($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 53 );


dshippingsdk_fedexship_set($res, 53, $value );

Default Value

'0.00'

Remarks

This element is optional. This is just insurance on the whole shipment if it is lost or stolen. If not provided in the request, FedEx will assume the 0 USD value. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

Data Type

String

LabelImageType Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getLabelImageType();


public function setLabelImageType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 54 );


dshippingsdk_fedexship_set($res, 54, $value );

Default Value

0

Remarks

This element is required to indicate the format that the shipping label should be printed in. This must be set when either GetPackageLabel or GetShipmentLabels are called. The values for the thermal printers indicate the type of printer that is being used.

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

Note: To generate PDF labels, you will need Adobe Reader 6.0 or higher, and the printer driver configuration set to 'none' for print scaling.

There are two types of shipping labels supported:

• plain paper (to be used in laser printers only. In this case, possible values for the LabelImageType are PNG or PDF),
• thermal (to be used in thermal printers only. In this case, possible values for the LabelImageType are ELTRON, ZEBRA, or UNIMARK).

While the content of each of these labels is the same, using the correct image type for the work environment the application will be used in is essential.

You may use the LabelStockType config to specify the size of the label. By default, the class will request a 4x6 label.

Data Type

Integer

Location Property (DShippingSDK_FedExShip Class)

The FedEx location identifier that received the express dispatch request.

Object Oriented Interface

public function getLocation();


public function setLocation($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 55 );


dshippingsdk_fedexship_set($res, 55, $value );

Default Value

''

Remarks

This property is returned after a call to SchedulePickup and contains the Id of the FedEx location that is scheduled to pick up the package.

When calling CancelPickup, this property must be supplied for the cancel request to be successful.

Data Type

String

Manifest Property (DShippingSDK_FedExShip Class)

Image of the manifest for FedEx Ground shipment activity.

Object Oriented Interface

public function getManifest();

Procedural Interface

dshippingsdk_fedexship_get($res, 56 );

Default Value

''

Remarks

This identifies the buffer containing the ASCII data contents of the manifest report for FedEx Ground shipments.

When the CloseGroundShipments method is called, the Manifest is returned when the CloseTrackingNumber is present in the request and Manifest indicates the manifest containing that tracking number, or when the CloseReportType is set to 1 (Manifest). In the last case, this will indicate all manifests from the last 3 days' Closes.

The report is generated in TXT format and saved to disk under CloseReportFile. The manifest is essential at the time of pickup.

This property is applicable for FedEx Ground services only.

This property is read-only.

Data Type

Binary String

MasterTrackingNumber Property (DShippingSDK_FedExShip Class)

Tracking number assigned to the whole MPS shipment.

Object Oriented Interface

public function getMasterTrackingNumber();

Procedural Interface

dshippingsdk_fedexship_get($res, 57 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

MultiweightReport Property (DShippingSDK_FedExShip Class)

Image of a multiweight report.

Object Oriented Interface

public function getMultiweightReport();

Procedural Interface

dshippingsdk_fedexship_get($res, 58 );

Default Value

''

Remarks

This identifies the buffer containing the multiweight report for FedEx Ground multiweight shipments.

When calling the CloseGroundShipments method, the MultiweightReport is returned when CloseReportType is set to 4 (Multiweight)..

The report is generated in TXT format. The report will automatically be saved to disk in the file designated by CloseReportFile.

This property is applicable for FedEx Ground services only.

This property is read-only.

Data Type

Binary String

NotifyCount Property (DShippingSDK_FedExShip Class)

The number of records in the Notify arrays.

Object Oriented Interface

public function getNotifyCount();


public function setNotifyCount($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 59 );


dshippingsdk_fedexship_set($res, 59, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyAggregate
• NotifyEmail
• NotifyFlags
• NotifyMessage
• NotifyName
• NotifyType

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

This property is not available at design time.

Data Type

Integer

NotifyAggregate Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getNotifyAggregate($notifyidx);


public function setNotifyAggregate($notifyidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 60 , $notifyidx);


dshippingsdk_fedexship_set($res, 60, $value , $notifyidx);

Default Value

''

Remarks

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

FedEx

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

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

In this aggregate, you can specify:

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

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

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

UPS

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

In this aggregate, you can specify:

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

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

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

This property is not available at design time.

Data Type

String

NotifyEmail Property (DShippingSDK_FedExShip Class)

Email address of the recipient to be notified.

Object Oriented Interface

public function getNotifyEmail($notifyidx);


public function setNotifyEmail($notifyidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 61 , $notifyidx);


dshippingsdk_fedexship_set($res, 61, $value , $notifyidx);

Default Value

''

Remarks

Email address of the recipient to be notified. This is required to be provided for each recipient.

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

This property is not available at design time.

Data Type

String

NotifyMessage Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getNotifyMessage($notifyidx);


public function setNotifyMessage($notifyidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 62 , $notifyidx);


dshippingsdk_fedexship_set($res, 62, $value , $notifyidx);

Default Value

''

Remarks

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

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

This property is not used by USPS or Canada Post.

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

This property is not available at design time.

Data Type

String

NotifyName Property (DShippingSDK_FedExShip Class)

The name associated with the notification.

Object Oriented Interface

public function getNotifyName($notifyidx);


public function setNotifyName($notifyidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 63 , $notifyidx);


dshippingsdk_fedexship_set($res, 63, $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

NotifyFlags Property (DShippingSDK_FedExShip Class)

Identifies the type of notification requested.

Object Oriented Interface

public function getNotifyFlags($notifyidx);


public function setNotifyFlags($notifyidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 64 , $notifyidx);


dshippingsdk_fedexship_set($res, 64, $value , $notifyidx);

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

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

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

For UPS notifications, the following flags apply:

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

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

This field is not used by USPS.

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

This property is not available at design time.

Data Type

Integer

NotifyType Property (DShippingSDK_FedExShip 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_fedexship_get($res, 65 , $notifyidx);


dshippingsdk_fedexship_set($res, 65, $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

OriginAddress1 Property (DShippingSDK_FedExShip Class)

Street name.

Object Oriented Interface

public function getOriginAddress1();


public function setOriginAddress1($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 66 );


dshippingsdk_fedexship_set($res, 66, $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 OriginAddress1 should not exceed 35 characters.

Data Type

String

OriginAddress2 Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getOriginAddress2();


public function setOriginAddress2($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 67 );


dshippingsdk_fedexship_set($res, 67, $value );

Default Value

''

Remarks

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

Data Type

String

OriginAddressFlags Property (DShippingSDK_FedExShip Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getOriginAddressFlags();


public function setOriginAddressFlags($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 68 );


dshippingsdk_fedexship_set($res, 68, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

OriginCity Property (DShippingSDK_FedExShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getOriginCity();


public function setOriginCity($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 69 );


dshippingsdk_fedexship_set($res, 69, $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

OriginCountryCode Property (DShippingSDK_FedExShip Class)

Country code.

Object Oriented Interface

public function getOriginCountryCode();


public function setOriginCountryCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 70 );


dshippingsdk_fedexship_set($res, 70, $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

OriginState Property (DShippingSDK_FedExShip Class)

State or province code.

Object Oriented Interface

public function getOriginState();


public function setOriginState($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 71 );


dshippingsdk_fedexship_set($res, 71, $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

OriginZipCode Property (DShippingSDK_FedExShip Class)

Postal code.

Object Oriented Interface

public function getOriginZipCode();


public function setOriginZipCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 72 );


dshippingsdk_fedexship_set($res, 72, $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 OriginCity and OriginState are not present.

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

Data Type

String

OriginCompany Property (DShippingSDK_FedExShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getOriginCompany();


public function setOriginCompany($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 73 );


dshippingsdk_fedexship_set($res, 73, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either OriginFirstName and OriginLastName or OriginCompany are required to be provided.

Data Type

String

OriginEmail Property (DShippingSDK_FedExShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getOriginEmail();


public function setOriginEmail($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 74 );


dshippingsdk_fedexship_set($res, 74, $value );

Default Value

''

Remarks

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

Data Type

String

OriginFax Property (DShippingSDK_FedExShip Class)

Recipient's fax number.

Object Oriented Interface

public function getOriginFax();


public function setOriginFax($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 75 );


dshippingsdk_fedexship_set($res, 75, $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

OriginFirstName Property (DShippingSDK_FedExShip Class)

Sender's first name.

Object Oriented Interface

public function getOriginFirstName();


public function setOriginFirstName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 76 );


dshippingsdk_fedexship_set($res, 76, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either OriginFirstName and OriginLastName or OriginCompany must be sent.

Data Type

String

OriginLastName Property (DShippingSDK_FedExShip Class)

Person's last name.

Object Oriented Interface

public function getOriginLastName();


public function setOriginLastName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 77 );


dshippingsdk_fedexship_set($res, 77, $value );

Default Value

''

Remarks

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

Data Type

String

OriginMiddleInitial Property (DShippingSDK_FedExShip Class)

Middle initial.

Object Oriented Interface

public function getOriginMiddleInitial();


public function setOriginMiddleInitial($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 78 );


dshippingsdk_fedexship_set($res, 78, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

OriginPhone Property (DShippingSDK_FedExShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getOriginPhone();


public function setOriginPhone($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 79 );


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

PackageLocation Property (DShippingSDK_FedExShip Class)

The location of pickup.

Object Oriented Interface

public function getPackageLocation();


public function setPackageLocation($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 80 );


dshippingsdk_fedexship_set($res, 80, $value );

Default Value

0

Remarks

This property is optional when calling SchedulePickup. The allowed values to be selected are: None, Front, Side, or Rear.

Data Type

Integer

PackageCount Property (DShippingSDK_FedExShip Class)

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 81 );


dshippingsdk_fedexship_set($res, 81, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageBaseCharge
• PackageCODAmount
• PackageCODFile
• PackageCODLabel
• PackageCODType
• PackageDangerousGoodsAccessible
• PackageDangerousGoodsOptions
• PackageDescription
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageReference
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSpecialServices
• PackageTotalDiscount
• PackageTotalSurcharges
• PackageTrackingNumber
• PackageType
• PackageWeight
• PackageWidth

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

This property is not available at design time.

Data Type

Integer

PackageBaseCharge Property (DShippingSDK_FedExShip Class)

Actual Base Charge applicable to this package.

Object Oriented Interface

public function getPackageBaseCharge($packageidx);

Procedural Interface

dshippingsdk_fedexship_get($res, 82 , $packageidx);

Default Value

''

Remarks

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

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

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

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

This is not applicable to USPS.

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

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

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

Data Type

String

PackageCODAmount Property (DShippingSDK_FedExShip Class)

The COD monetary value for the package.

Object Oriented Interface

public function getPackageCODAmount($packageidx);


public function setPackageCODAmount($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 83 , $packageidx);


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

PackageCODFile Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getPackageCODFile($packageidx);


public function setPackageCODFile($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 84 , $packageidx);


dshippingsdk_fedexship_set($res, 84, $value , $packageidx);

Default Value

''

Remarks

Filename and location to save the PackageCODLabel of this package to. This is applicable for package(s) that use the COD service.

When the PackageCODFile is set to a valid path and filename, the contents of the PackageCODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then PackageCODFile has to have .pdf extension).

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

This property is only applicable to FedEx 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

String

PackageCODLabel Property (DShippingSDK_FedExShip Class)

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

Object Oriented Interface

public function getPackageCODLabel($packageidx);

Procedural Interface

dshippingsdk_fedexship_get($res, 85 , $packageidx);

Default Value

''

Remarks

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the PackageCODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a PackageCODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This property is only applicable to FedEx.

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

PackageCODType Property (DShippingSDK_FedExShip 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_fedexship_get($res, 86 , $packageidx);


dshippingsdk_fedexship_set($res, 86, $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

PackageDangerousGoodsAccessible Property (DShippingSDK_FedExShip Class)

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

Object Oriented Interface

public function getPackageDangerousGoodsAccessible($packageidx);


public function setPackageDangerousGoodsAccessible($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 87 , $packageidx);


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

Default Value

false

Remarks

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

This property is only applicable to FedEx shipments, and is required to be specified when the PackageSpecialServices contains the corresponding flag for Dangerous Goods.

There are two types of dangerous goods:

• Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The PackageDangerousGoodsAccessible should be set to True.
• Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The PackageDangerousGoodsAccessible should be set to False.

The accessibility type affects the service availability and rates.

Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services.

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

Boolean

PackageDangerousGoodsOptions Property (DShippingSDK_FedExShip Class)

Contains the collection of options will be used on the package level when using dangerous goods.

Object Oriented Interface

public function getPackageDangerousGoodsOptions($packageidx);


public function setPackageDangerousGoodsOptions($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 88 , $packageidx);


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

Default Value

0

Remarks

Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:

Note: This is only valid when using FedEx.

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_FedExShip 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_fedexship_get($res, 89 , $packageidx);


dshippingsdk_fedexship_set($res, 89, $value , $packageidx);

Default Value

''

Remarks

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

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

This does not apply for USPS and Canada Post.

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

This property is not available at design time.

Data Type

String

PackageHeight Property (DShippingSDK_FedExShip Class)

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 91 , $packageidx);


dshippingsdk_fedexship_set($res, 91, $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

PackageInsuredValue Property (DShippingSDK_FedExShip Class)

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 93 , $packageidx);


dshippingsdk_fedexship_set($res, 93, $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_FedExShip Class)

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 94 , $packageidx);


dshippingsdk_fedexship_set($res, 94, $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_FedExShip Class)

Actual Net Charge applicable to this package.

Object Oriented Interface

public function getPackageNetCharge($packageidx);


public function setPackageNetCharge($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 95 , $packageidx);


dshippingsdk_fedexship_set($res, 95, $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_FedExShip 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_fedexship_get($res, 96 , $packageidx);


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

Default Value

0

Remarks

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

Possible values are:

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

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

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

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

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

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

Also the following restrictions apply when using UPS Mail Innovations:

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

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

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

This property is not available at design time.

Data Type

Integer

PackageReference Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getPackageReference($packageidx);


public function setPackageReference($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 98 , $packageidx);


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

Default Value

''

Remarks

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

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

Valid values for types are:

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

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

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

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

Valid values for types are:

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

PackageShippingLabel Property (DShippingSDK_FedExShip 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_fedexship_get($res, 101 , $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_FedExShip 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_fedexship_get($res, 102 , $packageidx);


dshippingsdk_fedexship_set($res, 102, $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_FedExShip 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_fedexship_get($res, 104 , $packageidx);


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

Default Value

0

Remarks

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

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

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

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

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

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

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

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

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

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

This does not apply for Canada Post.

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

This property is not available at design time.

Data Type

Integer

PackageSpecialServices Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getPackageSpecialServices($packageidx);


public function setPackageSpecialServices($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 106 , $packageidx);


dshippingsdk_fedexship_set($res, 106, $value , $packageidx);

Default Value

0

Remarks

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

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

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

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

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

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

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

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

This property is not applicable to USPS or Canada Post.

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

This property is not available at design time.

Data Type

Long64

PackageTotalDiscount Property (DShippingSDK_FedExShip Class)

Total Actual Discount applicable to this package.

Object Oriented Interface

public function getPackageTotalDiscount($packageidx);

Procedural Interface

dshippingsdk_fedexship_get($res, 107 , $packageidx);

Default Value

''

Remarks

Total Actual Discount applicable to this package.

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

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

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

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

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

PackageTotalSurcharges Property (DShippingSDK_FedExShip Class)

Total Actual Surcharges applicable to this package.

Object Oriented Interface

public function getPackageTotalSurcharges($packageidx);

Procedural Interface

dshippingsdk_fedexship_get($res, 108 , $packageidx);

Default Value

''

Remarks

Total Actual Surcharges applicable to this package.

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

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

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

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

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

This does not apply to USPS packages.

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

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

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

Data Type

String

PackageTrackingNumber Property (DShippingSDK_FedExShip Class)

Tracking number assigned to this package.

Object Oriented Interface

public function getPackageTrackingNumber($packageidx);

Procedural Interface

dshippingsdk_fedexship_get($res, 109 , $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_FedExShip Class)

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 110 , $packageidx);


dshippingsdk_fedexship_set($res, 110, $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_FedExShip Class)

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_fedexship_get($res, 111 , $packageidx);


dshippingsdk_fedexship_set($res, 111, $value , $packageidx);

Default Value

0

Remarks

The width of the package to be shipped.

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

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

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

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

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

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

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

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

Note also that this applies to Endicia shipping label requests.

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

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

This property is not available at design time.

Data Type

Integer

PayorAccountNumber Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getPayorAccountNumber();


public function setPayorAccountNumber($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 112 );


dshippingsdk_fedexship_set($res, 112, $value );

Default Value

''

Remarks

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

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

Data Type

String

PayorCountryCode Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getPayorCountryCode();


public function setPayorCountryCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 116 );


dshippingsdk_fedexship_set($res, 116, $value );

Default Value

'US'

Remarks

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

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

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

Data Type

String

PayorType Property (DShippingSDK_FedExShip Class)

Method of payment for shipment, or duties and taxes.

Object Oriented Interface

public function getPayorType();


public function setPayorType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 118 );


dshippingsdk_fedexship_set($res, 118, $value );

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

PickupType Property (DShippingSDK_FedExShip Class)

Pickup type used for the shipment that rate is requested for.

Object Oriented Interface

public function getPickupType();


public function setPickupType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 121 );


dshippingsdk_fedexship_set($res, 121, $value );

Default Value

0

Remarks

Indicate the pickup type method by which the shipment to be tendered to FedEx.

Valid values are:

Data Type

Integer

ProxyAuthScheme Property (DShippingSDK_FedExShip 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_fedexship_get($res, 122 );


dshippingsdk_fedexship_set($res, 122, $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_FedExShip 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_fedexship_get($res, 123 );


dshippingsdk_fedexship_set($res, 123, $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_FedExShip 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_fedexship_get($res, 124 );


dshippingsdk_fedexship_set($res, 124, $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_FedExShip 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_fedexship_get($res, 125 );


dshippingsdk_fedexship_set($res, 125, $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_FedExShip 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_fedexship_get($res, 126 );


dshippingsdk_fedexship_set($res, 126, $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_FedExShip 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_fedexship_get($res, 127 );


dshippingsdk_fedexship_set($res, 127, $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_FedExShip Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 128 );


dshippingsdk_fedexship_set($res, 128, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

RecipientAddress1 Property (DShippingSDK_FedExShip Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 129 );


dshippingsdk_fedexship_set($res, 129, $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_FedExShip 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_fedexship_get($res, 130 );


dshippingsdk_fedexship_set($res, 130, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientAddressFlags Property (DShippingSDK_FedExShip Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getRecipientAddressFlags();


public function setRecipientAddressFlags($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 131 );


dshippingsdk_fedexship_set($res, 131, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (DShippingSDK_FedExShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 132 );


dshippingsdk_fedexship_set($res, 132, $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_FedExShip Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 133 );


dshippingsdk_fedexship_set($res, 133, $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_FedExShip Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 134 );


dshippingsdk_fedexship_set($res, 134, $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_FedExShip Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 135 );


dshippingsdk_fedexship_set($res, 135, $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_FedExShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getRecipientCompany();


public function setRecipientCompany($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 136 );


dshippingsdk_fedexship_set($res, 136, $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_FedExShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getRecipientEmail();


public function setRecipientEmail($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 137 );


dshippingsdk_fedexship_set($res, 137, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientFax Property (DShippingSDK_FedExShip Class)

Recipient's fax number.

Object Oriented Interface

public function getRecipientFax();


public function setRecipientFax($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 138 );


dshippingsdk_fedexship_set($res, 138, $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_FedExShip Class)

Sender's first name.

Object Oriented Interface

public function getRecipientFirstName();


public function setRecipientFirstName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 139 );


dshippingsdk_fedexship_set($res, 139, $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_FedExShip Class)

Person's last name.

Object Oriented Interface

public function getRecipientLastName();


public function setRecipientLastName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 140 );


dshippingsdk_fedexship_set($res, 140, $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_FedExShip Class)

Middle initial.

Object Oriented Interface

public function getRecipientMiddleInitial();


public function setRecipientMiddleInitial($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 141 );


dshippingsdk_fedexship_set($res, 141, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (DShippingSDK_FedExShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getRecipientPhone();


public function setRecipientPhone($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 142 );


dshippingsdk_fedexship_set($res, 142, $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

ReturnAddress1 Property (DShippingSDK_FedExShip Class)

Street name.

Object Oriented Interface

public function getReturnAddress1();


public function setReturnAddress1($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 143 );


dshippingsdk_fedexship_set($res, 143, $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 ReturnAddress1 should not exceed 35 characters.

Data Type

String

ReturnAddress2 Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getReturnAddress2();


public function setReturnAddress2($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 144 );


dshippingsdk_fedexship_set($res, 144, $value );

Default Value

''

Remarks

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

Data Type

String

ReturnAddressFlags Property (DShippingSDK_FedExShip Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getReturnAddressFlags();


public function setReturnAddressFlags($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 145 );


dshippingsdk_fedexship_set($res, 145, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

ReturnCity Property (DShippingSDK_FedExShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getReturnCity();


public function setReturnCity($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 146 );


dshippingsdk_fedexship_set($res, 146, $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

ReturnCountryCode Property (DShippingSDK_FedExShip Class)

Country code.

Object Oriented Interface

public function getReturnCountryCode();


public function setReturnCountryCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 147 );


dshippingsdk_fedexship_set($res, 147, $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

ReturnState Property (DShippingSDK_FedExShip Class)

State or province code.

Object Oriented Interface

public function getReturnState();


public function setReturnState($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 148 );


dshippingsdk_fedexship_set($res, 148, $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

ReturnZipCode Property (DShippingSDK_FedExShip Class)

Postal code.

Object Oriented Interface

public function getReturnZipCode();


public function setReturnZipCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 149 );


dshippingsdk_fedexship_set($res, 149, $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 ReturnCity and ReturnState are not present.

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

Data Type

String

ReturnCompany Property (DShippingSDK_FedExShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getReturnCompany();


public function setReturnCompany($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 150 );


dshippingsdk_fedexship_set($res, 150, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either ReturnFirstName and ReturnLastName or ReturnCompany are required to be provided.

Data Type

String

ReturnEmail Property (DShippingSDK_FedExShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getReturnEmail();


public function setReturnEmail($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 151 );


dshippingsdk_fedexship_set($res, 151, $value );

Default Value

''

Remarks

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

Data Type

String

ReturnFax Property (DShippingSDK_FedExShip Class)

Recipient's fax number.

Object Oriented Interface

public function getReturnFax();


public function setReturnFax($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 152 );


dshippingsdk_fedexship_set($res, 152, $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

ReturnFirstName Property (DShippingSDK_FedExShip Class)

Sender's first name.

Object Oriented Interface

public function getReturnFirstName();


public function setReturnFirstName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 153 );


dshippingsdk_fedexship_set($res, 153, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either ReturnFirstName and ReturnLastName or ReturnCompany must be sent.

Data Type

String

ReturnLastName Property (DShippingSDK_FedExShip Class)

Person's last name.

Object Oriented Interface

public function getReturnLastName();


public function setReturnLastName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 154 );


dshippingsdk_fedexship_set($res, 154, $value );

Default Value

''

Remarks

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

Data Type

String

ReturnMiddleInitial Property (DShippingSDK_FedExShip Class)

Middle initial.

Object Oriented Interface

public function getReturnMiddleInitial();


public function setReturnMiddleInitial($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 155 );


dshippingsdk_fedexship_set($res, 155, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

ReturnPhone Property (DShippingSDK_FedExShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getReturnPhone();


public function setReturnPhone($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 156 );


dshippingsdk_fedexship_set($res, 156, $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

SenderAddress1 Property (DShippingSDK_FedExShip Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 157 );


dshippingsdk_fedexship_set($res, 157, $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_FedExShip 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_fedexship_get($res, 158 );


dshippingsdk_fedexship_set($res, 158, $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

SenderAddressFlags Property (DShippingSDK_FedExShip Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getSenderAddressFlags();


public function setSenderAddressFlags($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 159 );


dshippingsdk_fedexship_set($res, 159, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

SenderCity Property (DShippingSDK_FedExShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 160 );


dshippingsdk_fedexship_set($res, 160, $value );

Default Value

''

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

SenderCountryCode Property (DShippingSDK_FedExShip Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 161 );


dshippingsdk_fedexship_set($res, 161, $value );

Default Value

'US'

Remarks

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

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

* Not supported by USPS

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

Data Type

String

SenderState Property (DShippingSDK_FedExShip Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 162 );


dshippingsdk_fedexship_set($res, 162, $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_FedExShip Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 163 );


dshippingsdk_fedexship_set($res, 163, $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_FedExShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getSenderCompany();


public function setSenderCompany($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 164 );


dshippingsdk_fedexship_set($res, 164, $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_FedExShip Class)

Identifies the contact person's email address.

Object Oriented Interface

public function getSenderEmail();


public function setSenderEmail($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 165 );


dshippingsdk_fedexship_set($res, 165, $value );

Default Value

''

Remarks

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

Data Type

String

SenderFax Property (DShippingSDK_FedExShip Class)

Recipient's fax number.

Object Oriented Interface

public function getSenderFax();


public function setSenderFax($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 166 );


dshippingsdk_fedexship_set($res, 166, $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_FedExShip Class)

Sender's first name.

Object Oriented Interface

public function getSenderFirstName();


public function setSenderFirstName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 167 );


dshippingsdk_fedexship_set($res, 167, $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_FedExShip Class)

Person's last name.

Object Oriented Interface

public function getSenderLastName();


public function setSenderLastName($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 168 );


dshippingsdk_fedexship_set($res, 168, $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_FedExShip Class)

Middle initial.

Object Oriented Interface

public function getSenderMiddleInitial();


public function setSenderMiddleInitial($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 169 );


dshippingsdk_fedexship_set($res, 169, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (DShippingSDK_FedExShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getSenderPhone();


public function setSenderPhone($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 170 );


dshippingsdk_fedexship_set($res, 170, $value );

Default Value

''

Remarks

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

Data Type

String

ServiceType Property (DShippingSDK_FedExShip Class)

Identifies the FedEx domestic service to use in a ship request.

Object Oriented Interface

public function getServiceType();


public function setServiceType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 171 );


dshippingsdk_fedexship_set($res, 171, $value );

Default Value

0

Remarks

This property is required to be provided in a ship request. FedEx Ground and FedEx Ground Home Delivery are applicable to FedEx Ground carrier only. All other service types are only applicable to FedEx Express carrier.

Valid values for FedEx are:

This property is not available at design time.

Data Type

Integer

ShipDate Property (DShippingSDK_FedExShip Class)

The date on which the package will be tendered to FedEx.

Object Oriented Interface

public function getShipDate();


public function setShipDate($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 172 );


dshippingsdk_fedexship_set($res, 172, $value );

Default Value

''

Remarks

This is required to be provided in a ship request. The date should be the current date, or a date no more than 10 days in the future.

If future day shipping is requested (i.e., the corresponding flag of Future Day is present in the ShipmentSpecialServices): for Express shipping this value must be less than or equal to 10 days in the future; for Express freight, this must be less than or equal to 5 days in the future.

Defaults to current system date if not present.

This property is also required to be used for the PickupAvailability and SchedulePickup methods. It is used by these methods to tell FedEx when to pickup the packages.

Format: YYYY-MM-DD (e.g. 2008-09-30).

Data Type

String

ShipmentSpecialServices Property (DShippingSDK_FedExShip Class)

Contains the collection of special services offered by FedEx.

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 173 );


dshippingsdk_fedexship_set($res, 173, $value );

Default Value

0

Remarks

To request any of the special services offered by FedEx in a ship request, you must set the ShipmentSpecialServices to a set of flags as listed below:

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

• COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery Premium. When shipping COD via FedEx Ground, the COD details must be provided on the Package level.
• Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested (i.e., when the corresponding Dry Ice flag is contained in the ShipmentSpecialServices), then the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level). This is allowed for FedEx Express shipments only.
• Event Notification: Indicates that event notification is requested. This might affect the service availability. If this is requested in a ship request, then the Notify collection is required to be set.
• Future Day: Indicates that future day shipping is requested. This might affect the service availability. When this is requested, for Express shipping the ShipDate must be less than or equal to 10 days in the future. For Express freight, the ShipDate must be less than or equal to 5 days in the future.
• Hold At Location: This is applicable for FedEx Express services only. Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, and when the RecipientAddressFlags is set to Residential (i.e., for residential delivery). When this service is requested (i.e., when the corresponding Hold At Location flag is contained in the ShipmentSpecialServices), then the HoldAtLocation is required to be provided in the request as well.
• Home Delivery: Indicates that the Home Delivery Premium special service is requested. This is applicable for residential delivery only (i.e., when this is present in the request, the RecipientAddressFlags is automatically set to Residential in the request). If ServiceType is set to GROUND HOME DELIVERY, the corresponding flag of Home Delivery is automatically added to the ShipmentSpecialServices. In this case, the HomeDeliveryDate, HomeDeliveryPhone, and HomeDeliveryType properties are required to be provided in the request as well. This property is applicable for FedEx Ground services only.
• Inside Delivery: Indicates that inside delivery service is requested. In this case, FedEx may move shipments to positions beyond the adjacent loading area. In doing so, FedEx will assess an inside delivery charge in addition to all other applicable charges. The adjacent loading area is defined as a delivery site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. FedEx will assess an inside delivery charge when shipment breakdown is necessary to fit a shipment through a doorway. FedEx does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the delivery site. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Inside Pickup: Indicates that inside pickup service is requested. In this case, FedEx may move shipments from positions beyond the adjacent loading area. In doing so, FedEx will assess an inside pickup charge in addition to all other applicable charges. The adjacent loading area is defined as a pickup site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Pending Shipment Indicates that an email label has been requested. When this option is selected, you will need to also set the Notify property to specify the email address to send to and the message to be sent. You will also need to set the MerchantPhoneNumber and EmailLabelExpirationDate configuration settings. When this option is selected a label will not be saved to the location in PackageShippingLabelFile, as the label will now be emailed to the recipient(s) specified in NotifyEmail
• Return Shipment: Indicates that the return label is requested. This might affect the shipping rates and/or service availability. In this case, the RMANumber and RMAReason can be provided in the request. When this option is selected, the return label will be returned in the server response. The recipient can then apply this return label to the return package as needed and drop the package off at a FedEx drop off location. No charges are assessed until the label is used. Express and Ground return labels are interchangeable, regardless of the original shipping service. For example, you can send the original shipment using an express service, but include a Ground return label as part of your packing documents. Express/Ground Return Labels are available for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Ground, FedEx Home Delivery, FedEx 2Day Freight, and FedEx 3Day Freight throughout the 50 United States. FedEx Express Saver and FedEx 1Day Freight services are not available. Also, Dangerous Goods and Hazardous Materials cannot be shipped. Additional service options include Saturday Service, Dry Ice Shipments, and Hold at FedEx Location. The maximum declared value is $1,000 for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, and FedEx 2Day. The maximum declared value is $50,000 for FedEx 2Day Freight and FedEx 3Day Freight. The maximum declared value is $100 for FedEx Ground and FedEx Home Delivery.
• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and you want Saturday delivery, the ground option and some express option will not be valid.
• Saturday Pickup: Indicates that you request to have the shipment picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on week day other than Saturday and you want Saturday pickup, the ground option and some express option will not be valid.
• ThirdParty Consignee: Indicates that the third party special service is requested. This might affect the shipping rates and/or service availability.
• Electronic Trade Documents: This only applies when shipping internationally. FedEx will generate and submit your trade documents specified in the ShippingDocumentTypes electronically and you no longer need to print and attach them. Note that some countries do not accept Electronic Trade Documents (ETD). For a full list of countries that support ETD you can go to http://images.fedex.com/international/pdf/FedExElectronicTradeDocuments_Coverage.pdf.

  If you also want to receive copies of the FedEx generated documents use the RequestedETDDocuments property together with the ShippingDocumentFile config to specify the files you are requesting and the location where to save them.

• Broker Select: Indicates that the broker select special service is requested. When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:
  • stFedExInternationalPriority (20)
  • stFedExInternationalEconomy (21)
  • stFedExInternationalPriorityFreight (23)
  • stFedExInternationalEconomyFreight (24)
  • stFedExInternationalPriorityExpress (32)
  • stFedExInternationalConnectPlus (33)
  FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the ClearanceBrokerageType, BrokerType, BrokerContact, and BrokerAddress are required to be provided in the ship request as well.

  Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

• East Coast Special: Indicates that East Coast special service is requested. This is applicable to domestic shipments only. This might affect the shipping rates and/or service availability.
• International Controlled Export Service Indicates that the Controlled Export service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.
• International Traffic in Arms Regulations Indicates that the Traffic in Arms Regulations service is requested. This is only applicable for international shipments. This might affect the shipping rates and/or service availability.
• FedEx One Rate Shipping Indicates that FedEx One Rate packaging is being used. This is only applicable for when using a U.S. origin and destination, excluding Hawaii. Valid service types are listed below as both the :

  ServiceType	FedEx Service
  stFedExPriorityOvernight (10)	PRIORITY_OVERNIGHT
  stFedExStandardOvernight (11)	STANDARD_OVERNIGHT
  stFedExFirstOvernight (12)	FIRST_OVERNIGHT
  stFedExExpressSaver (14)	FEDEX_EXPRESS_SAVER
  stFedEx2Day (13)	FEDEX_2_DAY
  stFedEx2DayAM (27)	FEDEX_2_DAY_AM

Data Type

Long64

SSLAcceptServerCertEncoded Property (DShippingSDK_FedExShip Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 175 );


dshippingsdk_fedexship_set($res, 175, $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_FedExShip Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 203 );


dshippingsdk_fedexship_set($res, 203, $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_FedExShip 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_fedexship_get($res, 219 );


dshippingsdk_fedexship_set($res, 219, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_FedExShip 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_fedexship_get($res, 220 );


dshippingsdk_fedexship_set($res, 220, $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_FedExShip Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 221 );


dshippingsdk_fedexship_set($res, 221, $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_FedExShip 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_fedexship_get($res, 222 );


dshippingsdk_fedexship_set($res, 222, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DShippingSDK_FedExShip Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 230 );


dshippingsdk_fedexship_set($res, 230, $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_FedExShip Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_fedexship_get($res, 232 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (DShippingSDK_FedExShip Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 259 );


dshippingsdk_fedexship_set($res, 259, $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

TotalNetCharge Property (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function getTotalNetCharge();

Procedural Interface

dshippingsdk_fedexship_get($res, 260 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

TotalWeight Property (DShippingSDK_FedExShip Class)

Total shipment weight.

Object Oriented Interface

public function getTotalWeight();


public function setTotalWeight($value);

Procedural Interface

dshippingsdk_fedexship_get($res, 261 );


dshippingsdk_fedexship_set($res, 261, $value );

Default Value

''

Remarks

Identifies the total weight of the shipment being conveyed to FedEx. This element is optional when submitting a ship request. It requires one explicit decimal position (i.e. N.N formatting).

Data Type

String

TransitTime Property (DShippingSDK_FedExShip Class)

Expected number of days in transit from pickup to delivery.

Object Oriented Interface

public function getTransitTime();

Procedural Interface

dshippingsdk_fedexship_get($res, 262 );

Default Value

''

Remarks

This is an estimate only. When either the GetPackageLabel or GetShipmentLabels method is called, the DeliveryDate will be returned in the server reply. For international shipments, this information is a limited to a number of international countries and it depends on the customs clearance times.

Possible values are: ONE_DAY, TWO_DAYS, THREE_DAYS, FOUR_DAYS, FIVE_DAYS, SIX_DAYS, SEVEN_DAYS, EIGHT_DAYS, NINE_DAYS, and UNKNOWN.

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

Data Type

String

CancelPickup Method (DShippingSDK_FedExShip Class)

Cancels a scheduled Carrier Pickup request.

Object Oriented Interface

public function doCancelPickup($confirmationnumber);

Procedural Interface

dshippingsdk_fedexship_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)
• FedExAccountNumber (required)
• CarrierType (required)
• ShipDate (required)
• Location (required for canceling an express pickup)
• SpecialInstructions (required for canceling ground pickup)

Valid CarrierType values are FDXG (FedEx Ground) or FDXE (FedEx Express).

If the information 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 FedEx about the request to cancel the pickup, if one exists.

CancelShipment Method (DShippingSDK_FedExShip Class)

Cancels all packages within the shipment.

Object Oriented Interface

public function doCancelShipment($trackingnumber);

Procedural Interface

dshippingsdk_fedexship_do_cancelshipment($res, $trackingnumber);

Remarks

Cancels FedEx Express and Ground shipments that have not already been tendered to FedEx.

The TrackingNumber parameter, that identifies the shipment to be canceled and deleted from the shipping log, is assigned by FedEx server when either the GetPackageLabel or GetShipmentLabels method was called.

The following properties can be set prior to calling this method:

• FedExAccountNumber (required)
• SenderCountryCode

CloseGroundShipments Method (DShippingSDK_FedExShip Class)

Closes out all FedEx Ground shipments made for the day or generates reports for the last 3 days' close requests.

Object Oriented Interface

public function doCloseGroundShipments();

Procedural Interface

dshippingsdk_fedexship_do_closegroundshipments($res);

Remarks

Closing is a function to be used for FedEx Ground shipments only. Express shipments are automatically closed and do not require you to perform a specific close operation. The Close service allows you to reconcile shipping information for your Ground shipments and print a Ground Manifest for your Ground driver.

At the end of the shipping day, you should perform the FedEx Ground End of Day Close procedure. To do so, call the CloseGroundShipments method. The Ground manifest (Manifest stored in CloseReportFile) is generated after a successful close and must be printed before your Ground shipments are tendered to FedEx. This is required to be tendered to FedEx along with your packages if they are being picked up by FedEx Ground. If you are dropping the packages off at a FedEx drop-off location, the manifest is not required.

You may continue to ship Ground packages after a Close has been performed. The Close service may be performed multiple times during your shipping day. Use the Close service to initiate the final stage of processing all shipment data submitted for the day (close of business).

A customer cannot cancel any shipments once they are closed out. However, shipments can be added to a day's shipment after a close operation has been performed and multiple closes can be performed in a day.

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

• FedExServer (required)
• FedExDeveloperKey (required)
• FedExPassword (required)
• FedExAccountNumber (required)
• FedExMeterNumber (required)
• CloseRequest (required)

CloseReportType specifies the type of report. Only one type of report can be returned per Close request. If you need multiple report types you will have to issue multiple CloseGroundShipments requests.

The report will automatically be written to the file specified by CloseReportFile. These reports can be printed anytime during the shipping day for shipments that have already been closed (up to three days in the past).

Config Method (DShippingSDK_FedExShip Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

CSPVersionCapture Method (DShippingSDK_FedExShip Class)

Uploads your CSP software version information to FedEx when you close your ship day.

Object Oriented Interface

public function doCSPVersionCapture();

Procedural Interface

dshippingsdk_fedexship_do_cspversioncapture($res);

Remarks

This is applicable to CSP users and/or developers only.

The Version Capture request is required when you close your ship day (regardless of whether you have shipped FedEx Ground or FedEx Express packages). This transaction uploads your CSP software version information to FedEx.

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

• FedExServer (required)
• FedExDeveloperKey (required)
• FedExPassword (required)
• FedExAccountNumber (required)
• FedExMeterNumber (required)
• FedExCSPUserKey (required)
• FedExCSPUserPassword (required)
• FedExCSPProductId (required)
• FedExCSPProductVersion (required)
• CSPOriginLocationId; (required)
• CSPProductPlatform; (required)

GetPackageLabel Method (DShippingSDK_FedExShip Class)

Generates a shipping label for the specified package.

Object Oriented Interface

public function doGetPackageLabel($index);

Procedural Interface

dshippingsdk_fedexship_do_getpackagelabel($res, $index);

Remarks

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

• FedExServer (required)
• FedExDeveloperKey (required)
• FedExPassword (required)
• FedExAccountNumber (required)
• FedExMeterNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackageType (required)
• TotalWeight (optional; applicable to international shipments only)
• WeightUnit (required; defaults to LB)
• SizeUnit (required; defaults to IN)
• InsuredValue (optional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• Packages (required)
• LabelImageType (required)
• DeliveryInstructions (optional; applicable to Home Delivery and Freight services only)
• BlockVisibility (optional)

When shipping via FedEx Ground then the PackageType should be set to ptYourPackaging.

This method fills in the following properties:

• PackageTrackingNumber for each package included in the shipment;
• PackageShippingLabel for each package included in the shipment;
• PackageNetCharge for each package included in the shipment;
• PackageBaseCharge for each package included in the shipment;
• PackageTotalDiscount for each package included in the shipment;
• PackageTotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

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

GetShipmentLabels Method (DShippingSDK_FedExShip Class)

Generates a shipping label for all packages in the shipment.

Object Oriented Interface

public function doGetShipmentLabels();

Procedural Interface

dshippingsdk_fedexship_do_getshipmentlabels($res);

Remarks

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

• FedExServer (required)
• FedExDeveloperKey (required)
• FedExPassword (required)
• FedExAccountNumber (required)
• FedExMeterNumber (required)
• ShipDate (required)
• ShipTime (optional)
• ServiceType (required)
• PackageType (required)
• TotalWeight (optional; applicable to international shipments only)
• WeightUnit (required; defaults to LB)
• SizeUnit (required; defaults to IN)
• InsuredValue (optional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• Payor (required)
• ShipmentSpecialServices (optional)
• Packages (required)
• LabelImageType (required)
• DeliveryInstructions (optional; applicable to Home Delivery and Freight services only)
• BlockVisibility (optional)

When shipping via FedEx Ground then the PackageType should be set to ptYourPackaging.

This method fills in the following properties:

• PackageTrackingNumber for each package included in the shipment;
• PackageShippingLabel for each package included in the shipment;
• PackageNetCharge for each package included in the shipment;
• PackageBaseCharge for each package included in the shipment;
• PackageTotalDiscount for each package included in the shipment;
• PackageTotalSurcharges for each package included in the shipment;
• DeliveryDate (applicable to the whole shipment);
• TotalNetCharge (applicable to the whole shipment);

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

PickupAvailability Method (DShippingSDK_FedExShip Class)

Checks the availability of the courier dispatch service for the given address.

Object Oriented Interface

public function doPickupAvailability();

Procedural Interface

dshippingsdk_fedexship_do_pickupavailability($res);

Remarks

The PickupAvailability method requires the values for the following properties:

• ServiceType (required)
• CarrierType (required)
• SenderAddress1 (required)
• SenderCity (optional)
• SenderState (optional)
• SenderZipCode (required)
• SenderCountryCode (required)
• ShipDate (optional)
• ShipTime (optional)
• CompanyCloseTime (optional)
• PickupType (optional)
• Packages (optional)
• TotalWeight (optional)

Valid values for CarrierType are FDXE (FedEx Express) or FDXG (FedEx Ground).

The Packages property may optionally be populated with dimensions such as PackageLength, PackageWidth, and PackageHeight.

If the Carrier Pickup service is available to the supplied address, the following properties will be returned. These properties indicate the earliest available pickup date and the carrier that will be picking up your packages:

• ShipDate
• ShipTime
• CarrierType
• CutoffTime
• AccessTime (Example: 'PT1H0M' means Pickup Time is 1 Hour and 0 Minutes)

ReprintDocuments Method (DShippingSDK_FedExShip Class)

Reprints the requested document.

Object Oriented Interface

public function doReprintDocuments();

Procedural Interface

dshippingsdk_fedexship_do_reprintdocuments($res);

Remarks

When called this will request the document type specified in CloseReportType for the specified.

Reset Method (DShippingSDK_FedExShip Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_fedexship_do_reset($res);

Remarks

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

SchedulePickup Method (DShippingSDK_FedExShip Class)

This method schedules a courier pickup.

Object Oriented Interface

public function doSchedulePickup();

Procedural Interface

dshippingsdk_fedexship_do_schedulepickup($res);

Remarks

Schedules a courier pickup and returns a confirmation number for the scheduled pickup.

The following properties are applicable:

• CarrierType (required, valid values are ctFDXG (FedEx Ground) or ctFDXE (FedEx Express))
• CompanyCloseTime
• Packages (required if PackageCount is not set)
• PackageLocation
• SenderAddress1 (required when UseAccountAddress is false)
• SenderAddress2 (optional)
• SenderCity (required when UseAccountAddress is false)
• SenderState (required when UseAccountAddress is false)
• SenderZipCode (required when UseAccountAddress is false)
• SenderCountryCode (required when UseAccountAddress is false)
• SenderCompany (required when UseAccountAddress is false)
• SenderEmail (optional)
• SenderFax (optional)
• SenderFirstName (required when UseAccountAddress is false)
• SenderLastName (required when UseAccountAddress is false)
• SenderMiddleInitial (optional)
• SenderPhone (required when UseAccountAddress is false)
• ShipDate
• ShipTime
• PackageCount (optional)
• TotalWeight (required)
• SpecialInstructions (optional)
• UseAccountAddress (optional)

If the courier pickup service is available for the supplied address, the confirmation number will be returned by this method. The Location property will also be populated.

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

Error Event (DShippingSDK_FedExShip Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_fedexship_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_FedExShip Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_fedexship_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_FedExShip Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

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

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

SSLStatus Event (DShippingSDK_FedExShip Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

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

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

FedExShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (FedExShip Class)

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