CloseDetail Type

Represents the details of a Close request (applicable to Ground shipments only).

Remarks

This type contains specific information of a Close request. It is used in the FedExShip and FedExShipIntl beans when the CloseGroundShipments method is called.

Example: Setting the fields of a Close request (when requesting to reprint the Close manifest)

CloseDetail close = new CloseDetail 
close.Date           = "2008-10-15"
close.TrackingNumber = "123456789012345"
close.ReportFile     = "manifest.txt"

The fields contained by this type are listed below.

Fields

Date
String

Identifies the date up to which the unclosed FedEx Ground shipments are to be closed. The Date and Time 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).

ReportFile
String

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 ReportType is set to a value other than 0 (Unspecified) when CloseGroundShipments is called. Depending on the value assigned to ReportType, 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 ReportFile. The file name must have the TXT extension.

This property is applicable for FedEx Ground services only.

ReportType
int

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:


Type	Meaning
crtUnspecified (0)	The Close operation is requested to be processed, but no specific report is requested
crtManifest (1)	Only the Ground Manifest Report is requested
crtCOD (2)	Only the Ground COD Report is requested
crtHazMat (3)	Only the Ground Hazardous Materials Report is requested
crtMultiweight (4)	Only the Ground Multiweight Report is requested

This property is applicable for FedEx Ground services only.

NOTE: This only takes effect when calling ReprintDocuments.

Time
String

Identifies the time up to which the unclosed FedEx Ground shipments are to be closed. The Date and Time 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.

TrackingNumber
String

Shipment Ground tracking number. Provided to obtain the manifest containing this tracking number. If you include the TrackingNumber 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 ReportType element are returned.

Maximum length: 20 characters.

NOTE: This only takes effect when calling ReprintDocuments.

Constructors

public CloseDetail();

public CloseDetail(String date, String time);

public CloseDetail(String date, String time, String trackingNumber, String reportFile);

public CloseDetail(String date, String time, int reportType, String reportFile);