ショッピング

質問一覧API

お客様から受けたお問い合わせの一覧を取得することができます。

変更履歴（2019年10月10日）

1）リクエストパラメータに以下の項目を追加します。
・filter：フィルター

2）"results" → "result"に変更しました。

リクエストURL

本番環境

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkList

テスト環境

https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkList

テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

リクエストURL

パラメータ	必須	型	値の例	説明
sellerId	〇	string	teststore	ストアアカウント

リクエストパラメータ

「RESTリクエストの構築（GET）」をご参照ください。

パラメータ	必須	型	デフォルト値	値の例	説明
start		int	1	1	トピックの読み込み開始位置
result		int	20	20	返却トピック数（上限は20）
dateType		string	null		表示期間の絞り込み　userPostTime：受付日時　sellerPostTime：返信日時　memoPostTime：メモ更新日時
startDate	△	string	null	"1513076177"	"dateType"が指定されている場合は必須(UNIX時間)
endDate	△	string	null	"1513076177"	"dateType"が指定されている場合は必須(UNIX時間)
qaType		string	null	"order"	質問の絞り込み　"item"：注文前（注文検討中）の質問　"order"：注文後（既に注文済み）の質問　指定なし：両方抽出
isPrivate		boolean	null		true : 非公開質問のみ抽出 false : 公開質問のみ抽出指定なし：両方抽出
category		string	null	2	カテゴリ取得APIのIDをリクエスト子カテゴリがある場合は子カテゴリのID 子カテゴリがある親カテゴリだけの番号では質問できない（別表：「カテゴリ情報」の項に記載のIDを指定してください）
completeConditionId		int	null		完了条件（カンマ区切りで複数指定可能）・1：通常完了・2：電話完了・3：メール対応・4：同一質問・5：回答不要 ※"completeConditionId"は"filter"とOR条件とする。
memoKeyword		string	null		メモの検索クエリ。カンマで区切るとand検索になる。
sort		string	userPostTime		ソートする際のキー　userPostTime：受付日時　sellerPostTime：返信日時
sortOrder		string	desc		asc：昇順（古いものから順） desc：降順（新しいものから順）
authType		string	seller		アクセスしたビジネスIDの種別・seller ・cs ・emp
filter		string	"answered,unanswered,completed"	"answered" "unanswered" "completed"	フィルターカンマ区切りで複数指定可能指定しない場合全てを含めます。セラー未回答 : unanswered セラー回答済み : answered 完了 : completed

必須△："dateType"が指定されている場合は必須

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkList? 　　　　　　　　　　　　　　sellerId=xxxx&start=1&result=20 サンプルリクエスト GET https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkList? 　　　　　　　　　　　　　　sellerId=xxxx&start=1&result=20 HTTP/1.1 Host: circus.shopping.yahooapis.jp Authorization: Bearer <アクセストークン>

レスポンスフィールド

