質問詳細API

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

リクエストURL

本番環境

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

テスト環境

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

リクエストパラメータ

「Web APIの使い方#GETとは」をご参照ください。

リクエストURL

パラメータ	必須	型	値の例	説明
sellerId	〇	string	teststore	ストアアカウント
topicId	〇	string	xxxxxdfs8sddfbkj46nlsdfsd8h1b3hsd4her	質問のトピックID

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkDetail?
sellerId=teststore&topicId=xxxxxdfs8sddfbkj46nlsdfsd8h1b3hsd4her

サンプルリクエスト

GET https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkDetail?
sellerId=teststore&topicId=xxxxxdfs8sddfbkj46nlsdfsd8h1b3hsd4her HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

要素	フィールド	型	値の例	説明
topic		Object	{	トピックに関する情報
	accessUserType	string	"user" \| "seller"	user：ユーザーがアクセスしている seller：セラーがアクセスしている
	userLastReadTime	string	"1513776685"	ユーザーが当該トピックを最後に閲覧した時間(UNIX時間)
	isUserUnRead	boolean		true：ユーザーが未読のメッセージがある false：ユーザーが未読のメッセージがない
	sellerLastReadTime	string	"1513776685"	セラーが当該トピックを最後に閲覧した時間(UNIX時間)
	isSellerUnRead	boolean		true：セラーが未読のメッセージがある false：セラーが未読のメッセージがない
	isPrivate	boolean		当該トピックが公開か非公開か true：非公開 false：公開
	isComplete	boolean		true：質問がセラーによって完了にされている false：質問がセラーによって完了にされていない
	completeConditionId	int	null \| 1	1：通常完了 2：電話完了 3：メール対応 4：同一質問 5：回答不要
	isMail	boolean		true: システム未連携時の投稿 false :システム連携時の投稿 ※システム連携：出店者様の要望により、メール返信のみとしているトピック新規投稿時に当該フラグを有効にするため、未連携を解除しても当該トピックについては未連携のものとして扱います。
	userMaskedIdx	string	"c28*****"	ユーザーのマスクしたIDX
	itemcode	string	"teststore_Aie3"	商品コード(ストアアカウント_商品コード) ※orderidのレスポンスがある場合はレスポンスされない場合があります。出店者様側でお客様が注文された時点の商品を削除している場合のお問い合わせには含まれません。
	orderid	string	"teststore-10050744"	注文ID(ストアアカウント_注文番号) ※itemcodeのレスポンスがある場合はレスポンスされない
	categoryid	int	1	カテゴリのID
	categoryName	string[]	["商品が届かない","発送通知ありだが届かない"]	質問のカテゴリ名
	title	string	"質問のタイトルが入ります"	質問のタイトル
messages		array＜Object＞	[{	メッセージの投稿順で配列で返します
	messageId	int	1	メッセージID
	postUserType	string	"user" \| "seller"	user：ユーザーが投稿したメッセージ seller：セラーが投稿したメッセージ
	bid	string	"BIDがレスポンスされます"	topic.accessUserTypeがsellerの場合のみ応答されます。
	postdate	string	"1513776685"
	body	string	"メッセージ本文が入ります"	メッセージ本文
	fileList
		fileName	string
		objectKey	string
		fileExt	string
		thumbnailUrl	string
		fileSize	long

サンプルレスポンス

レスポンス（JSON）

{
    "topic" : {
        "accessUserType": "user",
        "userLastReadTime": "1513816685",
        "isUserUnRead": true,
        "sellerLastReadTime": "1513796685",
        "isSellerUnRead": false,
        "isPrivate": false,
        "isComplete": false,
          "isMail": false,
          "userMaskedIdx": "c28*****",
        "itemcode": ":sellerId_a2df",
        "orderid": null,
        "categoryid": 1,
        "title": "質問のタイトルが入ります"
    },
    "messages" : [
        {
            "messageId": 1,
            "postUserType": "user",
            "bid": null,
            "postdate": "1513776685",
            "body": "この商品はいつ入荷されるんですか？"
            "fileList": [
             {
             "fileName": "file00001.png",
             "objectKey": "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde/201809171212121000_SELLER.png",
             "fileExt": "png",
             "thumbnailUrl": "https://,,,/dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde/201809171212121000_SELLER_thumb.png?sign=xxxxxxxxxx",
             "fileSize": 1234
             },
        },
        {
            "messageId": 2,
            "postUserType": "seller",
            "bid": "seller_1",
            "postdate": "1513796685",
            "body": "お問い合わせいただきました件につきまして、¥n入荷予定日ですが2017/11/12ごろを予定しております。"
        },
        {
            "messageId": 3,
            "postUserType": "user",
            "bid": null,
            "postdate": "1513816685",
            "body": "了解です。"
        }
    ]
}

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

Yahoo! ショッピングAPI共通エラーコード一覧

質問詳細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アクセス方法の詳細は、以下のページをご確認ください。

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

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

質問詳細API

リクエストURL

リクエストパラメータ

リクエストURL

サンプルリクエストURL

サンプルリクエスト

レスポンスフィールド

サンプルレスポンス

エラー

ご注意

利用制限

利用約款

利用のルール

開発のヒント

サービス一覧