Ground End of Day Close API

Introducción

La API de cierre Ground al final del día^® le permite conciliar su información de envío para su cuenta FedEx Ground e imprimir el manifiesto de Ground de su conductor. El manifiesto de Ground se genera después de un cierre exitoso y se debe imprimir antes de que los envíos terrestre se entreguen a FedEx. Un cliente puede seguir enviando paquetes Ground incluso después de que realizó el cierre.

Detalles de la API de cierre Ground al final del día

Esta API le permite cargar datos del paquete en FedEx y genera los reportes del manifiesto, cerrando así el envío correspondiente de FedEx Ground^® (nacional en Estados Unidos e internacional).

Funcionalidades de la API de cierre Ground al final del día:

Todos los envíos que tienen el mismo campo de referencia pueden agruparse y cerrarse como un solo conjunto.
La funcionalidad Confirmación de referencia identifica el subconjunto de envíos para imprimir los reportes configurados.
La funcionalidad Cierre al final del día con designación de referencia para el cierre realiza la operación de cierre para los envíos. Estos envíos están asociados con el campo de referencia específico.
La API carga la información de envió terrestre a la cuenta FedEx.
La funcionalidad Error de verificación al abrir envío designa el nivel de tratamiento de errores arrojado en una respuesta. Puede usarlo para analizar los envíos abiertos sin confirmar cuando realiza la transacción Cierre al final del día.

Cómo funciona la API de cierre Ground al final del día

A continuación se muestran algunas de las operaciones de la API de Cierre Ground al final del día:

Solicitud de Cierre Ground al final del día

Inicia la última etapa del procesamiento de todos los datos de los envíos presentados en el día por el cliente (cierre de operaciones) para los envíos por FedEx Ground. La respuesta solo arroja el Manifiesto de Ground. El Manifiesto de Ground solo está disponible en formato de texto (.txt).

A continuación se muestra la información de entrada asociada a esta solicitud:

Fecha de cierre
Documento de envío o especificaciones de los reportes
Número de cuenta de FedEx
Categoría FedEx Ground (FedEx Ground)

La respuesta exitosa cerrará los envíos y generará los reportes o documentos especificados.

Solicitud para reimprimir documentos

Genera los reportes especificados por el usuario que se crean cuando se procesa la operación de cierre. Arroja todos los reportes especificados generados para un día específico. Solo puede reimprimir reportes de los últimos tres días.

A continuación se muestra la información de entrada asociada a esta solicitud:

Fecha de cierre
Opción reimprimir
Documento de envío o especificaciones de los reportes
Número de cuenta de FedEx
Categoría FedEx Ground (FedEx Ground)

La respuesta exitosa reimprime los documentos o reportes.

Cierre terrestre

La operación de cierre puede realizarse varias veces durante cada día de envío. No es necesario reabrir una vez que se procesó el cierre; puede continuar haciendo envíos. Utilice Servicio de cierre para iniciar la última etapa del procesamiento de todos los datos de envío presentados en el día (cierre de operaciones).

Para obtener información más detallada sobre los servicios que ofrece FedEx, consulte la Guía de Servicios FedEx en formato electrónico.

Reportes de FedEx Ground

Manifiesto de Ground

Después de completar la actividad de etiquetado de envío de FedEx Ground del día actual, el cliente debe cerrar las etiquetas pendientes de FedEx Ground, imprimir el Manifiesto de FedEx Ground y entregar éste al conductor de FedEx o al encargado del punto de venta. Este manifiesto enumera toda la actividad de impresiones de FedEx Ground y FedEx lo necesita para procesarlo.

El reporte del manifiesto de FedEx Ground puede imprimirse o reimprimirse en cualquier momento después del cierre al final del día o después si ha habido más de un cierre al día. El reporte de manifiesto de FedEx Ground incluirá todos los envíos de FedEx Ground generados durante las últimas 24 horas.

El manifiesto de recolección de envíos terrestres de FedEx para los Servicios de consolidación FedEx es idéntico al informe estándar generado para cualquier tipo de envío de paquete mediante FedEx Ground. El manifiesto de recolección de envíos terrestres mediante FedEx Ground es requerido por el mensajero para presentar los paquetes para envíos. Provee un resumen de los paquetes recolectados en un día dado al mensajero FedEx Ground y proporciona la siguiente información:

Número de cuenta del remitente
Número de medidor del remitente
Número de rastreo para todos los paquetes
Monto de C.O.D (si es aplicable)
Valor declarado (si es aplicable)
Número de paquetes de tamaño excesivo I
Número de paquetes de tamaño excesivo II
Número de paquetes que necesitan manejo adicional
Número de paquetes de entrega residencial
Número total de paquetes
Número de confirmación de recolección

Normas comerciales

La operación de cierre es opcional, pero se recomienda. Se puede requerir si necesita generar cualquiera de los reportes.
Los envíos de FedEx Ground pueden borrarse después de un cierre.
La dirección en el encabezado del manifiesto se obtiene del primer paquete enviado en el día especificado.

Colección de JSON de la API

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

One of

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. Example: XXX456XXX
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. Example: 2020-05-05
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. Example: 7XX96XX42946
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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/endofday/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/endofday/

Production Server

https://apis.fedex.com/ship/v1/endofday/

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"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

Content type

application/json

Copy

Expand all Collapse all

{

"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

One of

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. Example: XXX456XXX
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. Example: 2020-05-05
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. Example: 7XX96XX42946
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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/endofday/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/endofday/

Production Server

https://apis.fedex.com/ship/v1/endofday/

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"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

Content type

application/json

Copy

Expand all Collapse all

{

"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.."
    }
    ]
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Ground End of Day Close API

Introducción

Detalles de la API de cierre Ground al final del día

Cómo funciona la API de cierre Ground al final del día

Cierre terrestre

Reportes de FedEx Ground

Normas comerciales

Colección de JSON de la API

Ship EndofDayClose API (1.0.0)

Ground End Of Day Close

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Reprint End of the day

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in