eDis API ドキュメント

eDIS パブリック配送 API（eDelivery International Shipping API）

重要! この API は、アクティブな eDIS アカウントを持つ大中華圏のセラーのみが利用できます。

この API を使用すると、大中華圏のサードパーティ開発者が荷物の配送詳細を処理できます。住所管理、荷物の作成・確認・キャンセル・削除、バンドル管理、配送ラベルと引渡し票の取得、追跡情報の取得、苦情の申請、配送サービスの照会などの機能を提供します。

バージョン: 1.1.0

ベースURL: https://api.ebay.com/sell/edelivery_international_shipping/v1

認証（OAuth スコープ）

この API は OAuth 2.0 認証を使用します。

スコープ	説明
`https://api.ebay.com/oauth/scope/sell.edelivery`	eDelivery 国際配送の管理

リソース一覧

eDelivery API は以下の 11 リソース、合計 27 エンドポイント（12 GET + 1 DELETE + 14 POST）で構成されています。

リソース	説明	数
actual_costs	実際の重量とコストの取得	1
address_preference	発送元/返品先住所の管理	2
agents	EU 認定代理人の取得	1
battery_qualifications	バッテリー資格の取得	1
bundle	バンドルの作成・取得・キャンセル・ラベル取得	4
complaint	配送苦情の作成	1
consign_preference	委託住所の管理	2
dropoff_sites	ドロップオフサイトの取得	1
handover_sheet / labels	引渡し票と配送ラベルの取得	2
package	荷物の作成・取得・削除・キャンセル・確認・クローン・一括操作	11
services / tracking	配送サービスと追跡情報	2

actual_costs — 実際のコスト（1 エンドポイント）

GET `/actual_costs`

getActualCosts — 指定された入力条件に基づいて、1 つ以上の荷物の実際の重量とコストを取得します。

レスポンスは tracking_numbers クエリパラメータ、または trans_begin_time と trans_end_time クエリパラメータでフィルタリングできます。1 回の呼び出しで使用できるフィルタリング方法は 1 つのみです。

パラメータ	場所	必須	説明
`tracking_numbers`	クエリ	条件付き	荷物の追跡番号。最大 200 件。`trans_begin_time`/`trans_end_time` 未指定時は必須。
`trans_begin_time`	クエリ	条件付き	トランザクション開始時間（UTC）。形式: `YYYY-MM-DDTHH:MM:SS.SSSZ`
`trans_end_time`	クエリ	条件付き	トランザクション終了時間（UTC）。形式: `YYYY-MM-DDTHH:MM:SS.SSSZ`

レスポンス: 200 / 400 / 401 / 404 / 500

address_preference — 住所管理（2 エンドポイント）

GET `/address_preference`

getAddressPreferences — セラーの eDIS アカウントに関連付けられたすべての発送元住所および/または返品先住所に関する情報を取得します。

レスポンス: 200 / 400 / 401 / 500

POST `/address_preference`

createAddressPreference — eDIS アカウントに住所を作成します。作成可能な住所タイプ: SHIP_FROM_ADDRESS、RETURN_ADDRESS。成功すると addressId が返されます。

レスポンス: 201 / 400 / 401 / 404 / 500

agents — EU 認定代理人（1 エンドポイント）

GET `/agents`

getAgents — セラーの eDIS アカウントに関連付けられた EU 認定代理人（AR）エージェントの情報を取得します。各エージェントの連絡先情報、eBay ID、サポート国が返されます。

パラメータ	場所	必須	説明
`limit`	クエリ	任意	最大: 200、デフォルト: 50
`offset`	クエリ	任意	デフォルト: 0

レスポンス: 200 / 400 / 401 / 500

battery_qualifications — バッテリー資格（1 エンドポイント）

GET `/battery_qualifications`

getBatteryQualifications — eDIS アカウントに関連付けられたすべてのバッテリー資格を取得します。タイプ、電子資格 ID・名前、有効期限が含まれます。

パラメータ	場所	必須	説明
`limit`	クエリ	任意	最大: 200、デフォルト: 50
`offset`	クエリ	任意	デフォルト: 0

レスポンス: 200 / 400 / 401 / 500

bundle — バンドル管理（4 エンドポイント）

