Fulfillment API ドキュメント

フルフィルメント API(Fulfillment API)

Fulfillment API を使用すると、チェックアウト時に指定された支払い方法とタイミングに従って、販売者に代わって各注文の梱包、宛先指定、処理、発送のプロセスを完了できます。注文の取得・管理、配送フルフィルメントの作成、払い戻しの発行、支払い紛争の管理をサポートします。

重要: EU/UK の販売者に対する issueRefund 呼び出しにはデジタル署名による追加のセキュリティ検証が必要です。

バージョン: v1.20.7

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

認証(OAuth スコープ)

この API は 認可コード(Authorization Code) フローを使用します。

スコープ説明
https://api.ebay.com/oauth/api_scope/sell.fulfillment注文フルフィルメントの表示と管理
https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly注文フルフィルメントの表示
https://api.ebay.com/oauth/api_scope/sell.finances支払いおよび注文情報の表示と管理
https://api.ebay.com/oauth/api_scope/sell.payment.dispute紛争と関連詳細の表示と管理

リソース一覧

Fulfillment API は以下の 3 リソース、合計 15 エンドポイント(7 GET + 7 POST + 1 GET)で構成されています。

リソース説明
order注文の検索・取得、配送フルフィルメントの作成・管理、払い戻し6
payment_dispute支払い紛争の詳細取得・承認・異議・証拠管理8
payment_dispute_summary支払い紛争のフィルター検索1

order — 注文管理(6 エンドポイント)

GET /order

getOrders — 作成日、最終変更日、フルフィルメントステータスに基づいて注文を検索・取得します。最大 2 年前まで取得可能。デフォルトでは過去 90 日以内の注文を返します。

パラメータ場所必須説明
fieldGroupsクエリ任意TAX_BREAKDOWN — 税金と手数料の内訳を返します。
filterクエリ任意creationdatelastmodifieddateorderfulfillmentstatus でフィルタリング。
limitクエリ任意最大: 200、デフォルト: 50
offsetクエリ任意デフォルト: 0
orderIdsクエリ任意注文 ID のカンマ区切りリスト(最大 50)。指定時は他のパラメータを無視。

レスポンス: 200 / 400 / 500

GET /order/{orderId}

getOrder — 指定された注文 ID の詳細を取得します。キャンセルリクエスト情報を含みます。

パラメータ場所必須説明
orderIdパス必須注文の一意の識別子。
fieldGroupsクエリ任意TAX_BREAKDOWN

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

GET /order/{orderId}/shipping_fulfillment

getShippingFulfillments — 指定された注文のすべての配送フルフィルメントを取得します。

パラメータ場所必須説明
orderIdパス必須注文の一意の識別子。

レスポンス: 200 / 400 / 500

POST /order/{orderId}/shipping_fulfillment

createShippingFulfillment — パッケージの配送フルフィルメントを作成します。パッケージごとに 1 回呼び出します。

パラメータ場所必須説明
orderIdパス必須注文の一意の識別子。
Content-Typeヘッダー必須application/json

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

GET /order/{orderId}/shipping_fulfillment/{fulfillmentId}

getShippingFulfillment — 特定の配送フルフィルメントの詳細を取得します。

パラメータ場所必須説明
orderIdパス必須注文の一意の識別子。
fulfillmentIdパス必須フルフィルメントの一意の識別子。

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

POST /order/{order_id}/issue_refund

issueRefund — 購入者に全額または一部の払い戻しを発行します。注文レベルまたは明細レベルで可能。非同期処理のため、後続の getOrder でステータスを確認してください。

パラメータ場所必須説明
order_idパス必須注文の一意の識別子。
Content-Typeヘッダー必須application/json

レスポンス: 200 / 400 / 403 / 404 / 409 / 500

payment_dispute — 支払い紛争管理(8 エンドポイント)

GET /payment_dispute/{payment_dispute_id}

getPaymentDispute — 支払い紛争の詳細情報(ステータス、金額、理由、関連注文、対応オプション、結果、証拠)を取得します。

パラメータ場所必須説明
payment_dispute_idパス必須支払い紛争の一意の識別子。

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

POST /payment_dispute/{payment_dispute_id}/accept

