access_token は作成日から 14日間 有効です。\n ⚠️ 注意: 初回の14日間の間にトークンが使用されない場合は、有効期限が切れ、再発行が必要となります。
\n", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "api_key": { "description": "APIキー", "type": "string" }, "api_secret": { "description": "APIシークレット", "type": "string" } }, "required": [ "api_key", "api_secret" ] } } }, "required": true }, "responses": { "200": { "description": "非公共のAPIコールにアクセスするためのアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーかAPIシークレットがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/account/{API_KEY}/view_basic": { "post": { "tags": [ "Account" ], "summary": "アカウント詳細を取得する", "operationId": "account_basic", "description": "アカウント詳細を取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "access_token": { "description": "アクセストークン", "type": "string" } }, "required": [ "access_token" ] } } }, "required": true }, "responses": { "200": { "description": "アカウント詳細を表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDetailsResponse" } } } }, "401": { "description": "APIキーかAPIシークレットがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/reviews/{API_KEY}/view": { "get": { "tags": [ "Reviews" ], "summary": "すべてのレビューを取得する", "operationId": "allreview", "description": "すべてのレビューを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "description": "アクセストークン", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "from_id", "description": "指定されたID以降のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customer_id", "description": "顧客IDでレビューを取得（例：12345）。複数指定する場合はcustomersを使用してください。", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customers", "description": "複数の顧客IDでレビューを取得します。配列（customers[]=cust_1&customers[]=cust_2）またはカンマ区切りの文字列（customers=cust_1,cust_2）で指定できます。最大100件まで指定可能です。\ncustomer_idと同時に指定した場合は、いずれかの顧客IDに一致するレビューを返します。\n", "in": "query", "required": false, "schema": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "style": "form", "explode": true, "example": [ "cust_1", "cust_2" ] }, { "name": "from_date", "description": "指定された日付以降のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_date", "description": "ある日付以降に作成または更新されたデータを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "count", "description": "指定された数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "指定されたページ数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "likes", "description": "いいねを取得（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_questions", "description": "カスタム質問を取得（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "question_public", "description": "公開されているカスタム質問のみ取得するかどうか（0/1 デフォルトは1）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "question_enable", "description": "有効にされているカスタム質問のみ取得するかどうか（0/1 デフォルトは1）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "description": "非公開レビューを含む（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "description": "取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "description": "昇順と降順の表示順（指定可能表示順：asc, desc）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars", "description": "指定された評価のみを取得（指定可能評価：1-5）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars_sorting", "description": "評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "post_type", "description": "取得するレビューの種類を指定（指定可能表示順（カンマ切りで複数の指定は可能）：email, import, website, line, inline_form）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "review_type", "description": "レビューの種類（site/product/all デフォルトはall）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID（デフォルトはall）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "group", "description": "グループステータス（true/false デフォルトはfalse）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "group_name", "description": "グループ名（デフォルトは空）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "description": "ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "レビューを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllReviewResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません / customersの指定件数が上限（100件）を超えています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "アクションが存在しません" }, "405": { "description": "商品が存在しません" }, "406": { "description": "レビューが存在しません / customersの形式が不正です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "無効な商品IDが利用されました" }, "408": { "description": "無効なレビューIDが利用されました" }, "409": { "description": "無効な評価が利用されました" }, "410": { "description": "不正アクセス" }, "411": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。" } } } }, "/reviews/{API_KEY}/view_basic": { "get": { "tags": [ "Reviews" ], "summary": "すべてのレビューを取得する", "operationId": "view_basic", "description": "すべてのレビューを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from_id", "description": "指定されたID以降のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_date", "description": "指定された日付以降のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_date", "description": "ある日付以降に作成または更新されたデータを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "count", "description": "指定された数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "指定されたページ数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "likes", "description": "いいねを取得（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "custom_questions", "description": "カスタム質問を取得（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "description": "取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "description": "昇順と降順の表示順（指定可能表示順：asc, desc）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars", "description": "指定された評価のみを取得（指定可能評価：1-5）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars_sorting", "description": "評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "post_type", "description": "取得するレビューの種類を指定（指定可能表示順（カンマ切りで複数の指定は可能）：email, import, website, line, inline_form）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "review_type", "description": "レビューの種類（site/product/all デフォルトはall）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID（デフォルトはall）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "group", "description": "グループステータス（true/false デフォルトはfalse）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "group_name", "description": "グループ名（デフォルトは空）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "description": "ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "レビューを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewOnlyReviewsResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "アクションが存在しません" }, "405": { "description": "商品が存在しません" }, "406": { "description": "レビューが存在しません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "無効な商品IDが利用されました" }, "408": { "description": "無効なレビューIDが利用されました" }, "409": { "description": "無効な評価が利用されました" }, "410": { "description": "不正アクセス" }, "411": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。" } } } }, "/reviews/{API_KEY}/review_with_orders": { "post": { "tags": [ "Reviews" ], "summary": "すべてのレビューとレビューの受注データを取得 ", "operationId": "all-reviews-with-order", "description": "すべてのレビューとレビューの受注データを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewReviewObject" } } }, "description": "レビューフィルターのパラメーターを確認する", "required": true }, "responses": { "200": { "description": "レビューを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllReviewWithOrderResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "アクションが存在しません" }, "405": { "description": "商品が存在しません" }, "406": { "description": "レビューが存在しません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "無効な商品IDが利用されました" }, "408": { "description": "無効なレビューIDが利用されました" }, "409": { "description": "無効な評価が利用されました" } } } }, "/reviews/{API_KEY}/groups_review_summary": { "post": { "tags": [ "Reviews" ], "summary": "グループのレビュー概要を取得", "operationId": "groups-review-summary", "description": "あるフィルター付きのグループのレビュー概要を取得するためのAPIコールです。 \n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupReviewSummaryParam" } } }, "description": "グループのレビュー概要を取得するためのパラメータ", "required": true }, "responses": { "200": { "description": "指定されたレビューを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewSummaryResponse" } } } }, "403": { "description": "グループの制限を超えました。フィルターマージ0では、最大1000グループが許可されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/reviews/{API_KEY}/customers_review_summary": { "post": { "tags": [ "Reviews" ], "summary": "指定された顧客IDのレビュー概要を取得する", "operationId": "customers-review-summary", "description": "フィルターを使用して顧客のレビュー概要を取得するためにAPIを呼び出す \n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerReviewSummaryParam" } } }, "description": "U-KOMIシステムからレビューサマリーを取得するための顧客IDのパラメータ", "required": true }, "responses": { "200": { "description": "顧客のレビューサマリー", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerReviewSummaryResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "顧客IDの上限を超えました。フィルターを0に設定した場合、最大で1000人の顧客まで許可されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/reviews/{API_KEY}/{review_type}/filtered_review_summary": { "post": { "tags": [ "Reviews" ], "summary": "フィルター付きレビュー概要を取得", "operationId": "filtered_review_summary", "description": "あるレビュー概要をフィルター付きで取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "review_type", "description": "レビューの種類（site/product/all） ", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterForReviewSummaryParam" } } }, "description": "フィルター付きのレビュー概要を取得するためのAPIコールです。", "required": true }, "responses": { "200": { "description": "View all review summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewSummaryResponse" } } } }, "406": { "description": "No reviews found." }, "410": { "description": "Review type specified not found." } } } }, "/reviews/{API_KEY}/{review_type}/review_summary": { "get": { "tags": [ "Reviews" ], "summary": "レビュー概要を取得", "operationId": "review_by_review_type", "description": "あるレビュー概要を取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "review_type", "description": "レビューの種類（site/product/all） ", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID（デフォルトはall）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "group", "description": "グループステータス（true/false デフォルトはfalse）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "group_name", "description": "グループ名（デフォルトは空）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ai_summary", "description": "AIによるレビュー要約を含めるかどうか（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "q_n_a_summary", "description": "カスタム質問と回答の要約を含めるかどうか（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "rating_breakdown", "description": "評価内訳を含めるかどうか（0/1 デフォルトは0）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "指定されたレビューを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewSummaryResponse" } } } }, "406": { "description": "レビューがありません。" }, "410": { "description": "指定されたレビュー種類がありません。" } } } }, "/reviews/{API_KEY}/{review_id}/review": { "get": { "tags": [ "Reviews" ], "summary": "指定されたレビューを取得", "operationId": "review_by_id", "description": "指定されたレビューを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "description": "アクセストークン", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "review_id", "description": "レビューID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deleted", "description": "非公開レビューを含む（0/1）。review_images_with_status の各要素は {\"url\": ..., \"deleted\": 0|1} です。deleted=1 では非公開の写真・動画もそこに含まれます。", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "指定されたレビューを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewReviewResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "アクションが存在しません" }, "405": { "description": "無効な商品IDが利用されました" }, "406": { "description": "無効なレビューIDが利用されました" }, "410": { "description": "不正アクセス" }, "411": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。" } } } }, "/reviews/{API_KEY}/{product_id}/product": { "get": { "tags": [ "Reviews" ], "summary": "指定された商品のレビューを取得", "operationId": "product/review", "description": "指定された商品のレビューを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "description": "アクセストークン", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "count", "description": "指定された数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "指定されたページ数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "description": "取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "description": "昇順と降順の表示順（指定可能表示順：asc, desc）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars", "description": "指定された評価のみを取得（指定可能評価：1-5）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars_sorting", "description": "評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customer_id", "description": "顧客IDでレビューを絞り込みます。", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "レビューを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllProductReviewResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "アクションが存在しません" }, "405": { "description": "無効な商品IDが利用されました" }, "406": { "description": "無効なレビューIDが利用されました" }, "407": { "description": "商品IDが間違えています" }, "409": { "description": "無効な評価が利用されました" }, "410": { "description": "不正アクセス" }, "411": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。" } } } }, "/inline_review_form_token/{API_KEY}/get": { "post": { "tags": [ "Reviews" ], "summary": "U-KOMIからインラインフォームトークンを取得する", "operationId": "inline-review-form-token", "description": "注文番号と商品番号を送信してトークンを取得\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineReviewFormTokenRequest" } } }, "description": "トークンを取得するための注文番号と商品番号", "required": true }, "responses": { "200": { "description": "一つ以上のトークンを取得しました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InlineReviewFormTokenResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "受注データがありませんでした", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "無効な受注データが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/products/{API_KEY}/view": { "post": { "tags": [ "Products" ], "summary": "商品を取得", "operationId": "products/retrieve", "description": "データやアクション送信せずにAPIのみコールする", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewProductObject" } } }, "description": "U-KOMIから商品データを取得するための商品パラメータ", "required": true }, "responses": { "200": { "description": "すべての商品を見る", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewProductResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "不正アクセス", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "レコードが見つかりません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "渡されたパラメータ from_date または updated_date が無効である。使用可能なフォーマットはY-m-dです。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/products/{API_KEY}/view_basic": { "post": { "tags": [ "Products" ], "summary": "商品を取得", "operationId": "products/retrieve/basic", "description": "データやアクション送信せずにAPIのみコールする", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewBasicProductObject" } } }, "description": "U-KOMIから商品データを取得するための商品パラメータ", "required": true }, "responses": { "200": { "description": "すべての商品を見る", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewProductBasicResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "不正アクセス", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "レコードが見つかりません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "渡されたパラメータ from_date または updated_date が無効である。使用可能なフォーマットはY-m-dです。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/products/{API_KEY}/product": { "post": { "tags": [ "Products" ], "summary": "商品IDで商品詳細を取得", "operationId": "products/retrieve/single", "description": "単一の product_id またはカンマ区切りの product_id を渡して商品詳細を取得します。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveProductObject" } } }, "description": "商品取得用パラメータ（access_token と product_id）", "required": true }, "responses": { "200": { "description": "商品詳細の取得", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveProductResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "不正アクセス", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "商品IDが指定されていません、または無効な商品ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "リクエスト数が上限に達しました。しばらくしてから再度お試しください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/products/{API_KEY}/create": { "post": { "tags": [ "Products" ], "summary": "商品データを作成する", "operationId": "products/create", "description": "商品データを作成するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProducts" } } }, "description": "U-KOMIに追加する商品データの詳細", "required": true }, "responses": { "200": { "description": "商品を作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "商品データがありませんでした", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "無効な商品データが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/products/{API_KEY}/{product_id}/{group_status}/review_summary": { "get": { "tags": [ "Products" ], "summary": "レビュー概要を取得", "operationId": "review_summary", "description": "ある商品のレビュー概要を取得するためのAPIコールです。こちらのデータをリッチスニペット対応などで利用できます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "in": "path", "description": "商品ID", "required": true, "schema": { "type": "string" } }, { "name": "group_status", "in": "path", "description": "グループに入ってる商品で、そのグループの全商品データを取得したい場合（指定可能の値：true, false）", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "指定された商品のレビュー概要を取得", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewSummaryResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "無効な商品IDが利用されたか商品IDが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/products/{API_KEY}/{product_id}/{review_code}/review_meta": { "get": { "tags": [ "Products" ], "summary": "ogタグのmetadataを取得", "operationId": "review_meta", "description": "ある商品のレビューmetadataを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "in": "path", "description": "商品ID", "required": true, "schema": { "type": "integer" } }, { "name": "review_code", "in": "path", "description": "レビューコード", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ある商品のレビューmetadataを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewMetaResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "無効な商品IDが利用されたか商品IDが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "無効なレビューコードが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/blacklist_products/{API_KEY}/view": { "post": { "tags": [ "Products" ], "summary": "ブラックリスト商品を取得", "operationId": "blacklisted_products/retrieve", "description": "データやアクション送信せずにAPIのみコールする\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewBlacklistProductObject" } } }, "description": "U-KOMIから商品データを取得するための商品パラメータ", "required": true }, "responses": { "200": { "description": "すべてのブラックリスト商品を見る", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewBlacklistProductResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "不正アクセス", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "レコードが見つかりません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "無効な商品IDが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "間違えてるアクションが指定されています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/blacklist_products/{API_KEY}/create": { "post": { "tags": [ "Products" ], "summary": "U-KOMIにブラックリスト商品を追加", "operationId": "blacklisted_products/create", "description": "商品をブラックリスト商品に追加するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBlacklistProducts" } } }, "description": "ブラックリスト商品に追加する商品IDを送信する。", "required": true }, "responses": { "200": { "description": "商品をブラックリスト商品に追加", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBlacklistProductResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "商品データがありませんでした", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "無効な商品データが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/blacklist_products/{API_KEY}/delete": { "post": { "tags": [ "Products" ], "summary": "U-KOMIからブラックリスト商品を削除", "operationId": "blacklisted_products/delete", "description": "商品をブラックリスト商品から削除するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBlacklistProducts" } } }, "description": "ブラックリスト商品から削除する商品IDを送信する。", "required": true }, "responses": { "200": { "description": "商品をブラックリスト商品から削除", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBlacklistProductResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "商品データがありませんでした", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "無効な商品データが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/orders/{API_KEY}/": { "post": { "tags": [ "Orders" ], "summary": "受注データを取得", "operationId": "order/retrieve", "description": "受注データを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewOrderObject" } } }, "description": "受注データを取得するためのパラメータ", "required": true }, "responses": { "200": { "description": "受注データを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewOrderResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/orders/{API_KEY}/create": { "post": { "tags": [ "Orders" ], "summary": "受注データを作成", "operationId": "orders/create", "description": "受注データを作成するためのAPIコールです。\n\nU-KOMIに登録済みの注文はスキップされ、その注文の商品も更新されません。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrder" } } }, "description": "受注データを取得するためのパラメータ", "required": true }, "responses": { "200": { "description": "受注データを作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "受注データがありませんでした", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "無効な受注データが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/orders/{API_KEY}/cancel": { "post": { "tags": [ "Orders" ], "summary": "受注データを取り消す", "operationId": "orders/cancel", "description": "受注データを取り消してレビュー依頼メール送信を止めるためのAPIコールです。\n\t\t\t\t商品IDを指定しない場合は受注データにある全商品データが対象になります。", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOrderObject" } } }, "description": "受注データを取り消すための受注ID・商品IDが含まれたパラメータ", "required": true }, "responses": { "200": { "description": "受注データを取り消す", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOrderResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "受注データがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "無効な受注データが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/groups/{API_KEY}/": { "post": { "tags": [ "Groups" ], "summary": "すべてのグループを取得", "operationId": "retrieve", "description": "すべてのグループを取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllGroupObject" } } }, "description": "グループを取得するためのパラメータ", "required": true }, "responses": { "200": { "description": "すべてのグループを表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllGroupResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "渡されたパラメータ from_date または updated_date が無効である。使用可能なフォーマットはY-m-dです。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/groups/{API_KEY}/create": { "post": { "tags": [ "Groups" ], "summary": "グループを作成", "operationId": "groups/create", "description": "グループを作成するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatGroupObject" } } }, "description": "グループを作成するためのパラメータ", "required": true }, "responses": { "200": { "description": "グループを作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatGroupResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "グループ名がありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "グループ名は既に存在しています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/groups/{API_KEY}/products": { "post": { "tags": [ "Groups" ], "summary": "グループに商品を追加・削除", "operationId": "manage/product", "description": "グループに商品を追加・削除するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductGroupsObject" } } }, "description": "グループに商品を追加・削除するためのパラメータ", "required": true }, "responses": { "200": { "description": "グループに商品を追加・削除", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductGroupsResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "無効なグループ名が利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "グループ名がありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "無効なアクションが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/groups/{API_KEY}/view": { "post": { "tags": [ "Groups" ], "summary": "指定されたグループの詳細を取得", "operationId": "group/view", "description": "指定されたグループの詳細を取得するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewGroupsObject" } } }, "description": "グループ名", "required": true }, "responses": { "200": { "description": "指定されたグループの詳細を表示", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewGroupsResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "無効なグループ名が利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "グループ名がありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "指定されたグループ名に商品がありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/groups/{API_KEY}/delete": { "post": { "tags": [ "Groups" ], "summary": "グループを削除", "operationId": "groups/delete", "description": "グループを削除するためのAPIコールです。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGroupObject" } } }, "description": "グループ名", "required": true }, "responses": { "200": { "description": "グループを削除", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGroupResponse" } } } }, "401": { "description": "無効な・有効期限切れアクセストークン", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "グループ名が利用されませんでした", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "グループ名がありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "グループ名に商品が存在しています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/questions/{API_KEY}": { "get": { "tags": [ "Q&A" ], "summary": "すべてのQ&Aを取得", "operationId": "allquestion", "description": "すべてのQ&Aデータを取得するためのAPIコールです。 \n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "description": "アクセストークン", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "grab_all", "description": "すべての質問を取得します。オプション: 1 / 0。BAZORAを含める: 1 の場合のみ、それ以外は含めない。デフォルトは「0」。", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_date", "description": "指定された日付以降のQ&Aを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_date", "description": "ある日付以降に作成または更新されたデータを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "count", "description": "指定された数のQ&Aを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "指定されたページ数のQ&Aを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "description": "ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "published", "description": "どのQ&Aを取得するか公開・非公開ステータスで取得（0/1/all デフォルトはall）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "すべてのQ&Aを取得して表示させる", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllQuestionResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Q&Aコンテンツがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "間違えてるアクションが指定されています" }, "408": { "description": "アカウントコンフィグで問題があります" }, "410": { "description": "不正アクセス" }, "411": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。" } } } }, "/questions/{API_KEY}/{product_id}": { "get": { "tags": [ "Q&A" ], "summary": "指定された商品のQ&Aを取得", "operationId": "questions", "description": "指定された商品のQ&Aデータを取得するためのAPIコールです。 \n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access_token", "description": "アクセストークン", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "指定された商品のQ&Aを取得して表示させる", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewQuestionResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "商品IDが指定されていません" }, "405": { "description": "商品IDが間違えています" }, "406": { "description": "指定された商品はQ&Aコンテンツがありません" }, "407": { "description": "間違えてるアクションが指定されています" }, "408": { "description": "アカウントコンフィグで問題があります" }, "410": { "description": "不正アクセス" }, "411": { "description": "アカウント設定に問題があります。U-KOMIサポートにお問い合わせください。" } } } }, "/questions/{API_KEY}/{product_id}/count": { "get": { "tags": [ "Q&A" ], "summary": "指定された商品のQ&Aカウントを取得", "operationId": "questions_count", "description": "指定された商品のQ&Aカウントを取得するためのAPIコールです。 \n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "指定された商品のQ&Aカウントを取得", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewQuestionCountResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "商品IDが指定されていません" }, "405": { "description": "商品IDが間違えています" }, "407": { "description": "間違えてるアクションが指定されています" }, "408": { "description": "アカウントコンフィグで問題があります" } } } }, "/reviews/{API_KEY}/{review_id}/review_basic": { "get": { "tags": [ "Reviews" ], "summary": "指定されたレビューを取得（基本）", "operationId": "review_by_id_basic", "description": "指定されたレビューを取得します。基本レスポンスでは、氏名やメールアドレスなどのレビュアー個人情報は含まれません。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "review_id", "description": "レビューID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "選択されたレビュー", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewReviewBasicResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "レビューが見つかりません" }, "408": { "description": "無効なレビューIDが利用されました" } } } }, "/reviews/{API_KEY}/{product_id}/product_basic": { "get": { "tags": [ "Reviews" ], "summary": "指定された商品のレビューを取得（基本）", "operationId": "product_review_basic", "description": "指定された商品のレビューを取得します。基本レスポンスでは、氏名やメールアドレスなどのレビュアー個人情報は含まれません。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "count", "description": "指定された数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "指定されたページ数のレビューを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "description": "取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort_order", "description": "昇順と降順の表示順（指定可能表示順：asc, desc）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars", "description": "指定された評価のみを取得（指定可能評価：1-5）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "stars_sorting", "description": "評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "商品のレビュー", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllProductReviewBasicResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "商品が見つかりません" }, "406": { "description": "レビューが見つかりません" }, "407": { "description": "商品IDが間違えています" }, "409": { "description": "無効な評価が利用されました" } } } }, "/reviews/{API_KEY}/review_with_orders_basic": { "post": { "tags": [ "Reviews" ], "summary": "注文情報付きレビューを取得（基本）", "operationId": "review_with_orders_basic", "description": "注文情報付きのレビューを取得します。基本レスポンスでは、レビュアーおよび購入者の個人情報は含まれません。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewWithOrdersBasicObject" } } }, "description": "取得するレビューの絞り込み条件（任意）" }, "responses": { "200": { "description": "注文情報付きレビュー", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewWithOrdersBasicResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "レビューが見つかりません、または指定された日付が無効です。形式はY-m-dです。" }, "409": { "description": "無効な評価が利用されました" } } } }, "/reviews/{API_KEY}/{review_id}/like": { "post": { "tags": [ "Reviews" ], "summary": "レビューにいいね・低評価", "operationId": "review_like", "description": "レビューにいいねまたは低評価を記録します。低評価は、アカウントで低評価が有効な場合のみ受け付けられます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "review_id", "description": "レビューID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewLikeObject" } } }, "description": "投票内容" }, "responses": { "200": { "description": "レビューのいいね状態（更新後）", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewLikeResponse" } } } }, "400": { "description": "リクエストパラメータが無効です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "このアカウントでは低評価が有効になっていません" }, "404": { "description": "レビューが見つかりません" }, "429": { "description": "リクエストが多すぎます。しばらくしてから再度お試しください。" } } } }, "/reviews/{API_KEY}/{review_id}/likes": { "get": { "tags": [ "Reviews" ], "summary": "レビューのいいね数を取得", "operationId": "review_likes", "description": "レビューのいいね（および低評価）数を取得します。user_identifier を指定すると、そのユーザーの現在の投票も返却されます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "review_id", "description": "レビューID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user_identifier", "description": "現在のユーザーの識別子（任意。そのユーザーの投票を返却）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "レビューのいいね状態", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewLikeResponse" } } } }, "400": { "description": "リクエストパラメータが無効です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "レビューが見つかりません" } } } }, "/reviews/{API_KEY}/likes": { "get": { "tags": [ "Reviews" ], "summary": "複数レビューのいいね数を取得", "operationId": "reviews_likes_batch", "description": "複数のレビューのいいね（および低評価）数をまとめて取得します。review_ids はカンマ区切りで指定します（最大100件）。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "review_ids", "description": "レビューIDをカンマ区切りで指定（最大100件）例：abc123,def456", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user_identifier", "description": "現在のユーザーの識別子（任意。そのユーザーの投票を返却）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "指定されたレビューのいいね状態", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewLikesListResponse" } } } }, "400": { "description": "review_ids がないか無効です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/questions/{API_KEY}/all_questions_basic": { "get": { "tags": [ "Q&A" ], "summary": "すべてのQ&Aを取得（基本）", "operationId": "all_questions_basic", "description": "すべてのQ&Aを取得します。基本レスポンスでは、質問者のメールアドレスは含まれません。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "grab_all", "description": "すべての質問を取得します。コミュニティの質問を含める: 1 の場合のみ。デフォルトは「0」。", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_date", "description": "指定された日付以降のQ&Aを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updated_date", "description": "ある日付以降に作成または更新されたデータを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "count", "description": "指定された数のQ&Aを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "指定されたページ数のQ&Aを取得", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "label", "description": "ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "published", "description": "どのQ&Aを取得するか公開・非公開ステータスで取得（0/1/all デフォルトはall）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "すべてのQ&A", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewAllQuestionBasicResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Q&Aコンテンツがありません、または指定された日付が無効です。形式はY-m-dです。" } } } }, "/questions/{API_KEY}/{product_id}/questions_basic": { "get": { "tags": [ "Q&A" ], "summary": "商品のQ&Aを取得（基本）", "operationId": "product_questions_basic", "description": "指定された商品のQ&Aを取得します。基本レスポンスでは、質問者のメールアドレスは含まれません。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "description": "商品ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "商品のQ&A", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewQuestionBasicResponse" } } } }, "403": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "商品IDが指定されていません" }, "405": { "description": "商品IDが間違えています" }, "406": { "description": "この商品のQ&Aが見つかりません" } } } }, "/questions/{API_KEY}/{question_id}/like": { "post": { "tags": [ "Q&A" ], "summary": "質問にいいね・低評価", "operationId": "question_like", "description": "質問にいいねまたは低評価を記録します。低評価は、アカウントで低評価が有効な場合のみ受け付けられます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "question_id", "description": "質問ID", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionLikeObject" } } }, "description": "投票内容" }, "responses": { "200": { "description": "質問のいいね状態（更新後）", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionLikeResponse" } } } }, "400": { "description": "リクエストパラメータが無効です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "このアカウントでは低評価が有効になっていません" }, "404": { "description": "質問が見つかりません" }, "429": { "description": "リクエストが多すぎます。しばらくしてから再度お試しください。" } } } }, "/questions/{API_KEY}/{question_id}/likes": { "get": { "tags": [ "Q&A" ], "summary": "質問のいいね数を取得", "operationId": "question_likes", "description": "質問のいいね（および低評価）数を取得します。user_identifier を指定すると、そのユーザーの現在の投票も返却されます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "question_id", "description": "質問ID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user_identifier", "description": "現在のユーザーの識別子（任意。そのユーザーの投票を返却）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "質問のいいね状態", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionLikeResponse" } } } }, "400": { "description": "リクエストパラメータが無効です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "質問が見つかりません" } } } }, "/questions/{API_KEY}/likes": { "get": { "tags": [ "Q&A" ], "summary": "複数質問のいいね数を取得", "operationId": "questions_likes_batch", "description": "複数の質問のいいね（および低評価）数をまとめて取得します。question_ids はカンマ区切りで指定します（最大100件）。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "question_ids", "description": "質問IDをカンマ区切りで指定（最大100件）例：q1,q2,q3", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "user_identifier", "description": "現在のユーザーの識別子（任意。そのユーザーの投票を返却）", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "指定された質問のいいね状態", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionLikesListResponse" } } } }, "400": { "description": "question_ids がないか無効です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/{API_KEY}/review_form_fields": { "post": { "tags": [ "Reviews" ], "summary": "レビューフォームの項目を取得", "operationId": "review_form_fields", "description": "商品のレビューフォームを表示するために必要な項目とラベルを取得します。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewFormFieldsObject" } } }, "description": "フォームを作成する商品", "required": true }, "responses": { "200": { "description": "レビューフォームの設定と項目", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewFormFieldsResponse" } } } }, "400": { "description": "APIキーまたは product_id がありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/{API_KEY}/review_submit": { "post": { "tags": [ "Reviews" ], "summary": "レビューを投稿", "operationId": "review_submit", "description": "レビューを投稿します。確認のためのメールが送信されます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewSubmitObject" } } }, "description": "投稿するレビュー", "required": true }, "responses": { "200": { "description": "レビューを受け付けました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewSubmitResponse" } } } }, "400": { "description": "APIキーがありません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "この注文のレビュー投稿は本日すでに受け付けられています" }, "422": { "description": "入力項目に不備があります", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewSubmitFieldErrorResponse" } } } } } } }, "/orders/{API_KEY}/customer_order": { "post": { "tags": [ "Orders" ], "summary": "顧客の注文を取得", "operationId": "customer_order", "description": "顧客の注文と商品、レビュー未投稿の場合はレビュートークンを取得します。customer_id または email で顧客を指定します。両方指定された場合は customer_id が優先されます。\n\n各商品には is_review_submitted、is_cancelled、reviewed_at も返します。\n\n一括モード: customer_ids（最大50件）を指定すると、複数の顧客の注文を1回で取得できます。この場合、レスポンスは orders の代わりに customers になり、limit は顧客ごとに適用され、page は使用しません。\n\norder_ids（最大100件）を指定すると、その顧客の指定した注文のみを返します。この場合、limit と page は無視されます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerOrderObject" } } }, "description": "アクセストークンと検索する顧客", "required": true }, "responses": { "200": { "description": "顧客の注文", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CustomerOrderResponse" }, { "$ref": "#/components/schemas/CustomerOrderBulkResponse" } ] } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "不正アクセス", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "customer_id または email が指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "リクエストボディが正しい JSON ではない、または customer_ids / order_ids が不正です", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/store_badges/{API_KEY}/view": { "get": { "tags": [ "Store Badges" ], "summary": "ストアバッジを取得", "operationId": "store_badges_view", "description": "APIキーを指定して、ストアが公開表示しているバッジを取得します。バッジ名と説明はアカウントに設定された言語で返却され、該当する翻訳がない場合は日本語が返却されます。公開バッジがない場合、data は空配列になります。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ストアバッジ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreBadgesResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "アクションが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "不正アクセス。APIキーが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "アカウントが無効化されています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "アカウント設定に問題があります。U-KOMIサポートまでお問い合わせください", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "アカウントの有効期限が切れています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/faqs/{API_KEY}": { "get": { "tags": [ "FAQ" ], "summary": "公開中のFAQを取得", "operationId": "faqs_view", "description": "アカウントの公開中FAQ（カテゴリ・質問・回答）を返却します。FAQ機能が利用できない場合、または公開中FAQがない場合も200を返却し、data.enabled は false になります。リッチスニペットが有効な場合、snippet にそのまま利用できるFAQPage JSON-LDのscriptタグが含まれます。\n", "parameters": [ { "name": "API_KEY", "description": "APIキー", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lang", "description": "コンテンツの言語（例: ja, en）。FAQ翻訳が有効な場合のみ翻訳を返却。未指定時はアカウントの言語。", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "category", "description": "JSON-LD（snippet）を1カテゴリに限定。custom_id またはタイトルで指定。カテゴリなしは uncategorized。", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "公開中のFAQ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqsResponse" } } } }, "401": { "description": "無効なAPIキーが利用されました", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "不正アクセス。APIキーが指定されていません", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "アカウントが無効化されています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "408": { "description": "アカウント設定に問題があります。U-KOMIサポートまでお問い合わせください", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "410": { "description": "アカウントの有効期限が切れています", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "VisualUgcAlbumsObject": { "type": "object", "required": [ "access_token" ], "properties": { "access_token": { "type": "string", "description": "アクセストークン。Authorization ヘッダーに 'Bearerご注文から2営業日以内に発送いたします。
" } ] } ], "lang": { "search_placeholder": "FAQを検索", "no_results": "該当するFAQがありません。", "all_categories": "すべて", "uncategorized": "その他" } } }, "snippet": { "type": "string", "description": "FAQPage JSON-LDのscriptタグ。リッチスニペット有効時のみ。", "example": "" } } } } } }