Yahoo!オークション用セラー新規問い合わせ投稿API

Yahoo!オークションで落札されたお客様に対して出店者様から問い合わせを投稿できます。

変更履歴

2024年5月1日

カテゴリID一覧に「カテゴリID：60」を追加しました。

2023年10月30日

サービス名称変更に伴い下記文言を修正しました。
ヤフオク!、ヤフオク　→　Yahoo!オークション

2022年8月5日

未注文落札一覧取得APIの仕様が一部変更になりました。
詳しくはファイル内更新履歴をご確認ください。

2022年8月5日

・下記パラメータの「説明」の内容を修正しました。
　・orderId
　・aucId
　・preOrderId
・ページが下部に注意文言を追記しました。
　「※注文前に新規問い合わせ投稿する場合のご注意」をご確認ください。

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalAucStoreTopic

リクエストパラメータ

リクエストURL

パラメータ 必須 型 値の例 説明
（なし）

リクエストボディ

パラメータ 必須 型 値の例 説明
sellerId 〇 string "teststore" 投稿するストアのセラーID（ストアアカウント）
categoryId 〇 int 46 投稿する質問のカテゴリー
（別表：「カテゴリID一覧」の項に記載のIDを指定してください）
orderId string "teststore-10174841" 注文ID
Yahoo!オークションの注文前、注文後切り替え用orderIdがあったら送信
orderIdがない場合は、preOrderIdとaucIdが必須
aucId 〇 string "123456789" オークションID
orderId指定時はaucIdの指定は不可
preOrderId 〇 string "6cff62cb-b7db-4647-a51e-72aa57fdb31a" 未注文落札一覧取得APIから取得されるpre_order配下の該当落札商品のid
orderId指定時はpreOrderIdの指定は不可
title 〇 string "ストアからの連絡事項です" 質問のタイトル
body 〇 string "メッセージ本文が入ります" 質問の本文

レスポンスフィールド

要素 型 値の例 説明
topicId string "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde" 生成したトピックID

サンプルレスポンス

レスポンス（JSON）

{
  "topicid": "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde",
}

カテゴリID一覧

※「投稿時に選択可能」項目について
質問投稿時には親カテゴリ、子カテゴリ双方の選択が必須のため、「✕」となっているカテゴリ（子カテゴリ選択が必須なカテゴリ）IDは指定できません。
カテゴリID カテゴリ名 対象サービス 投稿時に選択可能
45お支払いYahoo!オークション✕
46お支払い（支払い方法の連絡）Yahoo!オークション〇
47お支払い（未入金の連絡）Yahoo!オークション〇
48お支払い（その他）Yahoo!オークション〇
49発送Yahoo!オークション✕
50発送（発送先の確認）Yahoo!オークション〇
51発送（発送日時の連絡）Yahoo!オークション〇
52発送（再発送の連絡）Yahoo!オークション〇
53発送（その他）Yahoo!オークション〇
54注文内容Yahoo!オークション✕
55注文内容（注文内容の確認）Yahoo!オークション〇
56注文内容（注文キャンセルの連絡）Yahoo!オークション〇
57注文内容（その他）Yahoo!オークション〇
58領収書Yahoo!オークション〇
59その他Yahoo!オークション〇
60Yahoo!オークションストアへの問い合わせYahoo!オークション〇

エラー

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

Yahoo!オークション用セラー新規問い合わせ投稿APIで固有に返すエラーコードは以下をご覧ください。

HTTPステータスコード 説明
400 Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。
401 Unauthorized. 新規投稿へのアクセス権がない場合
ipaddress : 不正アドレスアクセスで認証失敗
user : ユーザー認証失敗
404 Not found. 存在しないリソースにアクセスされた場合に返されます。
409 Conflict. リクエストしたOrderIdのTopicIdがすでに存在する場合
500 Internal Server Error. サーバー側で異常が発生した場合
503 Service unavailable. 内部的な問題によってデータを返すことができない場合に返されます。

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

フィールド 説明
error.reason エラー事由が記載されます。 
{
     error : {
        reason: "Bad Request"
     }
}

ご注意

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

※注文前に新規問い合わせ投稿する場合のご注意
競り商品を複数個出品し落札者が複数いる、かつ注文前に「Yahoo!オークション用セラー新規問い合わせ投稿API」で新規問い合わせ投稿をする場合、落札者を特定した投稿ができませんのでご注意ください。

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

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント