Ground End of Day Close API

Bevezetés

A Ground^® Nap végi zárás API lehetővé teszi a FedEx Ground-számlájára vonatkozó szállítási információk egyeztetését, és a sofőr számára a szárazföldi szállítmányozási manifeszt kinyomtatását. A Ground-manifeszt a sikeres lezárás után generálódik, és ki kell nyomtatni, mielőtt a szárazföldi szállítmányokat a FedExnek átadják. Az ügyfél a lezárást követően is küldhet szárazföldi csomagokat.

Ground Nap végi zárás API részletei

Ez az API lehetővé teszi a csomagadatok feltöltését a FedExhez, valamint a manifesztjelentések létrehozását, ezáltal a megfelelő FedEx Ground^®-szállítmány (amerikai belföldi és nemzetközi) lezárását.

A Ground Nap végi zárás API funkciói:

Az azonos referenciamezővel rendelkező összes szállítmány csoportosítható és lezárható egy csoportként.
A referencia-visszaigazolási funkció azonosítja a szállítmányok azon részhalmazát, amelyből a konfigurált jelentéseket ki kell nyomtatni.
A nap végi zárás a zárási funkcióra való hivatkozással elvégzi a szállítmányok zárási műveletét. Ezek a szállítmányok a megadott referenciamezőhöz kapcsolódnak.
Ez az API feltölti a közúti szállítmányok adatait a FedEx ügyfélszámlára.
Az „Open ship Verification Error” funkció a válaszban visszaküldött hibakezelés szintjét jelöli ki. Használhatja a meg nem erősített nyitott szállítmányok elemzésére, amikor a nap végi zárási tranzakciót végzi.

Hogyan működik a Ground Nap végi zárás API?

A következők a FedEx Ground Nap végi zárás API keretében zajló némely műveletek:

Ground Nap végi zárás kérése

Kezdeményezi a FedEx Ground-szállítmányek esetében az ügyfél által az adott napra (üzletkötés) benyújtott összes szállítmányadat feldolgozásának utolsó szakaszát. A válasz csak a Ground-manifesztet adja meg. A Ground-manifeszt csak szöveges formátumban (.txt) érhető el.

Az alábbiakban a kérelemhez kapcsolódó legfontosabb bemeneti információkat ismertetjük:

Zárási dátum
Küldeménydokumentum/jelentések részletei
FedEx ügyfélazonosító
FedEx Ground kategória (FedEx Ground)

A sikeres válasz lezárja a szállítmányeket, és létrehozza a megadott jelentéseket/dokumentumokat.

Dokumentumok újranyomtatására vonatkozó kérés

Létrehozza a felhasználó által megadott jelentéseket, amelyek a „Bezárás” művelet feldolgozásakor jönnek létre. Visszaadja az adott napra generált összes megadott jelentést. Csak három napra visszamenőleg tud újranyomtatni jelentéseket.

Az alábbiakban a kérelemhez kapcsolódó legfontosabb bemeneti információkat ismertetjük:

Zárási dátum
Újranyomtatási opció
Küldeménydokumentum/jelentések részletei
FedEx ügyfélazonosító
FedEx Ground kategória (FedEx Ground)

A sikeres válasz újranyomtatja a jelentéseket/dokumentumokat.

Ground-zárás

A zárási művelet minden szállítási nap során több alkalommal is végrehajtható. A lezárás feldolgozása után nincs szükség újranyitásra, egyszerűen folytathatja a szállítást. A zárási szolgáltatással hozzáfoghat a nap során beküldött összes szállítmányadatok feldolgozásának utolsó fázisához (a munkanap végi záráshoz).

A FedEx által kínált szolgáltatásokkal kapcsolatos részletesebb információkért tekintse meg az elektronikus FedEx szolgáltatási útmutatót.

FedEx Ground-jelentések

Ground-manifeszt

Az adott napra vonatkozó „FedEx Ground közúti fuvarlevél-címke” tevékenység befejezése után az ügyfélnek \"be kell zárnia\" a függőben lévő FedEx Ground-címkéket, és ki kell nyomtatnia egy FedEx Ground-manifesztet, majd át kell adnia ezt a manifesztet a FedEx sofőrének vagy a kiskereskedelmi alkalmazottnak. Ez a manifeszt tartalmazza az összes FedEx Ground-nyomtatási tevékenységet, és a FedEx kéri a feldolgozáshoz.

A FedEx Ground Manifeszt jelentés bármikor kinyomtatható vagy újranyomtatható, közvetlenül a napi zárást követően vagy valamikor később, ha több napi zárást is végrehajtottak egy adott napra. A FedEx Ground-manifeszt jelentésben az elmúlt 24 óra során előállított összes FedEx Ground szállítmány benne lesz.

A FedEx Ground-átvételi manifeszt a FedEx Consolidated Services számára megegyezik a FedEx Ground-csomagküldés bármely típusáról generált standard jelentéssel. A FedEx Ground-átvételi manifeszt szükséges a FedEx Ground futár számára, hogy átadja a csomagokat kézbesítésre. Összefoglalót nyújt az adott napon átvett csomagokról a FedEx Ground-futárnak, és a következő információkat tartalmazza:

Feladó ügyfélszáma
Feladó mérőszáma
Nyomonkövetési szám minden csomaghoz
COD-összeg (ha alkalmazandó)
Bevallott érték (ha alkalmazandó)
I. Túlméretes csomagok száma
II. Túlméretes csomagok száma
A további kezelést igénylő csomagok száma
Lakcímre történő kézbesítés csomagjainak száma
Csomagok összesen
Csomagfelvétel visszaigazolásának száma

Üzleti szabályok

A bezárási művelet nem kötelező, de ajánlott. Erre akkor lehet szükség, ha szüksége van a generált jelentések bármelyikére.
A FedEx Ground-szállítmányek törölhetők egy zárás után.
A manifeszt fejlécében szereplő cím a megadott napon feladott első csomagból származik.

JSON API-gyűjtemény

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

Bevezetés

Ground Nap végi zárás API részletei

Hogyan működik a Ground Nap végi zárás API?

Ground-zárás

FedEx Ground-jelentések

Üzleti szabályok

JSON API-gyűjtemény

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