注: バンドルエンドポイントは OpenAPI 仕様 v1.1.0 で追加されました。

POST `/bundle`

createBundle — バンドル（荷物のグループ）を作成します。

レスポンス: 201 / 400 / 401 / 500

GET `/bundle/{bundle_id}`

getBundle — 指定されたバンドル ID に基づいてバンドルの詳細を取得します。

パラメータ	場所	必須	説明
`bundle_id`	パス	必須	取得するバンドルの一意の識別子。

レスポンス: 200 / 400 / 401 / 404 / 500

POST `/bundle/{bundle_id}/cancel`

cancelBundle — 指定されたバンドルをキャンセルします。

パラメータ	場所	必須	説明
`bundle_id`	パス	必須	キャンセルするバンドルの一意の識別子。

レスポンス: 204 / 400 / 401 / 404 / 500

GET `/bundle/{bundle_id}/label`

getBundleLabel — 指定されたバンドルのラベルを取得します。

パラメータ	場所	必須	説明
`bundle_id`	パス	必須	ラベルを取得するバンドルの一意の識別子。

レスポンス: 200 / 400 / 401 / 404 / 500

complaint — 苦情（1 エンドポイント）

POST `/complaint`

createComplaint — 配送注文に関する苦情を作成します。集荷遅延やアイテムの輸送中紛失に対して苦情を申請できます。苦情の理由、種類、問題発生日を指定し、紛失荷物の場合は affectedPackages 配列に packageId を指定します。

レスポンス: 201 / 400 / 401 / 500

consign_preference — 委託住所管理（2 エンドポイント）

GET `/consign_preference`

getConsignPreferences — セラーの eDIS アカウントに関連付けられたすべての集荷、ドロップオフ、フォワードデプロイメントの委託住所に関する情報を取得します。

レスポンス: 200 / 400 / 401 / 500

POST `/consign_preference`

createConsignPreference — 委託住所を作成します。作成可能なタイプ: PICK_UP、DROP_OFF、FORWARD_DEPLOYMENT。成功すると addressId が返されます。

レスポンス: 201 / 400 / 401 / 500

dropoff_sites — ドロップオフサイト（1 エンドポイント）

GET `/dropoff_sites`

getDropoffSites — セラーの eDIS アカウントに関連付けられたドロップオフサイトのメタデータを取得します。

パラメータ	場所	必須	説明
`limit`	クエリ	任意	最大: 200、デフォルト: 50
`offset`	クエリ	任意	デフォルト: 0

レスポンス: 200 / 400 / 401 / 500

handover_sheet / labels — 引渡し票とラベル（2 エンドポイント）

GET `/handover_sheet`

getHandoverSheet — 集荷リクエスト内の荷物の引渡し票を取得します。base64 文字列として返され、集荷担当者との確認に使用できます。

パラメータ	場所	必須	説明
`tracking_numbers`	クエリ	必須	引渡し票を取得する荷物の追跡番号の配列。最大 200 件。

レスポンス: 200 / 400 / 401 / 404 / 500

GET `/labels`

getLabels — 指定された荷物の配送ラベルを取得します。base64 文字列として返され、PDF に変換可能。各追跡番号に対して個別ファイルが返されます。

パラメータ	場所	必須	説明
`tracking_numbers`	クエリ	必須	配送ラベルを取得する荷物の追跡番号の配列。最大 200 件。
`page_size`	クエリ	任意	ラベルのページサイズ。有効値: `A4`、`THERMAL_PAPER`
`print_preference`	クエリ	任意	印刷設定（カンマ区切り）。有効値: `nameZh`, `nameEn`, `remark`, `skuPrice`, `skuNo`, `quantity`, `listingId`, `sellerId`, `buyerId`

レスポンス: 200 / 400 / 401 / 404 / 500

package — 荷物管理（11 エンドポイント）

POST `/package`

createPackage — 注文の荷物を作成します。寸法、重量、発送元・配送先住所、アイテム情報をリクエストに指定します。成功すると packageId と追跡番号が返されます。

注: 返された packageId を記録してください。現時点ではプログラムで取得する方法はありません。

レスポンス: 201 / 400 / 401 / 500

GET `/package/{package_id}`

