FAQ
Trading APIでの商品や受注を特定するIDについて
Trading APIでは、出品や受注データを特定する際、次のIDが使用されます。
ID | 説明 |
---|---|
ItemID | eBayに出品すると特定できるユニークなIDをとしてItemIDが自動的に付与される。 |
SKU | APIで出品する際、ユーザが管理用としてSKUをつけることが可能。 |
OrderID | eBayで取引が成立すると、受注データの生成され、それを特定できるIDとしてOrderIDが付与される。 |
TransactionID | eBayで取引が成立すると、その取引に含まれる商品ごとにTransactionIDが生成される。このTransactionIDは、単体で取引の商品を特定可能ではないため、取引の1つの商品を指定したい場合、ItemIDとTransactionIDの両方を使用する必要がある。オークション形式の出品の場合、TransactionIDは常に「0」がセットされる。 |
OrderLineItemID | OrderLineItemIDは、ItemIDとTransactionIDを「-」(ハイフン)で繋いだものである。OrderLineItemID単体で取引の1つの商品を特定可能。取引内に含まれる商品がひと通りのみの場合、OrderIDとOrderLineItemIDは同じ値となる。 |
ReviseInventoryStatusコールで在庫を0で更新する
通常在庫には1以上の数を指定する必要があり、エラーになります。 ただし、「Out of stock feature(在庫切れ管理機能)」を有効にして登録した、出品期間が「Goot ’Til Cancelled」 の商品は、0を指定して在庫切れ状態にすることができます。この場合は出品は終了せず、在庫ぎれ状態で残ります。日本語の機能説明は、「アウト・オブ・ストック(在庫切れ)オプション機能の導入」ニュースに掲載さています。 詳細は、Out of stock feature for GTC Itemsを参照下さい。
ユーザトークンの文字列の長さ
Trading APIの互換バージョン指定
eBay Trading APIでは、リクエストヘッダーに X-EBAY-API-COMPATIBILITY-LEVEL でバージョン指定する方式になっています。 このバージョンを指定することで、互換バージョンが明記されます。 Trading APIでは、過去18ケ月までの古いバージョンの互換性を保証しています。 それより古いバージョンの場合は、互換性が失われている可能性があるため、この期間を目処にアプリケーションとAPIの互換性をチェックする必要があります。 詳細は、eBay Schema Versioning Strategyを参照下さい。
eBay Sandbox(テスト環境)について
eBay Sandbox は、”縮小版” eBay サイトともいえる テスト用環境です。Sandboxでは eBay サイトの重要な機能のほとんどを 提供しており、アプリケーション作成やテストを本番環境以外で行うことができます。 eBay Sandbox は、API および 画面操作(GUI)による サイトのテストの両方をサポートしています。(※Sandboxでのサポート対象外機能一覧)
eBay アプリケーション開発を始めるには
eBay APIを使った アプリケーションを開発するためには、まずeBay developer program(英語サイト)にてアカウントを取得し、Sandbox(テスト環境)のユーザー登録や、アプリケーションキーの登録などが必要となります。 詳しくはこちらをご覧ください。
ユーザトークンとは
出品など販売支援アプリケーションを、開発者からセラーに提供する場合、そのアプリケーションからセラーに代わりセラーのデータにアクセスする権限が必要になります。 その権限移譲を安全に行うために、ユーザトークンを使った仕組みが用意されています。 アプリケーション側から利用するセラーの同意の上、ユーザトークンを取得することで、セラーに代わってeBayに対する必要な操作をアプリケーションから行うことが可能になります。 ユーザトークン取得方法は、 ユーザトークンの取得を参照ください。 また英語サイトでは、詳細な処理フローを説明したチュートリアル(英語サイト)もあります。
どのようなeBay APIが提供されているか?
eBay APIは開発者にeBayプラットフォームへの直接アクセスを提供するために、 以下のような機能をAPIにて提供しています。
- 出品(新規出品、再出品、商品編集など)
- 検索(特定キーワードでの検索など)
- 商品(商品の詳細情報の取得)
- My eBay(My eBay で提供する機能など)
- 受注(入札、販売情報の取得など)
- フィードバック機能
- カテゴリサジェスト(タイトルよりカテゴリIDをサジェスト)
アプリケーションキーとは
アプリケーションキーとはソフトウェア開発者を識別するユニークキーです。 eBay APIを呼び出す際に必須の情報となります。 My Account(英語サイト)ページ にてProduction環境、Sandbox環境、それぞれのアプリケーションキーを生成します。 アプリケーションキーを生成すると、DevID、AppID、CertID が生成されます。これらの3つのIDのセットで、アプリケーションキーとなります。
- DevID : デベロッパーアカウントを識別するキー
- AppID : アプリケーションを識別するキー
- CertID : API呼び出し時にアプリケーションを認証するキー
eBay developer programとの違い
イーベイ(eBay)デベロッパーポータルは、イーベイ・ジャパンが提供/運営している日本の開発者向けサイトとなります。 eBay developer program(英語サイト)はeBay, Inc. が提供/運営している開発者向けサイトとなり、全てのコンテンツは英語で提供されています。 イーベイ(eBay)デベロッパーポータルは、eBay developer program(英語サイト)のコンテンツの翻訳も含めコンテンツを提供していますが、 最新情報に関してはeBay developer program(英語サイト)も参考にして頂けると鮮度の高い情報を得ることが可能です。 ※参考:eBay developer program FAQ Page(英語サイト)