Yahoo!ショッピングAPIのよくあるご質問

目次

Client ID（アプリケーションID）について

「Client ID（アプリケーションID）」はどこで確認ができますか？
Yahoo! JAPAN IDでログインした状態でこちらページをご確認ください。
「Please provide valid credentials...」が返ってくる。

ご利用中の"Client ID（アプリケーションID）"にショッピングAPIの利用権限が付いていない可能性があります。

下記レスポンスが対象です。 

Please provide valid credentials. Bearer realm="yahooapis.jp",
    error="insufficient_scope", error_description="insufficient scope"

  1. 「アプリケーションの管理」ページで"Client ID（アプリケーションID）"に付いた権限を確認します。
  2. 「アプリケーション一覧」からご利用中のアプリケーションを選択する。
  3. ページ下部の「利用するスコープ」を確認する。
  4. 「ストア向け操作関連の機能 (開示先限定スコープ)」が付いていない場合
    →「新しいアプリケーションを開発」からIDを取得する。
    「ストア向け操作関連の機能 (開示先限定スコープ)」が付いている場合
    →そのままご利用いただいて問題ございません。

Yahoo!ID連携（v2）について

リフレッシュトークンが突然無効になりました
リフレッシュトークンは有効期限前でもパスワード変更やユーザの同意撤回により無効になることがあります。
更新時にinvalid_grantが返却されたらAuthorizationリクエストからやり直してください。
ログインしようとすると"redirect_uri is invalid."と表示されます
Client ID（アプリケーションID）に設定されている「コールバックURL」とリクエスト時のredirect_uriパラメータの値が一致している必要があります。
「コールバックURL」はClient ID（アプリケーションID）を発行したYahoo! Japan IDでログインした状態で下記ページをご確認ください。
https://e.developer.yahoo.co.jp/dashboard/
リフレッシュトークンを期限切れ前に再取得すると古いリフレッシュトークンは無効になりますか?
有効期限が切れる前にトークンを取得しなおした場合、リフレッシュトークンの文字列は新しい文字列・有効期限に更新されます。
古いリフレッシュトークンは無効になる場合がありますので、取得後は新しいリフレッシュトークンに置き換えていただくことを推奨します。
有効期限が切れた後にトークンを取得すると新しい文字列のリフレッシュトークンになります。
アクセストークンを期限切れ前に更新すると古いアクセストークンは無効になりますか?
即時に無効にはなりません。新旧どちらも有効です。
「シークレット」はどこで確認できますか？
Yahoo! JAPAN IDでログインした状態でこちらページをご確認ください。

「注文API」「問い合わせ管理API」「定期購入API」の利用申請について

「px-04303 ： This application ID is not registered for using order API. Use of order API requires an application ID.」が返ってくる。

注文・お問い合わせ管理・定期購入APIを利用するためには、別途利用申請が必要です。
利用権限がないClient ID（アプリケーションID）でリクエストをしているためエラーを返しています。

下記ページからお申し込みください。
注文・お問い合わせ管理・定期購入API利用申請フォーム

「px-04306 ： Access from this IP address is not allowed.」が返ってくる。

登録されていないIPアドレスからリクエストをしているためエラーを返しています。
追加登録は、「Q. IPアドレスの追加・変更をしたい。」をご参照ください。

IPアドレスの追加・変更をしたい。
ショッピングAPI利用申請フォームから再申請をお願い致します。
（IPの部分は追加分の情報のみで問題ございません。）
設定完了の連絡が来ない。
設定完了まで約1週間～10日程度お時間をいただく場合がございます。
設定完了後、申請時に入力したメールアドレス宛に通知がされます。
申請時に入力した"IPアドレス"を確認できますか?
恐れ入りますが、利用者様のほうで確認をできるページ等は用意しておりません。
「px-04303」や「px-04306」のエラーへの対処方法は各説明をご参照ください。

「公開鍵認証」について

公開鍵はどこから取得できますか？
ストアクリエイターPro > 設定 > 暗号鍵 ページから取得することができます。
ストアクリエイターPro > 設定 > 暗号鍵　ページにアクセスできません。
管理者権限を持った方のみ暗号鍵ページにアクセスすることが可能です
取得した後はどうすればいいですか？
ヘルプの「公開鍵の利用方法」をご確認ください。
有効期限切れ前にメールが来た。更新をするにはどうしたらいいですか?
新しい公開鍵を発行し、そちらをご利用下さい。
利用中の公開鍵の有効期限はいつまでですか？
有効期限は発行から1年間です。
公開鍵の有効期限は、ストアクリエイターPro > 設定 > 暗号鍵ページから確認することができます。
期限切れ1,2か月前の2回メールで告知を行っております。
公開鍵は最大でいくつまで発行ができますか？
公開鍵は最大で５つまで発行することができます。
ただし、同時に使用できる公開鍵は最大２つまでとなっております。

「PayPay」について

クレジットカードを併用された場合のレスポンスは？

※テスト環境を利用して実際のレスポンスをご確認ください。

注文詳細API
【「PayPay」+「クレジットカード決済」併用の場合】をご確認ください。

▼ 説明

  • PayMethod（支払い方法）
    メインの支払い方法である「PayPay残高払い（payment_a17）」がセットされます。
  • CombinedPayMethod（併用お支払い方法）
    併用する支払い方法の「クレジットカード決済（payment_a1）」がセットされます。
  • TotalPrice（合計金額）
    支払う金額の合計がセットされます。
  • PayMethodAmount（支払い金額）
    「PayPay残高払い」で支払う金額がセットされます
  • CombinedPayMethodAmount（併用支払い金額）
    「クレジットカード決済」で支払う金額がセットされます。

