Ground End of Day Close API

Introduction

L’API Ground^MD End of Day Close vous permet de faire concorder l’information sur les expéditions de votre compte FedEx Ground et d’imprimer un manifeste Ground pour votre chauffeur. Le manifeste Ground est généré après une fermeture réussie et doit être imprimé avant que les envois Ground soient remis à FedEx. Un client peut continuer à expédier des colis Ground même après la procédure de fin de journée.

Détails sur l’API Ground End of Day Close

Cette API vous permet de téléverser les données des colis à FedEx et de générer des rapports de manifeste, ce qui permet de clôturer l’envoi FedEx Ground^MD correspondant (intérieur des États-Unis et international).

Fonctionnalités de l’API Ground End of Day Close :

Tous les envois qui ont le même champ de référence peuvent être groupés et fermés comme un seul ensemble.
La fonctionnalité de confirmation de référence identifie le sous-ensemble d’envois pour imprimer les rapports configurés.
La procédure de fin de la journée avec désignation de référence pour la fonctionnalité de fermeture effectue l’opération de clôture pour les envois. Ces envois sont associés au champ de référence précisé.
Cette API téléverse les renseignements sur les envois Ground dans le compte FedEx.
La fonctionnalité d’erreur de vérification des envois en cours désigne le niveau de traitement des erreurs renvoyées dans une réponse. Vous pouvez l’utiliser pour analyser les envois en cours non confirmés lorsque vous effectuez la transaction de fin de la journée.

Fonctionnement de l’API de fin de la journée d’expédition Ground

Vous trouverez ci-après quelques-unes des opérations relevant de l’API de fin de la journée d’expédition FedEx Ground :

Demande de fermeture de fin de la journée Ground

Lance l’étape finale du traitement de toutes les données des envois soumises par le client pour la journée (à la fermeture des bureaux) pour les envois FedEx Ground. La réponse renvoie uniquement le manifeste Ground. Le manifeste Ground est uniquement disponible au format texte (.txt).

Vous trouverez ci-dessous les renseignements d’entrée clés associés à cette demande :

Date de fermeture
Caractéristiques des rapports/documents d’expédition
Numéro de compte FedEx
Catégorie FedEx Ground (FedEx Ground)

Une réponse positive fermera les envois et générera les rapports/documents précisés.

Demande de réimpression de documents

Génère les rapports précisés par l’utilisateur qui sont créés lorsque l’opération de fermeture est traitée. Renvoie tous les rapports précisés générés pour un jour en particulier. Il n’est possible de réimprimer des rapports que jusqu’à trois jours dans le passé.

Vous trouverez ci-dessous les renseignements d’entrée clés associés à cette demande :

Date de fermeture
Option de réimpression
Caractéristiques des rapports/documents d’expédition
Numéro de compte FedEx
Catégorie FedEx Ground (FedEx Ground)

Une réponse positive réimprimera les rapports/documents.

Fermeture de la journée Ground

L’opération de fermeture peut-être effectuée plusieurs fois au cours de chaque journée d’expédition. Il n’est pas nécessaire de rouvrir la journée une fois que la fermeture a été traitée. Il suffit de recommencer l’expédition. Utilisez le service de fermeture pour lancer l’étape finale du traitement de toutes les données des envois soumises pendant la journée (à la fermeture des bureaux).

Pour obtenir de plus amples renseignements sur les services offerts par FedEx, consultez le Guide des services de FedEx électronique.

Rapports FedEx Ground

Manifeste Ground

Après avoir terminé l’activité liée aux étiquettes d’expédition FedEx Ground pour la journée en cours, le client doit fermer (\"close\") ses étiquettes FedEx Ground en attente, imprimer un manifeste FedEx Ground et remettre ce dernier au chauffeur FedEx ou au commis au comptoir de détail. Ce manifeste répertorie toutes les activités d’impression FedEx Ground et est requis par FedEx à des fins de traitement.

Le rapport de manifeste FedEx Ground peut être imprimé ou réimprimé immédiatement après la fermeture de fin de la journée ou plus tard, s’il y a eu plus d’une fermeture dans la journée. Le rapport de manifeste FedEx Ground comprendra tous les envois FedEx Ground générés au cours des 24 dernières heures.

Le manifeste de ramassage FedEx Ground pour les Services de groupage FedEx est identique au rapport standard généré pour les autres types d’expédition de colis FedEx Ground. Le manifeste de ramassage FedEx Ground est requis par le messager FedEx Ground pour remettre les colis à expédier. Il fournit au messager FedEx Ground un résumé des colis ramassés pendant la journée et contient les renseignements suivants :

Numéro de compte de l’expéditeur
Numéro système de l’expéditeur
Numéro de suivi de tous les colis
Montant CR (selon le cas)
Valeur déclarée (selon le cas)
Nombre de colis surdimensionnés I
Nombre de colis surdimensionnés II
Nombre de colis nécessitant une manutention supplémentaire
Nombre de colis à livraison résidentielle
Nombre total de colis
Numéro de confirmation du ramassage

Règles opérationnelles

L’opération de fermeture est facultative, mais recommandée. Elle peut être requise si vous avez besoin de générer un ou plusieurs rapports.
Les envois FedEx Ground peuvent être supprimés après la fermeture.
L’adresse figurant dans l’en-tête du manifeste est extraite du premier colis expédié le jour précisé.

Collection d’API JSON

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

Introduction

Détails sur l’API Ground End of Day Close

Fonctionnement de l’API de fin de la journée d’expédition Ground

Fermeture de la journée Ground

Rapports FedEx Ground

Règles opérationnelles

Collection d’API JSON

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