Developer Portal
Ground End of Day Close API
Introduction
The Ground® End of Day Close API allows you to reconcile shipping information for your FedEx Ground account and print a ground manifest for your driver. The Ground Manifest is generated after a successful close and must be printed before ground shipments are tendered to FedEx. A customer may continue to ship ground packages even after a close has been performed.
Ground End of Day Close API Details
This API allows you to upload package data to FedEx and generate manifest reports, thereby closing the corresponding FedEx Ground® shipment (U.S. domestic and international).
Ground End of Day Close API Functionalities:
- All shipments that have the same reference field can be grouped and closed as one set.
- Reference confirmation functionality identifies the subset of shipments to print the configured reports.
- End of Day Close with reference designation for close functionality performs the close operation for the shipments. These shipments are associated with the specified reference field.
- This API uploads ground shipment information into the FedEx account.
- Open ship Verification Error functionality designates the level of error handling returned in a reply. You can use it to analyze the unconfirmed Open Shipments when performing the End of Day Close transaction.
How Ground End of Day Close API Works
Following are some of the operations under FedEx Ground End of Day Close API:
Ground End of the Day Close Request
Initiates the final stage of processing all shipment data submitted by the customer for the day (close of business) for FedEx Ground shipments. The response only returns the Ground Manifest. The Ground Manifest is only available in a text (.txt) format.
Following are the key input information associated with this request:
- Closing Date
- Shipping Document/Reports Specifications
- FedEx Account Number
- FedEx Ground category (FedEx Ground)
The successful response will close the shipments and will generate the specified reports/documents.
Reprint Documents request
Generates the user specified reports that are created when the Close operation is processed. Returns all the specified reports generated for a specific day. It can only reprint reports up to three days in the past.
Following are the key input information associated with this request:
- Closing Date
- Reprint Option
- Shipping Document/Reports Specifications
- FedEx Account Number
- FedEx Ground category (FedEx Ground)
The successful response will reprint the reports/documents.
Ground Close
The Close Operation can be performed multiple times during each shipping day. There is no need to reopen once a close has been processed, you can just resume shipping. Use the Close Service to initiate the final stage processing of all shipment data submitted for the day (close of business).
For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide.
FedEx Ground Reports
Ground Manifest
After the completion of a FedEx Ground shipping label activity for the current day, customer must \"close\" their pending FedEx Ground labels and print out a FedEx Ground Manifest and hand this manifest to the FedEx driver or retail clerk. This manifest lists all FedEx Ground print activity and is required by FedEx for processing.
The FedEx Ground Manifest report can be printed or reprinted at any time immediately after the End of Day Close or at a later time if there has been more than one close for the day. The FedEx Ground Manifest report will include all FedEx Ground shipments generated over the last 24 hours.
The FedEx Ground Pickup Manifest for FedEx Consolidated Services is identical to the standard report generated for any type of FedEx Ground package shipping. The FedEx Ground Pickup Manifest is required by the FedEx Ground courier to tender packages for shipping. It provides a summary of the packages picked up on a given day to the FedEx Ground courier and provides the following information:
- Sender’s account number
- Sender’s meter number
- Tracking number for all packages
- C.O.D. amount (if applicable)
- Declared value (if applicable)
- Number of Oversize I packages
- Number of Oversize II packages
- Number of packages requiring additional handling
- Number of residential delivery packages
- Total number of packages
- Pickup confirmation number
Business Rules
- The Close operation is optional but recommended. It may be required if you need any of the reports generated.
- FedEx Ground shipments can be deleted after a Close.
- The address in the manifest header is extracted from the first package shipped on the specified day.
JSON API Collection
Ship EndofDayClose API (1.0.0)
Ground End Of Day Close
Use this endpoint to close the Ground shipments and generate the reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
| x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
| content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
| x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
| authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- FullSchema_GEOD_PUT
- MinimumSamplePayload-Put-GroundClose
| closeReqType | string Enum: "GCDR" "RGCDR" Specify the close request type to initiate processing of shipment data.For ground close the closeReqType is GCDR and for Reprint EndofDay the applicable value is RGCDR. |
| accountNumber | object (AccountNumber_2) This is the FedEx Account number. |
| groundServiceCategory | string Value: "GROUND" This is to specify FedEx ground category for which the shipment to be submitted for end of the day closing. |
| closeDate | string Indicates the close date. |
| trackingNumber | string Specify the tracking number for reprinting the report.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. |
| reprintOption | string Enum: "BY_SHIP_DATE" "BY_TRACKING_NUMBER" Specify the reprint option to generate report. Either by close date or a tracking number.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. |
| closeDocumentSpecification | object (CloseDocumentSpecification) Specifies characteristics of the document to be returned for this request. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "closeReqType": "GCDR",
- "accountNumber": {
- "value": "123456789"
- "groundServiceCategory": "GROUND",
- "closeDate": "2020-05-05",
- "trackingNumber": "794967542946",
- "reprintOption": "BY_SHIP_DATE",
- "closeDocumentSpecification": {
- "closeDocumentTypes": [
- "OP_950"
- "op950Detail": {
- "format": {
- "topOfPageOffset": {
- "value": "0",
- "units": "CM"
- "imageType": "PDF",
- "stockType": "OP_950",
- "locale": "en_US"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "output": {
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "closeDocuments": [
- {
- "type": "OP_950",
- "shippingCycle": "1003234523333204",
- "shippingDocumentDisposition": "CONFIRMED",
- "accessReference": null,
- "resolution": 200,
- "copiesToPrint": 1,
- "parts": [
- {
- "documentPartSequenceNumber": 1,
- "image": "ICAgICAg.."
Reprint End of the day
Use this endpoint to reprint the closed Ground shipments reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
| x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
| content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
| x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
| authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- FullSchema_Reprint_POST
- MinimumSamplePayload-Post-Reprintground
| closeReqType | string Enum: "GCDR" "RGCDR" Specify the close request type to initiate processing of shipment data.For ground close the closeReqType is GCDR and for Reprint EndofDay the applicable value is RGCDR. |
| accountNumber | object (AccountNumber_2) This is the FedEx Account number. |
| groundServiceCategory | string Value: "GROUND" This is to specify FedEx ground category for which the shipment to be submitted for end of the day closing. |
| closeDate | string Indicates the close date. |
| trackingNumber | string Specify the tracking number for reprinting the report.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. |
| reprintOption | string Enum: "BY_SHIP_DATE" "BY_TRACKING_NUMBER" Specify the reprint option to generate report. Either by close date or a tracking number.It is only applicable for reprint EndofDay and its not applicable for ground EndofDay close endpoint. |
| closeDocumentSpecification | object (CloseDocumentSpecification) Specifies characteristics of the document to be returned for this request. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- "closeReqType": "GCDR",
- "accountNumber": {
- "value": "123456789"
- "groundServiceCategory": "GROUND",
- "closeDate": "2020-05-05",
- "trackingNumber": "794967542946",
- "reprintOption": "BY_SHIP_DATE",
- "closeDocumentSpecification": {
- "closeDocumentTypes": [
- "OP_950"
- "op950Detail": {
- "format": {
- "topOfPageOffset": {
- "value": "0",
- "units": "CM"
- "imageType": "PDF",
- "stockType": "OP_950",
- "locale": "en_US"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "output": {
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "closeDocuments": [
- {
- "type": "OP_950",
- "shippingCycle": "1003234523333204",
- "shippingDocumentDisposition": "CONFIRMED",
- "accessReference": null,
- "resolution": 200,
- "copiesToPrint": 1,
- "parts": [
- {
- "documentPartSequenceNumber": 1,
- "image": "ICAgICAg.."
