Ground End of Day Close API

Johdanto

Ground^®-kuljetusten päivän lopetus -APIn avulla voit päivittää FedEx Ground -tilisi lähetystiedot ja tulostaa Ground-ilmoituksen kuljettajallesi. Ground-ilmoitus luodaan onnistuneen sulkemisen jälkeen, ja se pitää tulostaa ennen maantielähetysten toimittamista FedExille. Asiakas voi jatkaa Ground-pakettien lähettämistä sulkemisenkin jälkeen.

Ground-kuljetusten päivän lopetus APIn tiedot

Tämän APIn avulla voit lähettää pakettitietoja FedExille ja luoda ilmoitusraportteja sulkien siten vastaavan FedEx Ground^® -lähetyksen (Yhdysvallat ja kansainväliset).

Ground-kuljetusten päivän lopetus APIn toiminnallisuudet:

Kaikki lähetykset, joilla on sama viitekenttä, voidaan ryhmittää ja sulkea kerralla.
Viitteiden vahvistustoiminnallisuus tunnistaa sen lähetysten alijoukon, jolle määritetyt raportit tulostetaan.
Sulku päivän lopetukseksi viitteiden määrityksellä sulkemistoiminnallisuudelle suorittaa sulkemisoperaation lähetyksille. Nämä lähetykset liittyvät määriteltyyn viitekenttään.
Tämä API lataa verkkoon maantielähetystiedot FedEx-tilille.
Lähetyksen avauksen tarkistuksen virhetoiminnallisuus nimeää vastauksessa palautetun virhekäsittelyn tason. Sen avulla voi analysoida vahvistamattomat avoimet lähetykset suoritettaessa sulkemista päivän lopetukseksi.

Ground-kuljetusten päivän lopetus APIn toiminta

Seuraavassa on joitakin FedEx Ground -kuljetusten päivän lopetus APIn toiminnoista:

Ground-kuljetusten päivän lopetuksen sulkemispyyntö

Käynnistää kaikkien asiakkaan päivän aikana lähettämien lähetystietojen lopullisen käsittelyn (virka-ajan päättyessä) FedEx Ground -lähetyksille. Vastaus palauttaa ainoastaan Ground-ilmoituksen. Ground-ilmoitus on saatavilla ainoastaan tekstimuodossa (.txt).

Seuraavassa on tärkeimmät tähän pyyntöön liittyvät tiedot:

Sulkemispäivämäärä
Lähetysasiakirjojen/raporttien määrittelyt
FedEx-asiakasnumero
FedEx Ground -luokka (FedEx Ground)

Onnistunut vastaus sulkee lähetykset ja luo määritellyt raportit/asiakirjat.

Asiakirjojen uudelleentulostuspyyntö

Luo käyttäjän määrittelemät raportit, jotka luodaan sulkemisoperaation käsittelyn aikana. Palauttaa kaikki määritellyt tietyn päivän aikana luodut raportit. Voi uudelleentulostaa raportteja enintään kolmen päivän päähän menneisyyteen.

Seuraavassa on tärkeimmät tähän pyyntöön liittyvät tiedot:

Sulkemispäivämäärä
Uudelleentulostusvaihtoehto
Lähetysasiakirjojen/raporttien määrittelyt
FedEx-asiakasnumero
FedEx Ground -luokka (FedEx Ground)

Onnistunut vastaus tulostaa määritellyt raportit/asiakirjat uudelleen.

Ground-kuljetusten sulkeminen

Sulkeminen on mahdollista suorittaa useita kertoja jokaisena lähetyspäivänä. Suljettuja lähetyksiä ei tarvitse avata uudelleen sen jälkeen, kun ne on käsitelty, vaan voit suoraan aloittaa lähettämisen uudelleen. Käytä sulkemispalvelua, kun aloitat kaikkien päivän aikana lähetettyjen lähetystietojen lopullisen käsittelyn (virka-ajan päättyessä).

Tarkempia tietoja FedExin tarjoamista palveluista saat sähköisestä FedExin palveluoppaasta.

FedEx Ground -raportit

Ground-ilmoitus

Päivän FedEx Ground -osoitelapputoimenpiteiden valmistuttua asiakkaan on "suljettava" vireillä olevat FedEx Ground -lappunsa, tulostettava FedEx Ground -ilmoitus ja annettava tämä ilmoitus FedExin kuljettajalle tai myymälän virkailijalle. Tämä ilmoitus luettelee kaikki FedEx Ground -tulostustoimenpiteet ja FedEx vaatii sen käsittelyä varten.

FedEx Ground -ilmoitusraportti voidaan tulostaa tai tulostaa uudelleen milloin tahansa heti päivän lopputilityksen jälkeen tai myöhemmin, jos lopputilityksiä on useampia samalle päivälle. FedEx Ground -ilmoitusraportissa on kaikki viimeisen 24 tunnin aikana luodut FedEx Ground -lähetykset.

FedEx Ground -noutoilmoitus FedExin konsolidointipalveluita varten on identtinen kaikentyyppisille FedEx Ground -pakettilähetyksille luodun vakioraportin kanssa. FedEx Ground -kuriiri vaatii FedEx Ground -noutoilmoituksen luovutettaessa paketteja lähetettäviksi. Siinä on yhteenveto tiettynä päivänä noudetuista paketeista FedEx Ground -kuriirille, ja se tarjoaa seuraavat tiedot:

Lähettäjän asiakasnumero
Lähettäjän mittarin numero
Seurantanumero kaikille paketeille
Jälkivaatimuksen arvo (mikäli soveltuu)
Ilmoitettu arvo (mikäli soveltuu)
Suurikokoinen I -luokan pakettien lukumäärä
Suurikokoinen II -luokan pakettien lukumäärä
Lisäkäsittelyä vaativien pakettien lukumäärä
Kotitalouksiin toimitettavien pakettien lukumäärä
Pakettien kokonaismäärä
Noudon vahvistusnumero

Yrityssäännöt

Sulkeminen ei ole pakollista, mutta suosittelemme tekemään sen. Se voi olla tarpeen, jos tarvitset jonkin luoduista raporteista.
FedEx Ground -lähetykset voidaan poistaa sulkemisen jälkeen.
Ilmoituksen ylätunnuksessa oleva osoite poimitaan kyseisenä päivänä lähetetystä ensimmäisestä paketista.

JSON API -kokoelma

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

Johdanto

Ground-kuljetusten päivän lopetus APIn tiedot

Ground-kuljetusten päivän lopetus APIn toiminta

Ground-kuljetusten sulkeminen

FedEx Ground -raportit

Yrityssäännöt

JSON API -kokoelma

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