getPackage — 指定されたパッケージ ID に基づいて荷物の詳細（寸法、重量、住所、アイテム情報）を取得します。

パラメータ	場所	必須	説明
`package_id`	パス	必須	荷物の一意の識別子。createPackage で返されます。

レスポンス: 200 / 400 / 401 / 404 / 500

DELETE `/package/{package_id}`

deletePackage — 荷物を削除します。キャンセル済みかつ追跡番号が関連付けられていない荷物のみ削除可能。成功すると 204 No Content が返されます。

パラメータ	場所	必須	説明
`package_id`	パス	必須	削除する荷物の一意の識別子。

レスポンス: 204 / 400 / 401 / 404 / 500

POST `/package/{package_id}/cancel`

cancelPackage — 荷物とその追跡番号をキャンセルします。処理中の荷物はキャンセルできません。

パラメータ	場所	必須	説明
`package_id`	パス	必須	キャンセルする荷物の一意の識別子。

レスポンス: 204 / 400 / 401 / 404 / 500

POST `/package/{package_id}/clone`

clonePackage — 再配送のために荷物をクローンします。createPackage で入力された同じ情報で荷物を再送信します。

パラメータ	場所	必須	説明
`package_id`	パス	必須	クローンする荷物の一意の識別子。

レスポンス: 201 / 400 / 401 / 404 / 500

POST `/package/{package_id}/confirm`

confirmPackage — 荷物の配送注文を確認します。確認後、見積もりコストがウォレットで凍結され、集荷リクエストが送信されます。

パラメータ	場所	必須	説明
`package_id`	パス	必須	確認する荷物の一意の識別子。

レスポンス: 204 / 400 / 401 / 404 / 500

GET `/package/{order_line_item_id}/item`

getPackagesByLineItemID — 指定された注文明細項目 ID に基づいて荷物を取得します。getPackage で詳細情報を取得するためのフォローアップとして使用できます。

パラメータ	場所	必須	説明
`order_line_item_id`	パス	必須	明細項目の一意の識別子。Fulfillment API の getOrders または Trading API の GetOrders で返されます。

レスポンス: 200 / 400 / 401 / 404 / 500

POST `/package/bulk_cancel_packages`

bulkCancelPackages — 複数の荷物とその追跡番号を一括キャンセルします。packageIds 配列にパッケージ ID を指定します。処理中の荷物はキャンセルできません。

レスポンス: 200 / 400 / 401 / 404 / 500

POST `/package/bulk_confirm_packages`

bulkConfirmPackages — 複数の荷物の配送注文を一括確認します。確認後、見積もりコストがウォレットで凍結され、集荷リクエストが送信されます。

レスポンス: 200 / 400 / 401 / 404 / 500

POST `/package/bulk_delete_packages`

bulkDeletePackages — 複数の荷物を一括削除します。キャンセル済みかつ追跡番号が関連付けられていない荷物のみ削除可能。

レスポンス: 200 / 400 / 401 / 404 / 500

services / tracking — 配送サービスと追跡（2 エンドポイント）

GET `/services`

getServices — 利用可能な配送サービスのメタデータ（名前、説明、指示）を取得します。

パラメータ	場所	必須	説明
`limit`	クエリ	任意	最大: 200、デフォルト: 50
`offset`	クエリ	任意	デフォルト: 0

レスポンス: 200 / 400 / 401 / 404 / 500

GET `/tracking`

getTracking — 指定された追跡番号に関連付けられた荷物の追跡イベント詳細を取得します。各イベントには説明、場所、時間、ステータスが含まれます。

パラメータ	場所	必須	説明
`tracking_number`	クエリ	必須	追跡番号。createPackage メソッドで返されます。

レスポンス: 200 / 400 / 401 / 404 / 500

エンドポイント一覧（全 27 エンドポイント）

