YJDNショッピングAPI ユーザーズマニュアル Ver.1.3 2016年9月15日 ヤフー株式会社 ショッピングカンパニー Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 改訂履歴 Ver. 改定内容 改定日 1.0 初版公開 2015/12/15 1.1 P.19、P.20の記述を改定しました。 アプリケーションIDは全ストア共通にすることを推奨します。ストア アカウントごとに分ける必要はありません。 2016/2/17 1.2 ストアクリエイターProのトップページ画像を差し替えました。 2016/3/10 1.3 P.50、P.51のAPI証明書発行フォームの画像を差し替えました。 P.57の記述を改定しました。 ・テスト環境で「クレカ決済」が使えるようになりました。 ・「クレカ決済」使用可能に伴い、P.71を追加しました。 ・Yahoo!マネー/預金払いが使えるようになりました。 ・API関連の「旧在庫API」を削除しました（サービス終了のため）。 P.60に商品レビューに関する記述を追加しました。 2016/9/15 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 2 もくじ 1.Yahoo!ショッピングとのAPI連携・・・4 2.ログインとYahoo! ID連携 ・・・・・21 3.商品系API ・・・・・・・・・・・・32 4.在庫系API ・・・・・・・・・・・・38 5.注文系API ・・・・・・・・・・・・42 6.YJDN-APIまとめ ・・・・・・・・・53 ・・・・・・・・・58 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 3 1.Yahoo!ショッピングとのAPI連携 2.ログインとYahoo! ID連携 3.商品系API 4.在庫系API 5.注文系API 6.YJDN-APIまとめ 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 4 システム連携を取り巻く４人のプレイヤーと５つのインターフェース パートナー様が活躍している場所 注文、レビュー お客様 Y!Shopping Front YJDN-API アフィリエイトサイト FTP 出店者様システム Yahoo! Shopping 注文確認メール SCPro 出店者様 ※SCPro：ストアクリエイターPro トリプル関連のFTPサーバとgeoサーバは除きます。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 5 システム連携時の入出力とその手段 CSV 個々 ZIP システム CSV ZIP 個々 出店者様 CSV 個々 ZIP YJDNAPI 商品 FTP 画像 注文確認 メール 在庫 SCPro 注文 CSV ：Yahoo!ショッピング指定のCSVフォーマットファイル 個々 ：各データ個々の情報 ZIP ：ZIP圧縮した画像ファイル ：画像ファイル、FTPはダウンロードできません Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 6 YJDN-APIとYIDログイン YJDN(Yahoo! JAPAN Developer Network)とは、 Yahoo! JAPANが持っている情報を、参照したり更新したりす るためのWEB-APIを提供するサービスです。 YJDN-APIには、YID連携（ログイン）不要なAPIとYID連携 （ログイン）必要なAPIの２種類があります。 YJDN API YID連携 不要API YID連携 システム 必要API 商品 画像 在庫 注文 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 7 YID連携不要なAPIとYID連携必要なAPI 2種類のAPIをまとめると次のように整理できます。 YID連携 API種類 不要 参照 更新 ショッピング 情報取得API 参照 http://shopping.yaho のみ oapis.jp・・・ 必要 ストア運営を サポートする API https://circus.shoppin g.yahooapis.jp・・・ 参照 更新 API名 主な用途 商品検索API ランキングAPI アフィリエイト レビュー検索API サイト構築 など 商品系API 在庫系API 画像系API 注文系API など ストア構築 システム連携 参考 http://developer.yahoo.co.jp/webapi/shopping/ Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 8 YID連携が必要なAPIのアクセス権限チェック YIDログイン情報を元に、YIDに紐づくビジネスIDの アクセス権限についてSCProをチェックします。 アクセス権限 YID ビジネスID チェック YIDログイン システム YIDログイン 出店者様 YJDNAPI 権限 チェッ ク SCPro 権限管理設定 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 商品 画像 在庫 注文 9 APIリクエスト時に必要なもの－アプリケーションID アプリケーションを一意に識別するID アプリケーション登録時にリアルタイムで発行 YIDログイン時に取得したAccessTokenを付加し てYJDN-APIをリクエスト アプリケーションID毎にYJDN-APIのリクエスト状 況を全て記録 ストア運営をサポートするAPI YJDNAPI システム AccessToken リクエストを記録 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 10 アプリケーションIDについて 開発者様はアプリケーションID毎にリクエスト数を 把握できます。 1YIDが発行できるアプリケーションIDは10個までで す。 １アプリケーションIDのリクエスト上限値は 50,000リクエスト／日です。 ただし、この上限値は解除できます。 ⇒コール数制限解除。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 11 本番環境とテスト環境 ストア運営をサポートするAPIとSCProには、本番環境とテスト環境があり、 どちらを利用するかはアプリケーションID発行時に指定します。 テスト環境が指定されると、数日以内にテスト環境(SCPro、ストアFront)、 ストアアカウント(snbx-****)をメールで通知します。 本番環境 YJDN-API Yahoo! Shopping SCPro システム テスト環境 YJDN-API 出店者様 SCPro Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 Yahoo! Shopping 12 本番環境とテスト環境の機能差異 テスト環境では一部の機能に制約があります。 http://developer.yahoo.co.jp/webapi/shopping/help.html#attentiontotesttools 機能名 本番環境 テスト環境 ストアアカウント ご希望の文字列 snbx-***（固定） ログインYID ビジネスIDに紐付けた アプリケーションID申請 YID。追加も可能。 時のログインYIDのみ。 YJDN-API機能 機能的な差異はありません アプリケーションID 利用登録時に即座に発行します（共用は不可） ショッピングFront 利用可能 利用不可 ストアFront・カート 利用可能 利用可能 FTPサーバ 利用可能 利用不可 注文確認メール 利用可能 利用可能 SCPro 利用可能 利用可能(一部を除く) Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 13 APIの種類と環境ごとのアプリケーションID発行 API種類 API名 環境 商品検索API ショッピング ランキングAPI 情報取得API レビュー検索API YID連携不要 など ストア運営を サポートする API YID連携必要 商品系API 在庫系API 注文系API など アプリケーション登録 （アプリケーションID） APIのURL 1 https://e.developer.yahoo.co.jp/re http://shopping. 本番環 gister yahooapis.jp/・ 境のみ 1 のAPIのみ利用可 ・・ アプリケーションIDはその場で発行 アプリケーションID取得 https://e.developer.yahoo.co.jp/sh 2 opping/register https://circus.sh 本番環 ※「どちらの用途で発行しますか？」 opping.yahooapi 境 では「本番環境用」を指定します。 s.jp/・・・ 1 2 のAPIが利用可 アプリケーションIDはその場で発行 アプリケーションID取得 https://e.developer.yahoo.co.jp/sh 3 opping/register https://test.circu テスト ※「どちらの用途で発行しますか？」 s.shopping.yaho 環境 では「テスト環境用」を指定します。 oapis.jp/・・・ 3 のAPIのみ利用可 アプリケーションIDはその場で発行 テストアカウントはメールで通知 ご参考：http://developer.yahoo.co.jp/webapi/shopping/ Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 14 アプリケーションの登録方法 アプリケーションID はログインYID単位 に管理されます。 ショッピング情報取得API (YID連携不要なAPI)のみを利用する場合 ストア運営をサポートするAPI (YID連携必要なAPI)も利用する場合 https://e.developer.yahoo.co.jp/shopping/register Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 15 登録したアプリケーションの確認方法 登録済みアプリケーションがどのAPIを利用 できるかは、申請時のYIDでログインして から確認してください。 アプリケーションID の登録内容を 確認できます。 https://e.developer.yahoo.co.jp/dashboard/ Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 16 アプリケーションID発行時のログインYIDと本番環境アクセス アプリケーション登録時にYIDログインして、本番環境用のアプリケーション IDを発行します。 本番環境のYJDN-APIやSCProにYIDログインします（このYIDに紐づくビジネ スIDがSCProの権限管理設定に登録されている必要があります）。 アプリケーションID発行時にログインするYIDと、本番環境のYJDN-APIや SCPro利用時にログインするYIDはセキュリティ上分けてください。 開発者様 1.YIDログイン アプリケーション 登録 アプリ ケーション ID 本番環境 システム 出店者様 2.YIDログイン 3.YIDログイン YJDNAPI SCPro Yahoo! ショッピング 権限管理設定 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 17 アプリケーションID発行時のログインYIDとテスト環境アクセス アプリケーション登録時にYIDログインして、テスト環境用のアプリケーショ ンIDを発行します。 テスト環境のYJDN-APIやSCProにYIDログインします。 アプリケーションID発行時にログインするYIDと、テスト環境のYJDN-APIや SCProにログインするYIDは同一でなければいけません。 開発者様 1.YIDログイン アプリケーション 登録 アプリ ケーション ID テスト環境 システム 出店者様 2.YIDログイン 3.YIDログイン アプリケーションID取得時のYIDのみログイン可能。 ビジネスIDは利用していない。 YJDNAPI YID SCPro Yahoo! ショッピング YID Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 18 １つのアプリケーションを複数の出店者様が利用する １つのアプリケーションIDを使ったソリューションを複数出店者様が利用するイメージ図です。 開発者様 1.YIDログイン アプリケーション 登録 アプリ ケーション ID 本番環境 Aストア システム 2.YIDログイン アプリケーションID YJDNAPI SCPro 権限管理設定 Bストア システム 3.YIDログイン アプリケーションID YJDNAPI SCPro Yahoo! ショッピング 権限管理設定 Cストア システム 4.YIDログイン アプリケーションID YJDNAPI SCPro YIDはセキュリティ上すべて分けてください。 権限管理設定 アプリケーションIDを同一にすれば管理を簡素化できます。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 19 アプリケーションIDとログインYID 開発者様がアプリケーション登録時にログイ ンするYIDは、実際にYJDN-APIを利用する時 にログインするYIDと関連はありません（セ キュリティ上は分けてください）。 アプリケーションIDは全ストア共通にするこ とを推奨します。管理業務も簡素化できます。 (1YIDで発行できるアプリケーションIDは最大 10個です。 YJDN-APIを利用する時には、ログインYIDに よりアクセス権限は厳密に守られます。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 20 1.Yahoo!ショッピングとのAPI連携 2.ログインとYahoo! ID連携 3.商品系API 4.在庫系API 5.注文系API 6.YJDN-APIまとめ 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 21 YIDログインとSCProのアクセス権限管理 YIDとビジネスIDが１対１に紐付き、ビジネスID単 位に権限管理設定されています アクセス権限 YID ビジネスID YIDログイン Yahoo!ビジネスセンターTOP YIDとビジネスID の紐付け SCPro権限管理設定 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 ビジネスIDに 付与された権限 22 ストア運営をサポートするYJDN-APIの認証フロー １．YIDでログインする YID ２．YID情報がストア運営をサポートするAPI に通知されます Yahoo! ID連携 ３．YIDに紐づくビジネスIDのアクセス権限を チェックし処理結果をレスポンスします YID ビジネスID アクセス権限 テスト環境の場合は、アプリケーション登録時にログイン したYIDと、API利用時にログインしたYIDが同一である必 要があります。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 23 ストア運営をサポートするYJDN-APIの認証イメージ Yahoo! ID連携 1 ServiceProvider Yahoo! JAPAN ID ログイン 2 開発者様 （ユーザ） 3 Yahoo! JAPAN ID ログイン情報を通知 APIリクエスト ストア運営を consumer サポートするAPI 1 Yahoo! JAPAN IDでログインし、認可します。 2 Yahoo! JAPAN IDログイン情報をストア運営をサポートするAPI側に渡します。 （実際には3で一緒にリクエストします） 3 APIをリクエストすると、アクセス権限評価・レスポンス処理をします。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 24 ストア運営をサポートするYJDN-APIのログイン認証 Yahoo! ID連携 ショッピングAPI 1 ログインします 2 ログインできれば 認可コードを発行します 3 redirect urlはユーザのブラ ウザーからアクセス可能な urlになります。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 25 ストア運営をサポートするYJDN-Yahoo! ID連携とAPIリクエスト Yahoo! ID連携 ショッピングAPI 4 認可コードを使って 3Tokenを発行します Access Token Refresh Token ID token(必要時) 5 Access Tokenが 有効期限内なら Access Tokenを使って APIをリクエストします 7 Access Tokenが 有効期限切れなら Refresh Tokenを使って Access Tokenを再取得し 古いAccess Tokenと 置き換えます 8 AccessToken Refresh Tokenが有効期限切れの場合は 最初のログインからやり直します Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 6 アクセス権限を チェックしレスポン スします 26 YID連携が必要なAPIを使う場合の一般的な処理例 ログインするプロセスと、ショッピングAPIをリクエス トするプロセスに分けます。 Yahoo! ID連携 定期的にログイン認証し、 取得したAccessToken、 RefreshToken を保管するプロセス ログインし、認可コードをリクエスト Token を保管 AccessToken Token を利用 AccessToken、 RefreshToken を使ってショッピングAPI をリクエストするプロセス ショッピングAPI Token取得 RefreshToken ショッピングAPIリクエスト RefreshToken AccessToken取得 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 27 認可コードと３tokenについてのまとめ 情報 有効期限 用途 Authorization Code １０分 (認可コード) AccessToken,RefreshToken,IDTokenを 取得するために必要です。 AccessToken ストア運営をサポートするAPIをリクエス トする場合に必要です １時間 RefreshToken ４週間 AccessTokenが期限切れの場合、この Tokenを使ってAccessTokenを再取得しま す IDToken 会員サイトを構築する場合、サイト内で ユーザーセッション管理を行う場合は、ID トークンに含まれる認証情報を元に実施す ることを推奨します。 http://developer.yahoo.co.jp/yconnect /id_token.html ４週間 特徴 一度リクエストした認可 コードは使用できなくなり ます。 再度リクエストする際には Authorizationエンドポイン トで再取得してください ユーザー認証情報を含む改 ざん検知用の署名付きトー クンであり、JWT（JSON Web Token）フォーマット でエンコードされています。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 28 更に詳細な情報 項目 参照先URLなど Yahoo! ID連携の 概要 Yahoo! ID連携とは？ Yahoo! ID連携の 具体的な処理 http://developer.yahoo.co.jp/yconnect/ シーケンス図の詳 細 http://developer.yahoo.co.jp/yconnect/server_app/explicit/#yconnectStep3 IDTokenについて http://developer.yahoo.co.jp/yconnect/id_token.html APIアクセスの実 装 http://developer.yahoo.co.jp/yconnect/api_access.html ID連携の用語集 http://developer.yahoo.co.jp/yconnect/glossary.html 利用制限について 50,000リクエスト／日制限と1YIDが発行できるアプリケーショ ンID数について http://developer.yahoo.co.jp/yconnect/introduction.html 各stepの青い矩形をクリックすると、サンプルコードを参照でき ます。 フォーマット等の詳細情報があります。 Tokenの実装方法等のサンプルコードがあります。 http://developer.yahoo.co.jp/appendix/rate.html Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 29 Authorizationエンドポイント YIDログイン後の認証状態・認可状態を判定し、認可コードを 返します。IDTokenが必要な場合は、response_typeで指定し ます。また、指定のページへリダイレクトさせます。リダイレ クトURLはログインした方のPCからアクセス可能なページにな ります（下図）。 URL： https://auth.login.yahoo.co.jp/yconnect/v1/authorization サポートするHTTPメソッド： GET 詳細仕様 http://developer.yahoo.co.jp/yconnect/server_app/explicit/authorization.html Yahoo! ID連携 ショッピングAPI Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 30 Tokenエンドポイント YJDN-APIにアクセスするのに必要なアクセストークンと、 アクセストークン更新用のリフレッシュトークンを返却します。 また、アクセストークンの更新も行います。 URL： https://auth.login.yahoo.co.jp/yconnect/v1/token サポートするHTTPメソッド： POST 詳細仕様 http://developer.yahoo.co.jp/yconnect/server_app/explicit/token.html Yahoo! ID連携 ショッピングAPI Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 31 1.Yahoo!ショッピングとのAPI連携 2.ログインとYahoo! ID連携 3.商品系API 4.在庫系API 5.注文系API 6.YJDN-APIまとめ 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 32 商品系APIの概要 API区分 機能概要 出品管理に関するAPI アップロード情報（商品・画像・在庫・ストア カテゴリ・カート内関連商品）のデータチェッ クや反映履歴を参照します。 反映予約、商品・在庫・ストアカテゴリのダウ ンロードをします。 商品に関連するAPI 商品登録、商品情報の更新をします。 製品/SHPカテゴリ/ブランド に関連するAPI Yahoo!ショッピングカテゴリ、スペック、製品、 ブランドを参照します。 ※商品情報には必ずカテゴリコードを付加して ください。 ストアカテゴリに関連するAPI ストアカテゴリの登録、編集、削除をします。 ※ストアカテゴリは商品登録時に新規作成する こともできます。 ※ストアカテゴリを削除すると、その配下の商 品もすべて削除されます。 デザインに関連するAPI カスタムページを参照、編集、削除します。反 映前のプレビュー画面のHTMLを参照します。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 33 商品登録業務で利用するAPIー１つの商品を登録する場合 1 商品登録API 2 商品画像アップロードAPI 3 在庫更新API（任意） 4 商品個別反映API 参考：http://developer.yahoo.co.jp/webapi/shopping/itemapiguide.html Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 34 商品登録業務で利用するAPIー複数の商品を登録する場合 1 商品アップロードAPI 2 商品画像一括アップロードAPI 3 在庫アップロードAPI（任意） 4 全反映予約API 参考：http://developer.yahoo.co.jp/webapi/shopping/itemapiguide.html Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 35 商品登録業務で利用するAPIー登録済み商品を更新する場合 商品リストAPIで対象の商品コードを複数特定し、その商品 コードに対して商品一括更新APIにより、特定の項目のみを一 括更新します（更新可能な項目は限定されます）。 1 商品リストAPI 2 商品一括更新API Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 36 商品登録API（editItem）の注意事項 リクエストパラメータ：Path ストアカテゴリのパスを指定します。存在しない場合は自動作 成されます。改行コードで区切ればリンクとなります。 ※CSVファイルについても同様です（API、SCPro） ストアトップ ビール 「リンク」を使うことで 1つの商品を複数のカテゴリに 表示できます ◯◯ビール ◇□ビール ビールとジュースの詰め合わせ 日本酒 ◯◯△如 ◇□田 日本酒とジュースの詰め合わせ path ビール<cr><lf> 詰め合わせ ※さらに改行コードで追加 することも可能。 詰め合わせ ビールとジュースの詰め合わせ 日本酒とジュースの詰め合わせ Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 37 1.Yahoo!ショッピングとのAPI連携 2.ログインとYahoo! ID連携 3.商品系API 4.在庫系API 5.注文系API 6.YJDN-APIまとめ 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 38 在庫系APIの概要 API区分 機能概要 在庫参照API 在庫情報を参照します。 一度に1,000商品コードまで参照可能です。 在庫更新API 在庫情報を更新します。 一度に1,000商品コードまで参照可能です。 在庫アップロードAPI 在庫情報を更新します。 一度に1,000商品コードまで参照可能です。 一度にアップロードできる件数は10万件までです。 在庫情報の更新は、商品情報や画像の更新などにくらべ比較的短時間で処理が終 了します。 参考 http://developer.yahoo.co.jp/webapi/shopping/stock/stockapiguide.html Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 39 商品コードと個別商品コード 色や大きさによる違いがない商品は商品コードだけで在庫数を管理し ます。 商品名：壁掛け時計 商品コード：w10101 色や大きさに違いのある商品は、商品コードと個別商品コード(SubCode)に より在庫数を管理します。 例えば次のような商品は商品コードだけでは在庫数を管理できませんので、色 ごと、サイズごとに在庫数を管理します(SKU)。 商品名：爽やかＴシャツ 商品コード：T-001 （カッコ内は個別商品コード） Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 40 在庫系APIで利用するパラメータ例 CSVファイル例 code sub-code quantity allow_overdraft ⇐時計 w10101 T-001 L-B001 100 ⇐ Lサイズ、青 T-001 M-B001 200 T-001 S-B001 300 ⇐ Mサイズ、青 ⇐ Sイズ、青 在庫更新APIのパラメータ例 seller_id Item_code store1 W10101, T-001:L-B001, T-001:L-B001, T-001:L-B001 quantity allow_overdraft , 100, 200, 300 , , , ⇐ 同上 実際には改行コードは含まれません。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 41 1.Yahoo!ショッピングとのAPI連携 2.ログインとYahoo! ID連携 3.商品系API 4.在庫系API 5.注文系API 6.YJDN-APIまとめ 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 42 注文系APIの概要 区分 API名 機能概要 検索系API 注文ステータス別件数参照API 注文検索API 参照系API 注文詳細API 注文操作履歴一覧API 注文ステータス変更API 入金ステータス変更API 出荷ステータス変更API 更新系API 注文内容変更API 注文分割API 注文ライン追加API 注文分割 配送時期が異なる複数商品が含まれ る注文は、配送時期単位に注文を分 割します。 ライン カートでの商品明細行をラインとい、 商品数追加と区別しています。 コンビニ払、ペイジー等の場合は、 お客様に支払い番号を発行します。 処理系API 支払番号発行API クーポンキャンセルAPI クーポン適用注文は注文内容を変更 できないので、クーポン適用をキャ ンセルしてから変更します。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 43 新規注文、新規予約の注文を取得するAPI 1 注文ステータス別件数参照API 判定条件は NewOrder＞０またはNewReserve＞０ 2 注文検索API 検索条件は 新規予約：IsSeen＝ falseかつOrderStatus＝ 1 新規注文：IsSeen＝ falseかつOrderStatus＝2 3 注文詳細API 2 で取得した全ての注文IDについて、注文情報を 取得します。 4 注文内容変更API 2 で取得した全ての注文IDについて、閲覧済み フラグをtrueにします。 http://developer.yahoo.co.jp/webapi/shopping/ordersapiguide.html Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 44 注文ステータスについて SCProの注文ステータスと注文検索APIや注文詳細APIの注文ス テータスには次の関係があります。 （http://developer.yahoo.co.jp/webapi/shopping/orderStatusChange.html） SCProの Order IsSeen 注文ステータス Status API上での判定基準(検索条件） 新規予約 １ false OrderStatus=“1” and IsSeen=“false” 予約中 １ true OrderStatus=“1” and IsSeen=“true” 新規注文 ２ false OrderStatus=“2” and IsSeen=“false” 処理中 ２ True OrderStatus=“2” and IsSeen=“true” 保留 ３ true OrderStatus=“3” キャンセル ４ true OrderStatus=“4” 完了 ５ true OrderStatus=“5” Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 45 注文ステータス更新時の注意事項 注文ステータスには遷移できるステータスとできな いステータスがあります。 どのステータスに遷移できるかは、下の遷移表を参照してください。 http://developer.yahoo.co.jp/webapi/shopping/orderStatusChange.html 注文ステータスを「完了」にする場合は、必ずポイ ントを確定させてください。 IsPointFix=trueを必ず指定してください。 http://developer.yahoo.co.jp/webapi/shopping/orderStatusChange.htm Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 46 商品代金の入金対象の検索条件について 決済方法毎に、入金ステータス＝「入金済」になる契機や 決済ステータス=「決済完了」になる契機が異なります。 Y!から支払う商品代金が確定した注文情報を検索する場合は、 決済ステータス=「決済完了」を検索条件にしてください。 区分 決済方法 入金済みにな 決済完了にな Y!から支払対 る契機 る契機 象になる契機 クレジット カード支払 注文 直後 コンビニ決済 Yahoo!ショッピ キャリア決済 ングが提供 コンビニsuica ペイジー 出店者様独 自に提供 注文ステータ ス＝完了 お客様による 支払い後数時 同左 間内 全額ポイント 注文 直後 同左 銀行振り込み （例） 入金ステータ ス＝入金済 同左 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 入金サイクル 毎の締め日の 24時で「決済 完了」の注文 Y!からの支払 はない 47 リクエスト回数緩和 １つのアプリケーションIDがリクエストできる回数は、 50,000リクエスト/日 １リクエスト/秒 の制限があります。 ただし、この制限は本番環境に限り緩和できますので 以下から緩和の申請をお願いします。 https://business-yahoo.smartseminar.jp/public /application/add/1256 ※制限緩和を行ったアプリケーションIDは、コール数 制限緩和したAPI以外は利用できなくなるので、利用 しているAPIは全て緩和申請をしてください。 ※テスト環境の制限緩和はできません。 ※APIリクエストは、最大30リクエスト/秒としてく ださい。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 48 注文系APIについての注意事項 ストア運営をサポートするAPIの中でも、特に注文系 APIについては３つの注意事項があります。 利用するには事前に利用申請が必要です。 http://developer.yahoo.co.jp/webapi/shopping/help.html#orderapiapply 次の3APIについては、ログイン有効期限を12時間 としています。 注文検索API,注文詳細API,注文内容変更API http://developer.yahoo.co.jp/webapi/shopping/orderList.html 等 ただし、証明書を利用することでログイン有効期限を 最大4週間に延長できます。 http://developer.yahoo.co.jp/webapi/shopping/help.html#orderapicertificate Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 49 注文系APIのログイン有効期限延長－証明書の発行について 注文検索API,注文詳細API,注文内容変更APIの3APIについて、ログイン有効 期限を12時間から4週間に延長するための証明書は以下の手順で発行申請し ます。 SCProトップページの右下「各種申請リンク」の「API証明書発行申請 フォーム」から申請します。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 50 証明書発行申請後は 発行申請が完了しました。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 51 証明書のダウンロード 発行申請後、5営業日以内にSCProトップ画面から、ツール管 理権限を持つ方のみダウンロードできます。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 52 1.Yahoo!ショッピングとのAPI連携 2.ログインとYahoo! ID連携 3.商品系API 4.在庫系API 5.注文系API 6.YJDN-APIまとめ 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 53 ショッピングのAPIまとめ APIの種類 環境 ショッピング 本番 情報取得API 環境 対象のAPI ショッピングAPI APIを利用す リクエスト数 が設定している るために必要 制限 有効期限 なこと 商品検索API ランキングAPI 設定なし アプリケー 50,000req/d ションID取得 制限解除可能 設定なし アプリケー ションID取得 など 注文系API以外 本番 環境 ストア運営を サポートする API 下の3API以外 設定なし 注文系 注文検索API 12時間 API 注文詳細API 証明書により 注文内容変更API 4週間に延長可 注文系API以外 下の3API以外 50,000req/d アプリケー 制限解除可能 ションID取得 利用申請 設定なし 設定なし テスト アプリケー 50,000req/d 注文検索API 注文系 環境 ションID取得 制限解除不可 注文詳細API 12時間 API 注文内容変更API （証明書非対応） 参考 P.14⇒アプリケーションIDの取得方法、 P.28⇒Tokenの有効期限 P.48⇒リクエスト制限解除の手続き方法 P.49⇒注文系APIの利用申請と証明書発行の手続き方法（P.52まで） P.55⇒本番環境とテスト環境のまとめ（P.57まで） Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 54 本番環境とテスト環境のまとめ 本番環境 Y!Shopping Front Y!Store Front・Cart YJDN-API FTP 出店者様システム Yahoo! Shopping 注文確認メール SCPro テスト環境 Y!Shopping Front Y!Store Front・Cart 出店者様 YJDN-API FTP Yahoo! Shopping 注文確認メール SCPro Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 55 本番環境とテスト環境－SCPro関連機能 項目 本番環境 テスト環境 ***（希望の文字列） snbx-****（固定文字列） 希望のYID、随時追加可能 申請時のYID１つのみ ツールURL https://pro.store.yahoo.co.jp/pro.*** http://test.pro.store.yahoo.co.jp/pro.snbx-**** ストアFront http://store.shopping.yahoo.co.jp/*** http://test.store.shopping.yahoo.co.jp/snbx-**** 注文管理 ◯ ◯ エディター ◯ ◯ ストア構築 ◯ ◯ クーポン ◯ × ◯ × トリプル ◯ × 広告 ◯ × 統計 ◯ ◯ 評価・レビュー ◯ × 利用明細 ◯ × 設定(権限以外) ◯ ◯ 権限管理 ◯ × 申込情報 ◯ × FTPサーバ ◯ × ストアアカウント ログインYID ストアニュースレター Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 56 本番環境とテスト環境－注文・決済系、API系機能 項目 注 文 ・ 決 済 系 API関 連 本番環境 テスト環境 テスト注文 ◯ ◯ クレカ決済(Y!提供）(*1) ◯ ○ Yahoo!マネー/預金払い ◯ ◯ コンビニ決済(Y!提供） ◯ × ペイジー(Y!提供） ◯ × モバイル支払(Y!提供） ◯ × モバイルsuica(Y!提供） ◯ × 代引き等（ストア独自） ◯ ◯ ポイント利用 ◯ × ポイント付与 ◯ × ストアクーポン ◯ × モールクーポン ◯ × いたずら注文 ◯ × YJDN-API(*2) ◯ ◯ リアルタイム受注CGI ◯ ◯ 在庫引当API （リアルタイム在庫API） ◯ ◯ *1：テスト環境でご利用頂けるクレジットカード番号に関しては、P.71「テスト用クレジットカード番号」をご参照。 *2：ストア運営をサポートするAPIについてのみ（ショッピング情報取得APIについては本番環境のみ利用可能）。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 57 1.Yahoo!ショッピングとのAPI連携 2.ログインとYahoo! ID連携 3.商品系API 4.在庫系API 5.注文系API 6.YJDN-APIまとめ 7.間違いやすいAPI 補足資料 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 58 ストアクリエイターPro ■プロフェッショナル出 店した出店者様がストア 構築・運営をするための 管理ツールです。 ■ビジネスID毎に権限 管理されています。 ■YIDをビジネスIDに紐 付けることで、ログイン 認証はYIDのみとなりま す。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 59 商品コードを中心とした情報連携 ■商品系情報 商品情報に商品コードが存在せず、当該 商品コードの画像情報、在庫情報、商品 レビューが存在する場合、SCProの画像 管理、在庫管理、ショッピングフロント から参照することができません（浮き画 像、浮き在庫と呼ばれます）。 ただし、商品情報に商品コードを登録し た時点で、浮き画像、浮き在庫、浮き商 品レビューではなくなり、すぐに参照で きるようになります。 ※画像ファイルは商品コード.拡張子また は商品コード_n.拡張子の形式です。 ■注文情報の商品系情報 注文後に商品情報から商品コードを削除 すると、注文履歴から商品ページへは遷 移できず、「商品情報を表示できませ ん」と表示されます。 商品 商品コード 画像 商品コード 在庫 商品コード 商品 レビュー 商品コード 注文 注文ID 商品コード Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 60 カテゴリに関するAPI－プロダクトカテゴリについて Yahoo!ショッピングでは、約80%以上のお客様が「カテゴリから探す」から商品を 検索しています。 どのカテゴリに商品を配置するかを指定するのが「プロダクトカテゴリ」です。 プロダクトカテゴリは必ず入力するようにしましょう。 Yahoo!ショッピング SCPro ページ編集 お客様がYahoo!ショッピングのカテゴ リリストから商品を探した場合、 「プロダクトカテゴリ」が登録されて いる商品のみが表示されます。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 61 プロダクトカテゴリが大切な理由 プロダクトカテゴリを設定すると、Yahoo!ショッピングFront 配下の各カテゴリに商品が表示されるようになり、取扱高も急 激に向上しますので、必ず商品にはプロダクトカテゴリを設定 しましょう。下のグラフは商品にプロダクトカテゴリを設定す る前後の取扱高グラフを表しています。 プロダクトカテゴリ を設定した日 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 62 在庫処理設定について 在庫初期設定の設定内容は、こ の設定をしてから作成された商 品データについてのみ適用され ます。 設定前に作成されていた商品 データについては適用されませ ん。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 63 モールクーポンとストアクーポンに関するパラメータ 区分 注文情報 注文情報 注文情報 注文情報 注文情報 注文情報 項目名 IsItemCoupon IsShippingCoupon ShippingCouponDiscount ItemCouponDiscount ShipCharge Total TotalPrice 注文情報 注文情報 注文情報 Discount TotalMallCouponDiscount 商品情報 商品情報 商品情報 CouponId CouponDiscount OriginalPrice 商品情報 UnitPrice 商品情報 LineSubTotal 意味 定率・定額クーポン利用フラグ 送料無料クーポン利用フラグ 送料無料クーポン値引額 定額・定率クーポン値引額 送料 ストアクーポン 1：有り、0：無し 1：有り、0：無し 値引額（プラス値） 値引額（プラス値） 送料無料クーポン値引後の 送料 請求金額合計（＝注文金額ー利用ポイ クーポン値引き後の請求金 ント－モールクーポン） 額 クーポン値引き後の注文金 注文金額合計 ※ストアの売上金額合計。（YJが出店者 額 様へ支払う金額で、利用ポイント、モー ルクーポンを含む） 値引き（注文管理画面での値引き額） クーポンとは関係ない値引 き額 モールクーポン値引き金 ブランク 額 （2015/02/04追加） クーポンID クーポンID クーポン利用値引額 クーポンの値引き額 値引き前の単価 クーポン値引き前の単価 クーポン値引き後の単価 商品の販売価格または、特別販売価格 商品（Line）ごとの小計（UnitPrice×数 量） UnitPrice×数量 モールクーポン 0：無し 0：無し 0 ブランク 送料 クーポン値引き後の注文金 額 クーポン値引き前の注文金 額 クーポンとは関係ない値引 き額 クーポン値引き金額（マイナ ス値） ブランク ブランク ブランク 商品単価 （モールクーポンとは無関 係） UnitPrice×数量 UsageId（クーポン利用ID）<>”” かつ ShippingCouponFlg（送料無料クーポン利用有無）=0 の場合は商品対象クーポン となります。 各項目の定義として TotalCouponDiscount（クーポン合計値引き額、プラス値）＝商品対象クーポンの値引き額合計 ShippingCouponDiscount（送料無料クーポン値引き額、プラス値）＝送料無料クーポンの値引き額合計 となりますので、TotalCouponDiscountにはShippingCouponDiscountは含まれません。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 64 出荷可能な注文情報の検索について 決済方法はいろいろありますが、注文後の処理内容は 支払種別により2つに別れます。 出荷可能な注文情報を検索する場合は、 出荷ステータス=「出荷可」を検索条件にしてください。 決済方法 Yahoo!ショッピ ングが提供 出店者様独自 に提供 支払種別 注文後の処理内容 クレジット カード決済 後払い コンビニ決済 キャリア決済 コンビニsuica ペイジー 前払い 後払い すぐに 銀行振り込み （例） 前払い 後払い を確認⇒入金後に すぐに ⇒ を確認 商品代引き （例） 後払い すぐに すぐに ⇒ を確認 を確認⇒入金後に ⇒ ⇒ を確認 を確認 前払いの場合はまず入金をチェックします。入金済になれば自動で出荷可に更新されます。Yahoo!ショッピ ングが提供する決済方法では自動で入金チェックされます。 65 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 お支払種別と各種ステータスの遷移 自動更新 ※クレジットカード決済は後払で「入金済」の状態で注文が発生します。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 66 「調査用リンク」機能でわかること MyBlogや掲示板、Y!ショッピング広告からストア各ページに遷移したお客様のUU、 誘導数、購入率、取扱高等の指標を統計情報として把握できます。 詳細は、ツールマニュアル＞統計情報＞調査用リンクを利用する、をご参照ください。 http://storedoc.ec.yahoo.co.jp/shopping/toolmanual/report/a/1811.html MyBlog UUは？ ストアFront TOPページ ◯◯ 掲示板 誘導数は？ カスタムページ 取扱高は？ Y!Shopping 特集ページ カテゴリページ 商品ページ 購入率は？ Y!Shopping 広告 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 67 完了後の金額変更について 注文ステータスを一度「完了」にしてから一部返品等により金額 変更が発生した場合、「処理中」に戻しても商品の追加や削除は できません。 この場合、「調整額」により注文金額を変更してください。 この場合、返品された商品の価格を減算するだけでなく、これに 相当する付与ポイント分も考慮（加算）してください。 「完了」から「処理中」に戻すと調整額が 入力できるようになります。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 68 商品発送後の注文キャンセルについて 商品発送後、注文キャンセルとなり全品返品されました。ただし、 送料と返品送料は発生しています。この場合、どのようにしたら よいでしょうか。２つ方法があります。 【１】注文キャンセル 注文キャンセルして、送料・返品送料は銀行振り込み等のオフラ インで対応する。 （注文時の支払方法は使えないので不便です） 【２】注文を「完了」にする。 完了後の金額変更機能を使って、かかった経費（送料・返品送料、 付与）だけが合計金額（請求金額）になるように調整額に入力し ます。 （注文時の支払方法が使えるので便利です） Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 69 用語集 名称 意味 アプリケーションID 開発者様のWebサイトやアプリケーションを一意に識別するID 浮き画像 商品情報がない商品画像のこと。 浮き在庫 商品情報がない在庫情報のこと。 SandBox 本番環境から独立した試験（テスト）環境のこと。 注文確認メール お客様の注文情報がYahoo!ショッピングシステムに到着した時 に、お客様に配信される注文内容を記載したメール。配信主体 はYahoo!ショッピング。 ビジネスID Yahoo! JAPANビジネスID。SCPro利用時に発行され、YIDと １対1に紐付けされ、YIDログインが可能。 プロダクトカテゴリ 商品をYahoo!ショッピングFrontのカテゴリと紐付けるコード ストアクリエイター Pro プロフェッショナル出店向けのストア管理ツール。ライト出店 向けストア管理ツールにはストアクリエイターがある。 YID(Y!ID) Yahoo! JAPAN IDのこと YJDN Yahoo! JAPANデベロッパーネットワークの略。 Yahoo! JAPANが持っている情報を参照したり更新したりする ためのWEB-APIを提供するサービス。 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 70 テスト用クレジットカード番号 テスト環境では以下テスト専用のクレジットカード情報をご利用ください。 （※テスト環境では本物のクレジットカード番号を入力しないでください。） （１）通常オーソリOKテスト用のクレジットカード番号 4242424242424242 5105105105105100 5555555555554444 4012888888881881 3530111333300000 3566002020360505 （２）外部システム障害による「決済申込中」テスト用のクレジットカード番号 4111111111111111 テスト環境で上記クレジットカード番号を使用した場合、注文する時間帯によって各決済ス テータスの注文を作ることができます。 ①毎時0分～29分に注文した場合、注文してから１分後「決済申込中」から「支払完了」に自動変更 ②毎時30分～44分に注文した場合、注文してから１0分後「決済申込中」から「オーソリエラー」に自動変更 ③毎時45分～59分に注文した場合、次の毎時0分で「決済申込中」から「支払完了」に自動変更 ※番号以外の項目は任意の値を入れることができます。その際にそれぞれの値に適用される制限は以下の通りです。 ・名義： 半角スペース、英字による任意の文字列(例: TARO YAHOO) ・有効期限： 現在時刻より未来となる年月 ・セキュリティーコード： 4桁の数字 Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 71 お問い合わせ先 不明な点は以下のお問い合わせ窓口に ご相談ください。 http://developer.yahoo.co.jp/developer/contact/ Copyright (C) 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止 72 73 Copyright © 2017 Yahoo Japan Corporation. All Rights Reserved. 無断引用・転載禁止
© Copyright 2024 Paperzz