要素	フィールド	型	値の例	説明
summary		Object	{	サマリ情報の情報群
summary.filter		int	"all"	絞り込みの状態　all：全て　unanswered：未回答　answered:：回答済み
mmary.unansweredCount		int	3	未回答件数
summary.topic		Object	{	トピックのサマリに関する情報
summary.topic.start		int	1	レスポンスしたトピックのstart位置
summary.topoc.end		int	20	レスポンスしたトピックのend位置
summary.topic.count		int	2243	レスポンスしたトピックの全ての件数
headlines		Array<Object>	[}
	topicId	string		SHA256したトピックID （質問詳細にリクエストする際のURLとする）
	isUnread	boolean		未読あり（既読していない）　true：未読あり　false：未読なし
	isNoAnswer	boolean		返信状況　true：未返信　false：返信済み
	isCompleted	boolean		質問が完了状態であるか　true：完了済み　false：未完了
	userPostTime	string	"1513076177"	受付日時（最新のユーザー投稿日時）UNIX時間
	sellerPostTime	string \| null	"1513776685"	返信日時（最新のセラー投稿日時）UNIX時間
	qaType	string		注文種別　order：注文後（既に注文済み）の質問　item：注文前（注文検討中）の質問
	isPrivate	boolean		true：非公開の質問 false：商品詳細に公開されている質問
	category	int	2	カテゴリ取得APIのID
	title	string	"タイトルが入ります"	タイトル
	body	string	"メッセージ本文が入ります"	メッセージ本文
	messageCount	int	10	投稿されているメッセージの総件数
	userMaskedId	string	"JidfkgId"	商品Q&A内のシステムで、ハッシュ化したユーザID 商品Q&A独自のID体系（同一ユーザの判別ができる程度）
	itemCode	string \| null	:sellerId:_aAa	商品コード（SellerId_商品コード）
	orderId	string \| null	:sellerId:_10000000	注文された商品のID：qaTypeがorderの時に応答それ以外は空（SellerId_注文番号）

カテゴリ情報

※投稿時に選択可能か：質問投稿時に親カテゴリ子カテゴリの関係となっており、子カテゴリを選択しないと投稿できないため、トピックのレスポンスには当該カテゴリIDは基本的に含まれません、

カテゴリID	質問種別	カテゴリ名	投稿時に選択可能
1	注文前（注文検討中）の質問	商品の質問	○
2	注文前（注文検討中）の質問	お届け日・発送日について	○
3	注文前（注文検討中）の質問	在庫状態・再入荷予定	○
4	注文前（注文検討中）の質問	送料について	○
5	注文前（注文検討中）の質問	その他ストアへの連絡事項	○
6	注文後（既に注文済み）の質問	お届け日	×
7	注文後（既に注文済み）の質問	お届け日（発送日の確認）	○
8	注文後（既に注文済み）の質問	お届け日（到着日の確認）	○
9	注文後（既に注文済み）の質問	注文キャンセル	○
10	注文後（既に注文済み）の質問	注文・決済内容の変更	×
11	注文後（既に注文済み）の質問	注文・決済内容の変更（お届け先の変更）	○
12	注文後（既に注文済み）の質問	注文・決済内容の変更（注文内容の変更）	○
13	注文後（既に注文済み）の質問	注文・決済内容の変更（決済方法の変更）	○
14	注文後（既に注文済み）の質問	商品が届かない	×
15	注文後（既に注文済み）の質問	商品が届かない（発送通知ありだが届かない）	○
16	注文後（既に注文済み）の質問	商品が届かない（到着予定日に届かない）	○
17	注文後（既に注文済み）の質問	商品が届かない（その他）	○
18	注文後（既に注文済み）の質問	商品の質問	○
19	注文後（既に注文済み）の質問	連絡がない	×
20	注文後（既に注文済み）の質問	連絡がない（発送連絡がない）	○
21	注文後（既に注文済み）の質問	連絡がない（その他）	○
22	注文後（既に注文済み）の質問	領収書	○
23	注文後（既に注文済み）の質問	支払い方法の質問	○
24	注文後（既に注文済み）の質問	返品および返金について	○
25	注文後（既に注文済み）の質問	ギフトについて	○
26	注文後（既に注文済み）の質問	お届け日（その他）	○
27	注文後（既に注文済み）の質問	注文・決済内容の変更（その他）	○
28	注文後（既に注文済み）の質問	その他ストアへの連絡事項	○

サンプルレスポンス

レスポンス（JSON）

{
  "summary": {
    "filter": "all",
    "unansweredCount": 10,
    "topic" : {
        "start" : 1,
        "end"   : 20,
        "count" : 100
    }
  },
  "headlines" : [
    {
        "topicId" : "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde",
        "isUnread" : true,
        "isNoAnswer": true,
　　　　　　　　"isCompleted": false,
        "firstPostTime": "1513076177",
        "updateTime": "1513776685",
        "qaType": "item",
        "isPrivate" :true,
        "category": 2,
        "title": "おすすめ商品でよく出てきますが・・",
        "body": "この商品はいつになったら買えるようになるんですか？¥n詳細を教えてください。",
        "messageCount": 10,
        "userMaskedId" : "jUDidkaE",
        "itemCode" : "test-store_2147483647",
        "orderId": null

    },
    {
        "topicId" : "e510844686b22b11bb579c0ee09828cbce7302f045968320d419769697327c18",
        "isUnread" : true,
        "isNoAnswer": true,
　　　　　　　　"isCompleted": false,
        "firstPostTime": "1513076177",
        "updateTime": "1513776685",
        "qaType": "item",
        "isPrivate" :false,
        "category": 1,
        "title": "対応機種について",
        "body": "この商品は機種xxxxに対応していますか？",
        "messageCount": 8,
        "userMaskedId" : "8eIdgIqq",
        "itemCode" : "test-store_050",
        "orderId": null
    },
    {
        "topicId" : "42bc351b04925b8dd3448c4a6570b1183897701e00e724956e106b864af77890",
        "isUnread" : false,
        "isNoAnswer": false,
　　　　　　　　"isCompleted": true,
        "firstPostTime": "1513076177",
        "updateTime": "1513779842",
        "qaType": "order",
        "userMaskedId" : "iOdie31",
        "isPrivate" :true,
        "category": 11,
        "title": "住所変更を希望します。",
        "body": "12/19に注文させていただきました、矢風と言います。¥n注文先の変更をさせてください。¥n¥n変更前： 〒107-6211 東京都港区赤坂9-7-1 ミッドタウン・タワー¥n¥n変更後〒102-8282: 東京都千代田区紀尾井町1-3: 東京ガーデンテラス紀尾井町 紀尾井タワー¥n¥n宜しくお願いします。",
        "messageCount": 2,
        "userMaskedId" : "8eIdgIqq",
        "itemCode" : null,
        "orderId": "test-store-10015077"
    }
  ]
}

エラー

質問一覧APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

HTTPステータスコード	説明
400	Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。
401	Unauthorized. 認証に失敗した場合に返されます。
404	Not found. 存在しないリソースにアクセスされた場合に返されます。
500	Internal Server Error. サーバー側で異常が発生した場合に返されます。
503	Service unavailable. 内部的な問題によってデータを返すことができない場合に返されます。

各エラーにおいて、次の形式のJSONレスポンスを返します。

フィールド	説明
error.reason	エラー事由が記載されます。

{
     error : {
        reason: "Bad Request"
     }
}

ご注意

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
・Yahoo! ID連携
・Yahoo! ID連携によるAPIアクセス実装方法

※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。（無料）
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。

利用約款

このAPIに関する利用約款はこちら。

質問一覧API

リクエストURL

リクエストパラメータ

レスポンスフィールド

カテゴリ情報

サンプルレスポンス

エラー

ご注意

利用制限

利用約款

はじめよう

目次

開発のヒント

プラットフォーム

開発ツール

Web APIとその他サービス