メソッド	エンドポイント	operationId	説明
GET	`/actual_costs`	getActualCosts	実際のコスト取得
GET	`/address_preference`	getAddressPreferences	住所一覧取得
POST	`/address_preference`	createAddressPreference	住所作成
GET	`/agents`	getAgents	EU 認定代理人取得
GET	`/battery_qualifications`	getBatteryQualifications	バッテリー資格取得
POST	`/bundle`	createBundle	バンドル作成
GET	`/bundle/{bundle_id}`	getBundle	バンドル詳細取得
POST	`/bundle/{bundle_id}/cancel`	cancelBundle	バンドルキャンセル
GET	`/bundle/{bundle_id}/label`	getBundleLabel	バンドルラベル取得
POST	`/complaint`	createComplaint	苦情作成
GET	`/consign_preference`	getConsignPreferences	委託住所一覧取得
POST	`/consign_preference`	createConsignPreference	委託住所作成
GET	`/dropoff_sites`	getDropoffSites	ドロップオフサイト取得
GET	`/handover_sheet`	getHandoverSheet	引渡し票取得
GET	`/labels`	getLabels	配送ラベル取得
POST	`/package`	createPackage	荷物作成
GET	`/package/{package_id}`	getPackage	荷物詳細取得
DELETE	`/package/{package_id}`	deletePackage	荷物削除
POST	`/package/{package_id}/cancel`	cancelPackage	荷物キャンセル
POST	`/package/{package_id}/clone`	clonePackage	荷物クローン
POST	`/package/{package_id}/confirm`	confirmPackage	荷物確認
GET	`/package/{order_line_item_id}/item`	getPackagesByLineItemID	明細項目 ID で荷物取得
POST	`/package/bulk_cancel_packages`	bulkCancelPackages	一括キャンセル
POST	`/package/bulk_confirm_packages`	bulkConfirmPackages	一括確認
POST	`/package/bulk_delete_packages`	bulkDeletePackages	一括削除
GET	`/services`	getServices	配送サービス取得
GET	`/tracking`	getTracking	追跡情報取得

スキーマ数: 81（詳細は OpenAPI 仕様を参照）

eDis API ドキュメント

eDIS パブリック配送 API（eDelivery International Shipping API）

認証（OAuth スコープ）

リソース一覧

actual_costs — 実際のコスト（1 エンドポイント）

GET /actual_costs

address_preference — 住所管理（2 エンドポイント）

GET /address_preference

POST /address_preference

agents — EU 認定代理人（1 エンドポイント）

GET /agents

battery_qualifications — バッテリー資格（1 エンドポイント）

GET /battery_qualifications

bundle — バンドル管理（4 エンドポイント）

POST /bundle

GET /bundle/{bundle_id}

POST /bundle/{bundle_id}/cancel

GET /bundle/{bundle_id}/label

complaint — 苦情（1 エンドポイント）

POST /complaint

consign_preference — 委託住所管理（2 エンドポイント）

GET /consign_preference

POST /consign_preference

dropoff_sites — ドロップオフサイト（1 エンドポイント）

GET /dropoff_sites

handover_sheet / labels — 引渡し票とラベル（2 エンドポイント）

GET /handover_sheet

GET /labels

package — 荷物管理（11 エンドポイント）

POST /package

GET /package/{package_id}

DELETE /package/{package_id}

POST /package/{package_id}/cancel

POST /package/{package_id}/clone

POST /package/{package_id}/confirm

GET /package/{order_line_item_id}/item

POST /package/bulk_cancel_packages

POST /package/bulk_confirm_packages

POST /package/bulk_delete_packages

services / tracking — 配送サービスと追跡（2 エンドポイント）

GET /services

GET /tracking

エンドポイント一覧（全 27 エンドポイント）

GET `/actual_costs`

GET `/address_preference`

POST `/address_preference`

GET `/agents`

GET `/battery_qualifications`

POST `/bundle`

GET `/bundle/{bundle_id}`

POST `/bundle/{bundle_id}/cancel`

GET `/bundle/{bundle_id}/label`

POST `/complaint`

GET `/consign_preference`

POST `/consign_preference`

GET `/dropoff_sites`

GET `/handover_sheet`

GET `/labels`

POST `/package`

GET `/package/{package_id}`

DELETE `/package/{package_id}`

POST `/package/{package_id}/cancel`

POST `/package/{package_id}/clone`

POST `/package/{package_id}/confirm`

GET `/package/{order_line_item_id}/item`

POST `/package/bulk_cancel_packages`

POST `/package/bulk_confirm_packages`

POST `/package/bulk_delete_packages`

GET `/services`

GET `/tracking`