Ground End of Day Close API

はじめに

Ground^®終業時クローズ API は、FedEx Ground アカウントの出荷情報を調整し、ドライバー用の陸上配送マニフェストの印刷をサポートします。陸上配送マニフェストは、正常なクローズ後に生成し、陸上配送貨物をフェデックスに委託する前に印刷しなければなりません。クローズ後も、陸上配送パッケージを出荷し続けることができます。

Ground 終業時クローズ API の詳細

この API は、フェデックスにパッケージデータをアップロードしマニフェストレポートを生成することをサポートするため、対応する FedEx Ground^® の出荷（米国国内および国際）をクローズすることができます。

Ground 終業時クローズ API 機能：

参照項目が同じすべての出荷を、1 つのセットとしてグループ化してクローズすることができます。
参照確認機能は、構成レポートを印刷するために出荷のサブセットを識別します。
クローズ機能用の参照指定を使用する「終業時クローズ」が、出荷のクローズ操作を実行します。これらの出荷は、指定参照フィールドに関連付けられています。
このAPIは、陸上配送輸送情報をフェデックス・アカウントにアップロードします。
オープンシップ検証エラー機能は、応答のエラー処理レベルを指定します。この機能により、「終業時クローズ」トランザクションを実行する際に未確認の未処理出荷を分析できます。

Ground 終業時クローズ APIの仕組み

FedEx Ground 終業時クローズ API での操作（一部）：

Ground 終業時クローズリクエスト

FedEx Ground 貨物のその日（営業時間内）に顧客から提出されたすべての出荷データを処理する最終段階を開始します。陸上配送マニフェストのみが応答として返って来ます。陸上配送マニフェストの形式はテキスト（.txt）です。

このリクエストに関連する主要な入力情報:

クローズ日
出荷書類／レポート仕様
フェデックス・アカウント・ナンバー
FedEx Groundカテゴリ（FedEx Ground）

正常な応答は、出荷をクローズし、指定レポート／ドキュメントを生成します。

ドキュメントの再印刷リクエスト

クローズ操作の処理時に作成されるユーザー指定レポートを生成します。特定の日に生成されたすべての指定レポートを返します。過去3日分のレポートのみを再印刷できます。

このリクエストに関連する主要な入力情報:

クローズ日
再印刷オプション
出荷書類／レポート仕様
フェデックス・アカウント・ナンバー
FedEx Groundカテゴリ（FedEx Ground）

正常な応答は、レポート／ドキュメントを再印刷します。

Ground クローズ

クローズ操作は各出荷日で複数回実行することができます。クローズ処理後、再び「オープン」にする必要はありません。そのまま出荷を再開することができます。「クローズサービス」は、その日（営業時間内）に提出されたすべての出荷データを処理する最終段階を開始します。

フェデックスが提供するサービスの詳細については、電子版フェデックス・サービスガイドを参照してください。

FedEx Ground レポート

Ground マニフェスト

その日の FedEx Ground 出荷ラベルアクティビティの完了後、お客様は保留中の FedEx Ground ラベルを \"閉じ\"、FedEx Ground マニフェストを印刷して、このマニフェストをフェデックスのドライバーまたは店員に渡さなければなりません。フェデックスが処理を実行するために必要なこのマニフェストには、すべての FedEx Ground 印刷アクティビティが一覧表示されています。

FedEx Ground マニフェストレポートは、終業時クローズ直後、またはその日に複数のクローズを処理した場合は、後ほどいつでも印刷または再印刷できます。FedEx Ground マニフェストレポートには、過去24時間に生成されたすべての FedEx Ground 貨物が含まれます。

FedEx 統合サービスの FedEx Ground 集荷マニフェストは、あらゆるタイプの FedEx Ground パッケージ出荷用に生成された標準レポートと同じです。FedEx Ground 集荷マニフェストは、FedEx Ground のクーリエが、出荷するためにパッケージを委託する際に必要です。特定の日に集荷されたパッケージの次の情報を含む概要を FedEx Ground のクーリエに提供します。

荷送人のアカウント・ナンバー
荷送人のメーター番号
すべてのパッケージの追跡番号
C.O.D.額（該当する場合）
申告価額（該当する場合）
寸法超過（I）パッケージ数
寸法超過（II）パッケージ数
追加処理が必要なパッケージ数
個人宅配達パッケージ数
パッケージ総数
集荷の確認番号

ビジネス規則

クローズ操作は任意ですが、使用することを推奨します。生成したレポートのいずれかが必要な場合、この操作を実行しなければならない可能性があります。
FedEx Ground 貨物は、クローズ後に削除できます。
マニフェストヘッダーの住所は、指定日に出荷された最初のパッケージから抽出されます。

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

はじめに

Ground 終業時クローズ API の詳細

Ground 終業時クローズ APIの仕組み

Ground クローズ

FedEx Ground レポート

ビジネス規則

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