Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

PackageBaseCharge Property

Base charge applicable to this package.

Syntax

 fedexship.getPackageBaseCharge(index, [callback])

Default Value

""


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPackageBaseCharge([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPackageBaseCharge([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Base charge applicable to this package.

For FedEx, this is 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 transport charge applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment.

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 size of the array is controlled by the PackageCount property.

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

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0