Logistics API ドキュメント

ロジスティクス API（Logistics API）

Logistics API は、eBay が交渉した配送料金の取得、配送ラベルの作成、出荷の管理を提供する限定リリース API です。USPS の配送料金とラベルのみをサポートしています。

注: これは限定リリース API であり、ビジネスユニットによって承認された特定の開発者のみが利用できます。

重要: セラーは、この API を使用する前に eBay アカウントで支払い方法を設定する必要があります。

バージョン: v1_beta.0.0

ベースURL: https://api.ebay.com/sell/logistics/v1_beta

認証（OAuth スコープ）

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

スコープ	説明
`https://api.ebay.com/oauth/api_scope/sell.logistics`	ロジスティクス情報へのアクセス

リソース一覧

Logistics API は以下の 2 リソース、合計 6 エンドポイント（2 GET + 2 POST + 1 POST + 1 GET）で構成されています。

リソース	説明	数
shipment	出荷の作成、取得、キャンセル、ラベルダウンロード	4
shipping_quote	配送見積もりの作成と取得	2

shipment — 出荷管理（4 エンドポイント）

POST `/shipment/create_from_shipping_quote`

createFromShippingQuote — 配送見積もりから出荷を作成します。選択した料金に基づいて配送ラベルが生成され、追加の配送オプションを含めることができます。出荷を作成すると、合計配送コストが請求契約アカウントに請求されます。

パラメータ	場所	必須	説明
`Content-Type`	ヘッダー	必須	`application/json`
`X-EBAY-C-MARKETPLACE-ID`	ヘッダー	必須	出荷の eBay マーケットプレイス。

リクエストボディ: CreateShipmentFromQuoteRequest

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

GET `/shipment/{shipmentId}`

getShipment — 指定された出荷 ID の出荷詳細を取得します。

パラメータ	場所	必須	説明
`shipmentId`	パス	必須	出荷の一意の識別子（createFromShippingQuote で生成）。

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

POST `/shipment/{shipmentId}/cancel`

cancelShipment — 出荷をキャンセルし、関連する配送ラベルを削除します。合計配送コストが請求契約アカウントに返金されます。配送ラベルが使用済みの場合はキャンセルできません。

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

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

GET `/shipment/{shipmentId}/download_label_file`

downloadLabelFile — 出荷に関連する配送ラベルファイルをダウンロードします。デフォルトのファイル形式は PDF です。

パラメータ	場所	必須	説明
`shipmentId`	パス	必須	配送ラベルに関連する出荷の一意の識別子。
`Accept`	ヘッダー	必須	`application/pdf`

レスポンス: 200 → PDF ファイル / 400 / 404 / 500

shipping_quote — 配送見積もり（2 エンドポイント）

POST `/shipping_quote`

createShippingQuote — ライブの配送料金リストを含む配送見積もりを返します。料金は発送元、配送先、パッケージサイズに基づき、すべて eBay が交渉した価格です。USPS のみサポート。

パラメータ	場所	必須	説明
`Content-Type`	ヘッダー	必須	`application/json`
`X-EBAY-C-MARKETPLACE-ID`	ヘッダー	必須	配送見積もりの eBay マーケットプレイス。

リクエストボディ: ShippingQuoteRequest

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

GET `/shipping_quote/{shippingQuoteId}`

getShippingQuote — 指定された配送見積もりの詳細を取得します。

パラメータ	場所	必須	説明
`shippingQuoteId`	パス	必須	配送見積もりの一意の識別子（createShippingQuote で生成）。

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

スキーマ定義（全 19 スキーマ）

出荷

CreateShipmentFromQuoteRequest

フィールド	型	説明
`shippingQuoteId`	string	配送見積もり ID
`rateId`	string	選択した料金 ID
`additionalOptions`	array[AdditionalOption]	追加配送オプション
`labelSize`	string	ラベルサイズ
`labelCustomMessage`	string	ラベルのカスタムメッセージ
`returnTo`	Contact	返品先

Shipment

フィールド	型	説明
`shipmentId`	string	出荷 ID
`shipmentTrackingNumber`	string	追跡番号
`rate`	PurchasedRate	購入した料金情報
`shipFrom`	Contact	発送元
`shipTo`	Contact	配送先
`returnTo`	Contact	返品先
`orders`	array[Order]	関連する注文
`packageSpecification`	PackageSpecification	パッケージ仕様
`labelDownloadUrl`	string	ラベルダウンロード URL
`labelSize`	string	ラベルサイズ
`labelCustomMessage`	string	ラベルのカスタムメッセージ
`cancellation`	ShipmentCancellation	キャンセル情報
`creationDate`	string	作成日時

ShipmentCancellation

フィールド	型	説明
`cancellationRequestedDate`	string	キャンセル依頼日時
`cancellationStatus`	string	キャンセルステータス

PurchasedRate