エラー全般について

エラーコードの一覧はありますか？
Yahoo! ショッピングAPI共通のエラーコード一覧については下記ページをご確認ください。
Yahoo! ショッピングAPI共通エラーコード一覧
各API固有のエラーコードに関しては、それぞれのマニュアルページにある「エラー」をご確認ください。
エラーメッセージ「Your Request was Forbidden」が返ってくる。
原因として以下3点が考えられます。
  • リクエスト数が上限（50000回）を超えている。
    対処方法：1日50,000リクエストを超える場合は、Client ID（アプリケーションID）を追加してご対応ください。
  • 存在しないClient ID（アプリケーションID）でリクエストしている。
    対処方法：実際にリクエストを行っているClient ID（アプリケーションID）をご確認ください。
  • 接続が許可されていないClient ID（アプリケーションID）でアクセスしている。
    対処方法：Client ID（アプリケーションID）の再取得をお試しください。
    参考　ショッピングAPI導入までの流れ
エラーメッセージ「invalid_token」が返ってくる。
以下のようなレスポンスが返ってくる場合は、アクセストークンの有効期限が切れております。
リフレッシュトークンを利用してアクセストークンの更新をお願いします。 
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>
Please provide valid credentials. Bearer realm="yahooapis.jp", error="invalid_token", error_description="expired token"
</Message>
</Error>
エラーコード「od91008」が返ってくる。
※注文ステータス変更API(orderStatusChange)にリクエストしている場合
出荷ステータス更新API(orderShipStatusChange)を実行した直後に
注文ステータス変更API(orderStatusChange)にリクエストすると、こちらのエラーが発生する可能性があります。
出荷ステータス更新APIを実行した場合は、実行後しばらく時間をおいてから注文ステータス変更APIを実行してください。
HTTPステータスコード「429」が返ってくる。
短期間に大量の商品データアップロードが原因の、サーバー高負荷による反映処理遅延の対策として「商品データアップロードガイドライン」を制定しており、
1つのアプリケーションに対して、リクエストは 5rps までとさせていただいております。

参考：【重要】商品データアップロードガイドラインのご案内

テスト環境（sandbox）について

ストアアカウントを確認したい。
ストアアカウントは設定完了メールに記載しております。
件名：【重要】テスト環境利用申請者の方へご案内：Yahoo!ショッピング
利用申請をしたが、メールが届かない。
過去に利用申請をしている場合、メール配信を行っておりません。
発行済みのテスト環境の詳細については、新規発行時に配信しているメールをご確認ください。
件名：【重要】テスト環境利用申請者の方へご案内：Yahoo!ショッピング
※１つのYahoo!JAPAN IDにつき、利用できるテスト環境は１つのみです。
エラーが出てテスト注文ができません。
「反映」実施してください。
未反映項目がない場合は、反映項目を発生させてから反映をお願いします。
FTPサーバは利用できますか？
テスト環境についてはFTPサーバを用意しておりません。
テスト用のクレジットカードはありますか？
ご用意しております。
Yahoo!デベロッパーネットワーク（ショッピング）
ページ上部にある「Yahoo!ショッピングAPIマニュアル（pdf）」の「テスト環境でクレジットカード決済を利用する」ページをご確認ください。
「ポイント」を利用した注文はできますか？
テスト環境では「ポイント」の付与・利用ができないようになっております。
その他、本番環境との仕様の違いはこちらのページに記載しております。
「クーポン」を利用した注文はできますか？
テスト環境では「ストアクーポン」の発行・利用ができないようになっております。
なお、ストアクーポンの新規発行機能が利用制限されておらず発行できてしまった場合でも、正常に動作しませんので利用はされないようにお願いします。

その他、本番環境との仕様の違いはこちらのページに記載しております。
テスト（sandbox）環境で注文した注文履歴を確認することはできますか？
テスト（sandbox）環境で注文したYahoo!JAPAN IDでログインした状態で
下記URLにアクセスをしてください。

　注文履歴一覧
　https://test.odhistory.shopping.yahoo.co.jp/order-history/list

「注文詳細を確認する」をクリックすると注文履歴詳細ページが表示されます。

ショッピングAPIの利用について

サンプルコードはありませんか？

ご用意しております。
ヘルプの「ショッピングAPIのサンプルコードについて」をご確認ください。

サーバを移管しました。
必要な対応はありますか？
注文・問い合わせ管理・定期購入APIを利用していて、リクエスト元IPアドレスに変更がある場合のみ申請をお願いします。
下記ページからお申し込みください。（新しいIPをご入力ください。）
注文・お問い合わせ管理・定期購入API利用申請フォーム
利用回数に制限はありますか？

短時間に大量のリクエストが行われた場合には、利用を制限させていただくことがあります。

制限状態になると、HTTPステータスコード500を返却いたしますが、一定時間アクセスを控えて頂ければ自動で制限は解除されます。
（制限状態のレスポンスボディーには、ご覧になろうとしているページは現在表示ができない旨をお知らせするHTMLを返却いたしますが、デザインは予告なく変更する可能性がございますので、HTMLと掲載している文章の仕様公開はしておりません）

なお、制限にかかる条件、および制限を解除するための条件は非公開とさせて頂いております。

また、商品データアップロードでは個別にガイドラインも設けておりますので、そちらもご確認ください。

アプリケーションの管理

利用のルール

開発のヒント