acceptPaymentDispute — 支払い紛争を承認します。revision フィールド必須。返品が必要な場合は returnAddress を指定。

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

GET /payment_dispute/{payment_dispute_id}/activity

getActivities — 支払い紛争のアクティビティログ(作成から解決までの全ステップ)を取得します。

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

POST /payment_dispute/{payment_dispute_id}/add_evidence

addEvidence — 支払い紛争に証拠ファイルを追加します。contestPaymentDispute の前に全証拠をアップロードする必要があります。

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

POST /payment_dispute/{payment_dispute_id}/contest

contestPaymentDispute — 支払い紛争に異議を申し立てます。事前に全サポートファイルのアップロードが必要です。

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

GET /payment_dispute/{payment_dispute_id}/fetch_evidence_content

fetchEvidenceContent — 支払い紛争の特定の証拠ファイルを取得します。

パラメータ場所必須説明
payment_dispute_idパス必須支払い紛争 ID。
evidence_idクエリ必須証拠ファイルセット ID。
file_idクエリ必須証拠ファイル ID。

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

POST /payment_dispute/{payment_dispute_id}/update_evidence

updateEvidence — 既存の証拠セットに証拠ファイルを追加・更新します。

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

POST /payment_dispute/{payment_dispute_id}/upload_evidence_file

uploadEvidenceFile — 証拠ファイルをアップロードします。multipart/form-data 形式。サポート: .JPEG、.JPG、.PNG。キー名は「file」。

パラメータ場所必須説明
payment_dispute_idパス必須支払い紛争 ID。
Content-Typeヘッダー必須multipart/form-data

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

payment_dispute_summary — 紛争検索(1 エンドポイント)

GET /payment_dispute_summary

getPaymentDisputeSummaries — フィルターで支払い紛争を検索します。フィルターなしの場合は全ての未解決・最近解決済みの紛争を返します。

パラメータ場所必須説明
order_idクエリ任意注文 ID でフィルター。使用時は他フィルター無視。
buyer_usernameクエリ任意購入者のユーザー名でフィルター。
open_date_fromクエリ任意日付範囲の開始日(ISO-8601 UTC)。最大 18 か月前。
open_date_toクエリ任意日付範囲の終了日。最大 90 日間。
payment_dispute_statusクエリ任意紛争ステータスでフィルター(複数指定可)。
limitクエリ任意最小: 1、最大: 200、デフォルト: 200
offsetクエリ任意デフォルト: 0

レスポンス: 200 / 400 / 500

エンドポイント一覧(全 15 エンドポイント)

メソッドエンドポイントoperationId説明
GET/ordergetOrders注文の検索・取得
GET/order/{orderId}getOrder注文の詳細取得
GET/order/{orderId}/shipping_fulfillmentgetShippingFulfillments配送フルフィルメント一覧
POST/order/{orderId}/shipping_fulfillmentcreateShippingFulfillment配送フルフィルメント作成
GET/order/{orderId}/shipping_fulfillment/{fulfillmentId}getShippingFulfillment配送フルフィルメント詳細
POST/order/{order_id}/issue_refundissueRefund払い戻し発行
GET/payment_dispute/{payment_dispute_id}getPaymentDispute支払い紛争の詳細取得
POST/payment_dispute/{payment_dispute_id}/acceptacceptPaymentDispute支払い紛争を承認
GET/payment_dispute/{payment_dispute_id}/activitygetActivities紛争アクティビティログ
POST/payment_dispute/{payment_dispute_id}/add_evidenceaddEvidence証拠ファイルを追加
POST/payment_dispute/{payment_dispute_id}/contestcontestPaymentDispute紛争に異議申し立て
GET/payment_dispute/{payment_dispute_id}/fetch_evidence_contentfetchEvidenceContent証拠ファイルを取得
POST/payment_dispute/{payment_dispute_id}/update_evidenceupdateEvidence証拠を更新
POST/payment_dispute/{payment_dispute_id}/upload_evidence_fileuploadEvidenceFile証拠ファイルをアップロード
GET/payment_dispute_summarygetPaymentDisputeSummaries支払い紛争を検索

スキーマ数: 76(詳細は OpenAPI 仕様を参照)

トップに戻る