フィールド	型	説明
`rateId`	string	料金 ID
`shippingQuoteId`	string	配送見積もり ID
`shippingCarrierCode`	string	配送業者コード
`shippingCarrierName`	string	配送業者名
`shippingServiceCode`	string	配送サービスコード
`shippingServiceName`	string	配送サービス名
`baseShippingCost`	Amount	基本配送コスト
`totalShippingCost`	Amount	合計配送コスト
`additionalOptions`	array[AdditionalOption]	追加オプション
`minEstimatedDeliveryDate`	string	最短配達予定日
`maxEstimatedDeliveryDate`	string	最長配達予定日
`pickupType`	string	集荷タイプ
`pickupSlotId`	string	集荷スロット ID
`pickupNetworks`	array[string]	集荷ネットワーク
`destinationTimeZone`	string	配送先タイムゾーン

配送見積もり

ShippingQuoteRequest

フィールド	型	説明
`orders`	array[Order]	関連する注文
`packageSpecification`	PackageSpecification	パッケージ仕様（サイズ、重量）
`shipFrom`	Contact	発送元
`shipTo`	Contact	配送先

ShippingQuote

フィールド	型	説明
`shippingQuoteId`	string	配送見積もり ID
`rates`	array[Rate]	利用可能な料金の配列
`orders`	array[Order]	関連する注文
`packageSpecification`	PackageSpecification	パッケージ仕様
`shipFrom`	Contact	発送元
`shipTo`	Contact	配送先
`creationDate`	string	作成日時
`expirationDate`	string	有効期限
`warnings`	array[Error]	警告

Rate

フィールド	型	説明
`rateId`	string	料金 ID
`shippingCarrierCode`	string	配送業者コード
`shippingCarrierName`	string	配送業者名
`shippingServiceCode`	string	サービスコード
`shippingServiceName`	string	サービス名
`baseShippingCost`	Amount	基本配送コスト
`additionalOptions`	array[AdditionalOption]	追加オプション
`rateRecommendation`	array[string]	推奨事項
`minEstimatedDeliveryDate`	string	最短配達予定日
`maxEstimatedDeliveryDate`	string	最長配達予定日
`pickupType`	string	集荷タイプ
`pickupSlots`	array[PickupSlot]	集荷スロット
`pickupNetworks`	array[string]	集荷ネットワーク
`destinationTimeZone`	string	配送先タイムゾーン

共通型

Contact

フィールド	型	説明
`fullName`	string	フルネーム
`companyName`	string	会社名
`contactAddress`	ContactAddress	住所
`primaryPhone`	PhoneNumber	電話番号

ContactAddress

フィールド	型	説明
`addressLine1`	string	住所 1 行目
`addressLine2`	string	住所 2 行目
`city`	string	市区町村
`stateOrProvince`	string	都道府県/州
`postalCode`	string	郵便番号
`countryCode`	string	国コード
`county`	string	郡

PackageSpecification

フィールド	型	説明
`dimensions`	Dimensions	寸法
`weight`	Weight	重量

Dimensions

フィールド	型	説明
`height`	string	高さ
`length`	string	長さ
`width`	string	幅
`unit`	string	単位

Weight

フィールド	型	説明
`value`	string	重量値
`unit`	string	単位

Amount

フィールド	型	説明
`currency`	string	通貨コード
`value`	string	金額

AdditionalOption

フィールド	型	説明
`optionType`	string	オプションタイプ
`additionalCost`	Amount	追加コスト

Order

フィールド	型	説明
`orderId`	string	注文 ID
`channel`	string	チャネル

PickupSlot

フィールド	型	説明
`pickupSlotId`	string	集荷スロット ID
`pickupSlotStartTime`	string	開始時間
`pickupSlotEndTime`	string	終了時間
`pickupSlotTimeZone`	string	タイムゾーン

PhoneNumber

フィールド	型	説明
`phoneNumber`	string	電話番号

Error

フィールド	型	説明
`category`	string	エラーカテゴリ
`domain`	string	エラードメイン
`errorId`	integer	エラー ID
`message`	string	短いメッセージ
`longMessage`	string	詳細メッセージ
`inputRefIds`	array[string]	入力参照 ID
`outputRefIds`	array[string]	出力参照 ID
`parameters`	array[ErrorParameter]	エラーパラメータ
`subdomain`	string	エラーサブドメイン

ErrorParameter

フィールド	型	説明
`name`	string	パラメータ名
`value`	string	パラメータ値

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

メソッド	エンドポイント	operationId	説明
POST	`/shipment/create_from_shipping_quote`	createFromShippingQuote	配送見積もりから出荷を作成
GET	`/shipment/{shipmentId}`	getShipment	出荷詳細を取得
POST	`/shipment/{shipmentId}/cancel`	cancelShipment	出荷をキャンセル
GET	`/shipment/{shipmentId}/download_label_file`	downloadLabelFile	配送ラベルをダウンロード
POST	`/shipping_quote`	createShippingQuote	配送見積もりを作成
GET	`/shipping_quote/{shippingQuoteId}`	getShippingQuote	配送見積もりの詳細を取得