Ground End of Day Close API

Einleitung

Mit der Ground^® Tagesabschluss-API können Sie Sendungsinformationen für Ihr FedEx Ground Konto abgleichen und einen Ground Manifest-Bericht für Ihren Fahrer drucken. Das Ground Manifest wird nach einem erfolgreichen Abschluss generiert und muss ausgedruckt werden, bevor die Ground Sendungen an FedEx übergeben werden. Kunden können nach einem Abschluss weiterhin Ground Pakete versenden.

Details zur Ground Tagesabschluss-API

Mit dieser API können Sie Paketdaten bei FedEx hochladen und Manifest-Berichte generieren, während Sie die entsprechende FedEx Ground^® Sendung abschließen (internationale und US-Sendungen).

Funktionen der Ground Tagesabschluss-API:

Alle Sendungen mit gleichem Referenzfeld können gruppiert und gemeinsam abgeschlossen werden.
Mit der Funktion zur Referenzbestätigung kann die Untergruppe der Sendungen ermittelt werden, für die die konfigurierten Berichte ausgedruckt werden sollen.
Tagesabschluss mit Referenzbezeichnung für die Abschlussfunktion führt den Abschlussvorgang für die Sendungen durch. Diese Sendungen sind mit dem angegebenen Referenzfeld verknüpft.
Mit dieser API können Informationen über Ground Sendungen in das FedEx Konto hochgeladen werden.
Mit der Funktion „Verifizierungsfehler offene Sendung“ kann die Ebene der Fehlerbehandlung bestimmt werden, die in einer Antwort zurückgegeben wird. Bei der Durchführung der Tagesabschluss-Transaktion können die unbestätigten offenen Sendungen analysiert werden.

So funktioniert die Ground Tagesabschluss-API

Mit der FedEx Ground Tagesabschluss-API können unter anderem folgende Vorgänge ausgeführt werden:

Ground Tagesabschluss-Anfrage

Leitet die letzte Verarbeitungsphase sämtlicher vom Kunden für diesen Tag eingereichten FedEx Ground Sendungen ein (Geschäftsschluss). Als Antwort wird lediglich das Ground Manifest zurückgegeben. Das Ground Manifest ist nur im Textformat (TXT) verfügbar.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

Abschlussdatum
Spezifikationen zu Versanddokumenten/Berichten
FedEx Kundennummer
FedEx Ground Kategorie (FedEx Ground)

Bei erfolgreicher Antwort werden die Sendungen abgeschlossen und die angegebenen Berichte/Dokumente generiert.

Anfrage zum erneuten Drucken der Dokumente

Generiert die benutzerdefinierten Berichte, die nach der Verarbeitung des Abschlussvorgangs erstellt werden. Es werden alle spezifizierten Berichte zurückgegeben, die für einen bestimmten Tag generiert wurden. Es können nur Berichte gedruckt werden, die höchstens drei Tage alt sind.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

Abschlussdatum
Option zum erneuten Drucken
Spezifikationen zu Versanddokumenten/Berichten
FedEx Kundennummer
FedEx Ground Kategorie (FedEx Ground)

Bei erfolgreichem Antwort werden die Berichte/Dokumente erneut gedruckt.

Ground Abschluss

Der Abschlussvorgang kann während eines Versandtags mehrmals durchgeführt werden. Das erneute Öffnen eines verarbeiteten Abschlusses ist nicht erforderlich. Fahren Sie einfach mit dem Versand von Sendungen fort. Verwenden Sie die Abschlussoption, um die letzte Verarbeitungsphase sämtlicher für diesen Tag eingereichten Sendungen einzuleiten (Geschäftsschluss).

Ausführlichere Informationen über die von FedEx angebotenen Services finden Sie im elektronischen FedEx Service Guide.

FedEx Ground Berichte

Ground Manifest

Nach Abschluss einer FedEx Ground Versandetikett-Aktivität für den aktuellen Tag müssen Kunden ausstehende FedEx Ground Etiketten abschließen und ein FedEx Ground Manifest ausdrucken. Dieses Manifest wird dem FedEx Fahrer oder Verkäufer ausgehändigt. In diesem Manifest sind alle FedEx Ground Druck-Aktivitäten aufgeführt. Es wird von FedEx zur Verarbeitung benötigt.

Der FedEx Ground Manifest-Bericht kann jederzeit unmittelbar nach dem Tagesabschluss oder zu einem späteren Zeitpunkt gedruckt oder erneut gedruckt werden, sofern es mehr als einen Tagesabschluss gibt. Im FedEx Ground Manifest-Bericht sind alle FedEx Ground Sendungen enthalten, die in den letzten 24 Stunden generiert wurden.

Der FedEx Ground Abholnachweis für FedEx Consolidated Services ist identisch mit dem Bericht, der standardmäßig für jede Art von Versand von FedEx Ground Paketen generiert wird. Der FedEx Ground Kurier benötigt den FedEx Ground Abholnachweis, damit Pakete für den Versand übergeben werden können. Er umfasst eine Zusammenfassung für den FedEx Ground Kurier über die an einem bestimmten Tag abgeholten Pakete sowie folgende Informationen:

Kundennummer des Absenders
Meter-Nummer des Absenders
Sendungsverfolgungsnummer aller Pakete
Betrag bei Bezahlung per Nachnahme (sofern zutreffend)
Deklarierter Warenwert (sofern zutreffend)
Anzahl der übergroßen Pakete I
Anzahl der übergroßen Pakete II
Anzahl der Pakete mit zusätzlichen Bearbeitungskosten
Anzahl der Pakete mit Zustellung an Privatadresse
Gesamtzahl der Pakete
Bestätigungsnummer für Abholung

Geschäftsregeln

Der Abschlussvorgang ist optional, wird jedoch empfohlen. Wenn Sie einen dieser Berichte generieren müssen, muss der Abschlussvorgang durchgeführt werden.
FedEx Ground Sendungen können nach einem Abschluss gelöscht werden.
Die Adresse in der Manifest-Kopfzeile wird aus dem ersten am spezifischen Tag versendeten Paket extrahiert.

JSON API-Sammlung

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

Einleitung

Details zur Ground Tagesabschluss-API

So funktioniert die Ground Tagesabschluss-API

Ground Abschluss

FedEx Ground Berichte

Geschäftsregeln

JSON API-Sammlung

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