Ground End of Day Close API

Úvod

Rozhraní API pro Uzávěrku dne služby Ground^® umožňuje odsouhlasit přepravní informace pro účet FedEx Ground a vytisknout manifest služby Ground pro řidiče. Manifest služby Ground se vygeneruje po úspěšném uzavření a musí být vytištěn před předáním zásilek služby Ground společnosti FedEx. Zákazník může nadále odesílat zásilky služby Ground i poté, co bylo provedeno uzavření.

Podrobnosti o rozhraní API pro Uzávěrku dne služby Ground

Toto rozhraní API vám umožňuje nahrát údaje o balíku pro společnost FedEx a vygenerovat sestavy manifestu, čímž se příslušná zásilka služby FedEx Ground^® (vnitrostátní v rámci USA a mezinárodní) uzavře.

Funkce rozhraní API pro Uzávěrku dne služby Ground:

Všechny zásilky, které mají stejné referenční pole, lze seskupit a uzavřít jako jednu sadu.
Funkce pro potvrzení reference identifikuje podskupinu zásilek, pro které budou vytištěny nakonfigurované sestavy.
Uzávěrka dne s označením reference pro funkci uzavření provede u zásilek operaci uzavření. Tyto zásilky jsou spojeny s příslušným referenčním polem.
Toto rozhraní API nahraje informace o zásilce služby Ground do účtu FedEx.
Funkce Ověření chyb u otevřených zásilek označuje míru zpracování chyb vrácených v odpovědi. Můžete ji využít k analýze nepotvrzených Otevřených zásilek při provádění transakce Uzávěrky dne.

Jak rozhraní API pro Uzávěrku dne služby Ground funguje

Níže uvádíme některé operace dostupné v rozhraní API pro Uzávěrku dne služby FedEx Ground:

Požadavek na Uzávěrku dne služby Ground

Spouští finální fázi zpracování všech údajů o zásilkách podaných zákazníkem za daný den (konec pracovního dne) pro zásilky služby FedEx Ground. Odpověď vrátí pouze manifest služby Ground. Manifest služby Ground je dostupný pouze v textovém formátu (.txt).

Níže jsou uvedeny hlavní vstupní informace spojené s tímto požadavkem:

Datum uzávěrky
Specifikace přepravní dokumentace / sestav
Číslo účtu FedEx
Kategorie služby FedEx Ground (FedEx Ground)

Úspěšná odpověď zásilky uzavře a vygeneruje specifikované sestavy/dokumenty.

Žádost o opětovný tisk dokumentů

Vygeneruje uživatelem specifikované sestavy, které jsou vytvořeny při zpracování operace uzavření. Vrátí všechny specifikované sestavy vytvořené vygenerované pro konkrétní den. Sestavy starší než tři dny nelze opětovně vytisknout.

Níže jsou uvedeny hlavní vstupní informace spojené s tímto požadavkem:

Datum uzávěrky
Možnost Vytisknout znovu
Specifikace přepravní dokumentace / sestav
Číslo účtu FedEx
Kategorie služby FedEx Ground (FedEx Ground)

(Úspěšná odpověď znovu vytiskne sestavy/dokumenty.

Uzávěrka služby Ground

Operaci uzavření lze provést každý odesílací den několikrát. Když bylo uzavření zpracováno, není nutné znovu otevírat, stačí znovu zahájit odesílání. Použijte možnost Zavřít službu k zahájení finální fáze zpracování všech údajů o zásilkách podaných za daný den (konec pracovního dne).

Podrobné informace o službách nabízených společností FedEx najdete v elektronickém průvodci službami FedEx.

Sestavy služby FedEx Ground

Manifest služby Ground

Po dokončení aktivit souvisejících s přepravním štítkem služby FedEx Ground pro daný den musí zákazník \"zavřít\" své nevyřízené štítky služby FedEx Ground a vytisknout manifest služby FedEx Ground a ten předat řidiči společnosti FedEx nebo prodavači. Tento manifest obsahuje seznam všech tiskových aktivit služby FedEx Ground a je vyžadován společností FedEx pro účely zpracování zásilky.

Manifest služby FedEx Ground lze vytisknout nebo opětovně vytisknout kdykoli po Uzávěrce dne nebo později, pokud bylo za daný den provedeno více než jedno uzavření. Manifest služby FedEx Ground bude zahrnovat všechny zásilky služby FedEx Ground vygenerované za posledních 24 hodin.

Manifest FedEx Ground Pickup pro konsolidované služby FedEx je identický jako standardní sestava generovaná pro jakoukoli jinou zásilku služby FedEx Ground. Manifest FedEx Ground Pickup je vyžadován kurýrem služby FedEx Ground kvůli předání zásilek k přepravě. Obsahuje soupis zásilek vyzvednutých v daný den kurýrem služby FedEx Ground a obsahuje následující informace:

Číslo účtu odesílatele
Číslo měřiče odesílatele
Sledovací číslo pro všechny zásilky
Částka dobírky (je-li relevantní)
Deklarovaná hodnota (je-li relevantní)
Počet nadměrných zásilek I
Počet nadměrných zásilek II
Počet zásilek vyžadujících dodatečnou manipulaci
Počet zásilek pro doručení do domácnosti
Celkový počet zásilek
Číslo potvrzení vyzvednutí

Obchodní pravidla

Operace zavření je volitelná, avšak doporučovaná. Může byt nutná v případě, že potřebujete vygenerovat některé sestavy.
Zásilky služby FedEx Ground lze odstranit po zavření.
Adresa v hlavičce manifestu je načtena z první zásilky odeslané daného dne.

Kolekce JSON 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

Úvod

Podrobnosti o rozhraní API pro Uzávěrku dne služby Ground

Jak rozhraní API pro Uzávěrku dne služby Ground funguje

Uzávěrka služby Ground

Sestavy služby FedEx Ground

Obchodní pravidla

Kolekce JSON 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