openapi: 3.0.0 info: description: | U-KOMI　APIドキュメント ## レート制限 IPアドレスごとに秒間1リクエストを超えるリクエストは制限される場合があります。制限された場合は `429 Too Many Requests` が返却されます。 version: 1.0.1 title: U-KOMI API contact: email: info@u-komi.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html tags: - name: Authentication description: API認証 - name: Account description: アカウント基本情報の取得 - name: Reviews description: レビュー取得 - name: Products description: 商品データを取得・作成・編集 - name: Orders description: 受注データを取得・作成・編集 - name: Groups description: 商品グループを取得・作成・編集・削除 - name: Q&A description: 指定された商品のQ&Aを取得 - name: Visual Curation description: ビジュアルUGC（Instagram・X(Twitter)・TikTok・YouTube・レビュー写真・管理者アップロード）をアルバム／アルバムメディア／ギャラリー単位で取得 - name: Store Badges description: ストアが公開表示しているバッジを取得 - name: FAQ description: 公開中のFAQをJSONで取得（静的HTMLでの表示などに利用） paths: "/visual_ugc/{API_KEY}/albums": post: tags: - Visual Curation summary: アルバム一覧の取得 operationId: visualUgcAlbums description: > アカウントのビジュアルキュレーション・アルバムを一覧取得します。結果は認証されたアカウントにスコープされます。アクセストークンは Authorization ヘッダーに Bearer 形式で送信することもできます。 parameters: - name: API_KEY description: ベンダーから提供される API KEY in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/VisualUgcAlbumsObject" description: アクセストークンおよび任意のフィルター／ページネーション required: true responses: "200": description: アルバム一覧 content: application/json: schema: $ref: "#/components/schemas/VisualUgcAlbumsResponse" "401": description: 無効な API キー content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "410": description: 認証エラー（アクセストークンが未指定／無効） content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "/visual_ugc/{API_KEY}/albums/{album_id}/media": post: tags: - Visual Curation summary: アルバム内メディアの取得 operationId: visualUgcAlbumMedia description: > アルバム内のすべてのメディア（Instagram・X(Twitter)・TikTok・YouTube・レビュー写真・管理者アップロード）を統一フォーマットで取得します。カーソルベースのページネーションに対応し、結果は認証されたアカウントにスコープされます。アクセストークンは Authorization ヘッダーに Bearer 形式で送信することもできます。 parameters: - name: API_KEY description: ベンダーから提供される API KEY in: path required: true schema: type: string - name: album_id description: エンコードされた album_id（albums エンドポイントが返す値） in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/VisualUgcAlbumMediaObject" description: アクセストークンおよび任意のフィルター／ソート／ページネーション required: true responses: "200": description: アルバム内メディア一覧 content: application/json: schema: $ref: "#/components/schemas/VisualUgcAlbumMediaResponse" "401": description: 無効な API キー content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "404": description: アルバムが見つかりません content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "410": description: 認証エラー（アクセストークンが未指定／無効） content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "/visual_ugc/{API_KEY}/galleries": post: tags: - Visual Curation summary: ギャラリー一覧の取得 operationId: visualUgcGalleries description: > ギャラリーと紐づくアルバムを一覧取得します。結果は認証されたアカウントにスコープされます。アクセストークンは Authorization ヘッダーに Bearer 形式で送信することもできます。 parameters: - name: API_KEY description: ベンダーから提供される API KEY in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/VisualUgcGalleriesObject" description: アクセストークンおよび任意のページネーション required: true responses: "200": description: ギャラリー一覧 content: application/json: schema: $ref: "#/components/schemas/VisualUgcGalleriesResponse" "401": description: 無効な API キー content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "410": description: 認証エラー（アクセストークンが未指定／無効） content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" /auth/access_token: post: tags: - Authentication summary: アクセストークンの取得 operationId: access_token description: > アクセストークンはアカウント認証のために利用するものです。権限を持ってるユーザーのみがアクセスできるように非公共のAPIコールで利用されています。

アクセストークンの有効期限ポリシー

⚠️ 注意: 初回の14日間の間にトークンが使用されない場合は、有効期限が切れ、再発行が必要となります。

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コールです。 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コールです。 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件まで指定可能です。 customer_idと同時に指定した場合は、いずれかの顧客IDに一致するレビューを返します。 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コールです。 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コールです。 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コールです。 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を呼び出す 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コールです。 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コールです。 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コールです。 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コールです。 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: | 注文番号と商品番号を送信してトークンを取得 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 を渡して商品詳細を取得します。 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コールです。 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コールです。こちらのデータをリッチスニペット対応などで利用できます。 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コールです。 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のみコールする 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コールです。 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コールです。 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コールです。 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コールです。 U-KOMIに登録済みの注文はスキップされ、その注文の商品も更新されません。 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コールです。 商品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コールです。 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コールです。 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コールです。 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コールです。 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コールです。 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コールです。 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コールです。 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コールです。 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: | 指定されたレビューを取得します。基本レスポンスでは、氏名やメールアドレスなどのレビュアー個人情報は含まれません。 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: | 指定された商品のレビューを取得します。基本レスポンスでは、氏名やメールアドレスなどのレビュアー個人情報は含まれません。 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: | 注文情報付きのレビューを取得します。基本レスポンスでは、レビュアーおよび購入者の個人情報は含まれません。 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: | レビューにいいねまたは低評価を記録します。低評価は、アカウントで低評価が有効な場合のみ受け付けられます。 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 を指定すると、そのユーザーの現在の投票も返却されます。 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件）。 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を取得します。基本レスポンスでは、質問者のメールアドレスは含まれません。 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を取得します。基本レスポンスでは、質問者のメールアドレスは含まれません。 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: | 質問にいいねまたは低評価を記録します。低評価は、アカウントで低評価が有効な場合のみ受け付けられます。 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 を指定すると、そのユーザーの現在の投票も返却されます。 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件）。 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: | 商品のレビューフォームを表示するために必要な項目とラベルを取得します。 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: | レビューを投稿します。確認のためのメールが送信されます。 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 が優先されます。 各商品には is_review_submitted、is_cancelled、reviewed_at も返します。 一括モード: customer_ids（最大50件）を指定すると、複数の顧客の注文を1回で取得できます。この場合、レスポンスは orders の代わりに customers になり、limit は顧客ごとに適用され、page は使用しません。 order_ids（最大100件）を指定すると、その顧客の指定した注文のみを返します。この場合、limit と page は無視されます。 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 は空配列になります。 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タグが含まれます。 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" servers: - url: https://api.u-komi.com components: schemas: VisualUgcAlbumsObject: type: object required: - access_token properties: access_token: type: string description: アクセストークン。Authorization ヘッダーに 'Bearer ' として送信することもできます。 example: YOUR_ACCESS_TOKEN album_type: type: string description: "アルバム種別で絞り込み: custom / product / official / user。省略するとすべて。" example: "" count: type: integer description: 1ページあたりの件数。既定 10、最大 100。 example: 10 page: type: integer description: ページ番号。既定 1。 example: 1 from_date: type: string description: created_at で絞り込み（>=）。 example: "" updated_date: type: string description: updated_at で絞り込み（>=）。 example: "" VisualUgcAlbumMediaObject: type: object required: - access_token properties: access_token: type: string description: アクセストークン。Authorization ヘッダーに 'Bearer ' として送信することもできます。 example: YOUR_ACCESS_TOKEN source: type: string description: "ソースで絞り込み: instagram / review_picture / upload / tiktok / twitter / youtube。省略するとすべて。" example: "" rights_status: type: string description: "権利ステータスで絞り込み: approved / pending / rejected。省略するとすべて。" example: "" sort: type: string description: "ソートキー: date / likes。既定は date。" example: date sort_order: type: string description: "ソート方向: asc / desc。既定は desc。" example: desc cursor: type: string description: 次ページ取得用のカーソル（前回レスポンスの next_cursor）。初回は省略。 example: "" count: type: integer description: 1ページあたりの件数。既定 10、最大 100。 example: 10 VisualUgcGalleriesObject: type: object required: - access_token properties: access_token: type: string description: アクセストークン。Authorization ヘッダーに 'Bearer ' として送信することもできます。 example: YOUR_ACCESS_TOKEN count: type: integer description: 1ページあたりの件数。既定 10、最大 100。 example: 10 page: type: integer description: ページ番号。既定 1。 example: 1 VisualUgcAlbumsResponse: type: object properties: status: type: string example: success code: type: integer example: 200 message: type: string example: OK data: type: object properties: albums: type: array items: type: object properties: album_id: type: string album_name: type: string album_type: type: string product_id: type: string item_count: type: integer created_at: type: string updated_at: type: string pagination: type: object properties: page: type: integer count: type: integer total: type: integer total_pages: type: integer example: albums: - album_id: oM8rZyZMUD05WNvE album_name: Summer Campaign album_type: custom product_id: null item_count: 34 created_at: 2024-06-01 10:00:00 updated_at: 2024-08-15 12:00:00 pagination: page: 1 count: 10 total: 122 total_pages: 13 VisualUgcAlbumMediaResponse: type: object properties: status: type: string example: success code: type: integer example: 200 message: type: string example: OK data: type: object properties: media: type: array items: type: object properties: media_id: type: string source: type: string image_url: type: string thumbnail_url: type: string video_url: type: string caption: type: string posted_by: type: string posted_at: type: string custom_text: type: string likes: type: integer product_tags: type: array description: このメディアが全アルバムでタグ付けされている全商品。product_id は店舗/管理画面の商品ID。 items: type: object properties: product_id: type: string product_name: type: string rights_status: type: string created_at: type: string pagination: type: object properties: count: type: integer has_more: type: boolean next_cursor: type: string example: media: - media_id: knpAVlkUrIJ0ZRao source: instagram image_url: https://cdn.u-komi.com/... thumbnail_url: https://cdn.u-komi.com/.../thumb video_url: null caption: 投稿キャプション posted_by: "@username" posted_at: 2024-07-10 12:00:00 custom_text: null likes: 314 product_tags: - product_id: leather-wallet product_name: Leather Wallet - product_id: gift-box product_name: Gift Box rights_status: approved created_at: 2024-07-10 13:00:00 pagination: count: 10 has_more: true next_cursor: eyJzdiI6Li4ufQ== VisualUgcGalleriesResponse: type: object properties: status: type: string example: success code: type: integer example: 200 message: type: string example: OK data: type: object properties: galleries: type: array items: type: object properties: gallery_id: type: string gallery_title: type: string album_id: type: string album_type: type: string item_count: type: integer pagination: type: object properties: page: type: integer count: type: integer total: type: integer total_pages: type: integer example: galleries: - gallery_id: Kk8d95l6U1lDNAol gallery_title: Top Page Gallery album_id: OPX79w2xUpyaQ8q3 album_type: custom item_count: 12 pagination: page: 1 count: 10 total: 72 total_pages: 8 AuthenticationResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 access_token: type: string example: 200 AccountDetailsResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 data: type: object properties: name: type: string url: type: string framework: type: string example: name: account1 url: www.account1.com framework: test ErrorResponse: type: object properties: status: type: string example: error code: type: integer example: 401 message: type: string example: エラーメッセージ ViewAllProductReviewResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string name: type: string customer_id: type: string email: type: string nickname: type: string reviewer_type: type: string post_type: type: string review_images: type: array items: {} product_sku: type: string product_name: type: string product_url: type: string example: - id: "12345" title: レビュータイトル content: レビュー詳細 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 name: お名前 customer_id: cust email: customer@email.com nickname: ニックネーム reviewer_type: verified_buyer post_type: email review_images: - image/path/1 - image/path/2 product_sku: "10" product_name: 商品名 product_url: www.productwebsite.com/product-url - id: "12346" title: レビュータイトル 1 content: レビュー詳細 1 score: "5" created_at: 2018-06-13 15:31:34 updated_at: 2018-06-13 15:31:34 sentiment: 良い name: お名前 1 customer_id: cust_1 email: customer1@email.com nickname: ニックネーム reviewer_type: "" post_type: import review_images: - image/path/1 product_sku: "11" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 - id: "12347" title: レビュータイトル 2 content: レビュー詳細 2 score: "3" created_at: 2018-06-11 15:31:34 updated_at: 2018-06-11 15:31:34 sentiment: 判定不可 name: お名前 2 customer_id: cust_2 email: customer2@email.com nickname: ニックネーム reviewer_type: "" post_type: email review_images: - image/path/1 - image/path/2 - image/path/3 product_sku: "11" product_name: 商品名 2 product_url: www.productwebsite.com/product-url2 - id: "12348" title: レビュータイトル 3 content: レビュー詳細 3 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 name: お名前 3 customer_id: cust_3 email: customer2@email.com nickname: ニックネーム reviewer_type: verified_buyer post_type: website review_images: - image/path/1 - image/path/2 product_sku: "10" product_name: 商品名 3 product_url: www.productwebsite.com/product-url3 ViewAllReviewResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer label: type: string created_at: type: string format: date updated_at: type: string format: date sentiment: type: string order_id: type: string name: type: string customer_id: type: string email: type: string nickname: type: string reviewer_type: type: string post_type: type: string review_images: type: array items: {} is_pickup: type: integer deleted: type: integer likes: type: integer question_answer: type: array items: type: object properties: id: type: string question: type: string answer: type: string enable: type: integer public: type: integer product_sku: type: string product_name: type: string product_url: type: string example: - id: "12345" title: レビュータイトル content: レビュー詳細 score: "4" label: label,label 1,label 2 created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 order_id: "1234" name: お名前 customer_id: cust email: customer@email.com nickname: ニックネーム reviewer_type: verified_buyer post_type: email review_images: - image/path/1 - image/path/2 question_answer: - id: "1" question: Question 1 answer: Answer 1 - id: "2" question: Question 2 answer: Answer 2 - id: "3" question: Question 3 answer: Answer 3 - id: "4" question: Question 4 answer: Answer 4 - id: "5" question: Question 5 answer: "Answer " product_sku: "10" product_name: 商品名 product_url: www.productwebsite.com/product-url - id: "12346" title: レビュータイトル 1 content: レビュー詳細 1 score: "5" label: label,label 1,label 2 created_at: 2018-06-13 15:31:34 updated_at: 2018-06-13 15:31:34 sentiment: 良い name: お名前 1 customer_id: cust_1 email: customer1@email.com nickname: ニックネーム reviewer_type: "" post_type: import review_images: - image/path/1 question_answer: - id: "1" question: Question 1 answer: Answer 1 - id: "2" question: Question 2 answer: Answer 2 product_sku: "11" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 - id: "12347" title: レビュータイトル 2 content: レビュー詳細 2 score: "3" label: label,label 1,label 2 created_at: 2018-06-11 15:31:34 updated_at: 2018-06-11 15:31:34 sentiment: 判定不可 name: お名前 2 customer_id: cust_2 email: customer2@email.com nickname: ニックネーム reviewer_type: "" review_images: - image/path/1 - image/path/2 - image/path/3 question_answer: - id: "1" question: Question 1 answer: Answer 1 - id: "2" question: Question 2 answer: Answer 2 - id: "3" question: Question 3 answer: Answer 3 post_type: email product_sku: "11" product_name: 商品名 2 product_url: www.productwebsite.com/product-url2 - id: "12348" title: レビュータイトル 3 content: レビュー詳細 3 score: "4" label: label,label 1,label 2 created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 name: お名前 3 customer_id: cust_3 email: customer2@email.com nickname: ニックネーム reviewer_type: verified_buyer review_images: - image/path/1 - image/path/2 question_answer: - id: "1" question: Question 1 answer: Answer 1 - id: "2" question: Question 2 answer: Answer 2 - id: "3" question: Question 3 answer: Answer 3 - id: "4" question: Question 4 answer: Answer 4 post_type: website product_sku: "10" product_name: 商品名 3 product_url: www.productwebsite.com/product-url3 ViewOnlyReviewsResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer label: type: string created_at: type: string format: date updated_at: type: string format: date sentiment: type: string nickname: type: string reviewer_type: type: string post_type: type: string review_images: type: array items: {} is_pickup: type: integer likes: type: integer question_answer: type: array items: type: object properties: id: type: string question: type: string answer: type: string enable: type: integer public: type: integer product_sku: type: string product_name: type: string product_url: type: string example: - id: "12345" title: レビュータイトル content: レビュー詳細 score: "4" label: label,label 1,label 2 created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 nickname: ニックネーム reviewer_type: verified_buyer post_type: email review_images: - image/path/1 - image/path/2 question_answer: - id: "1" question: Question 1 answer: Answer 1 - id: "2" question: Question 2 answer: Answer 2 - id: "3" question: Question 3 answer: Answer 3 - id: "4" question: Question 4 answer: Answer 4 - id: "5" question: Question 5 answer: "Answer " product_sku: "10" product_name: 商品名 product_url: www.productwebsite.com/product-url - id: "12346" title: レビュータイトル 1 content: レビュー詳細 1 score: "5" label: label,label 1,label 2 created_at: 2018-06-13 15:31:34 updated_at: 2018-06-13 15:31:34 sentiment: 良い nickname: ニックネーム reviewer_type: "" post_type: import review_images: - image/path/1 question_answer: - id: "1" question: Question 1 answer: Answer 1 product_sku: "11" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 - id: "12347" title: レビュータイトル 2 content: レビュー詳細 2 score: "3" label: label,label 1,label 2 created_at: 2018-06-11 15:31:34 updated_at: 2018-06-11 15:31:34 sentiment: 判定不可 nickname: ニックネーム reviewer_type: "" review_images: - image/path/1 - image/path/2 - image/path/3 question_answer: - id: "1" question: Question 1 answer: Answer 1 - id: "2" question: Question 2 answer: Answer 2 post_type: email product_sku: "11" product_name: 商品名 2 product_url: www.productwebsite.com/product-url2 - id: "12348" title: レビュータイトル 3 content: レビュー詳細 3 score: "4" label: label,label 1,label 2 created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 nickname: ニックネーム reviewer_type: verified_buyer review_images: - image/path/1 - image/path/2 question_answer: - id: "1" question: Question 1 answer: Answer 1 - id: "2" question: Question 2 answer: Answer 2 post_type: website product_sku: "10" product_name: 商品名 3 product_url: www.productwebsite.com/product-url3 ViewReviewResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string name: type: string email: type: string nickname: type: string review_images: type: array items: {} reviewer_type: type: string product_sku: type: string product_name: type: string product_url: type: string example: - id: "12345" title: レビュータイトル content: レビュー詳細 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 name: お名前 email: customer@email.com review_images: - image/path/1 - image/path/2 - image/path/3 nickname: ニックネーム reviewer_type: verified_buyer product_sku: "10" product_name: 商品名 product_url: www.productwebsite.com/product-url ReviewSummaryResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 data: type: object properties: total_reviews: type: integer example: 10 average_ratings: type: number example: 4.5 ai_summary: type: object q_n_a_summary: type: object rating_breakdown: type: object example: "1": 2 "2": 1 "3": 0 "4": 3 "5": 4 CustomerReviewSummaryResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 data: type: array items: type: object properties: customer_id: type: string description: 顧客ID。 example: customer_id1 total_reviews: type: integer example: 10 average_ratings: type: number example: 4.5 review_ids: type: string description: レビューユニークコードのカンマ区切りリスト example: abc123,def456 review_product_ids: type: string description: 商品IDのカンマ区切りリスト example: prod_1,prod_2 review_first_date: type: string description: 最初のレビュー日（Y-m-d形式） example: 2024-01-15 review_last_date: type: string description: 最後のレビュー日（Y-m-d形式） example: 2025-02-10 cursor: type: string description: 次のページ用のカーソル。次のページがない場合はnullになります。filter.mergeが'0'でcustomersが指定されていない場合のみ返されます。 example: cursor_value count: type: integer description: 1ページあたりのレコード数 example: 100 ReviewMetaResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 review_meta: type: string example: ViewProductResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: products: type: array items: type: object properties: id: type: string name: type: string product_url: type: string image_url: type: string description: type: string short_description: type: string price: type: integer review_email_priority: type: number review_request_email_delay: type: number minimum: 0 description: An unsigned number (non-negative) expiration_date: type: string format: date tag: type: string created_at: type: string format: date updated_at: type: string format: date group: type: string is_published: type: integer description: 1 = 公開、0 = 非公開 sku: type: string condition: type: string availability: type: string reviews: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string name: type: string customer_id: type: string email: type: string post_type: type: string review_images: type: array items: {} nickname: type: string reviewer_type: type: string brand: type: string upc: type: string mpn: type: string isbn: type: string ean: type: string gtin: type: string example: - id: product_id name: product name product_url: www.productwebsite.com/product-url image_url: image/path/1 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "2" review_request_email_delay: 20 expiration_date: 2024-11-03 tag: Product_tag crated_at: 2023-05-03 updated_at: 2023-05-04 group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock reviews: - id: "12345" title: レビュータイトル content: 説明の確認 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: Clearly Positive name: 商品名 customer_id: CustomerId email: customer@email.com post_type: email review_images: - image/path/1 - image/path/2 nickname: ニックネーム reviewer_type: verified_buyer - id: "12346" title: レビュータイトル 1 content: 説明の確認 1 score: "5" created_at: 2018-06-13 15:31:34 updated_at: 2018-06-13 15:31:34 sentiment: Positive name: 商品名 1 customer_id: CustomerId1 email: customer1@email.com post_type: email review_images: - image/path/1 nickname: ニックネーム 1 reviewer_type: "" brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin - id: product_id_1 name: product name 2 product_url: www.productwebsite.com/product-url1 image_url: image/path/2 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "1" review_request_email_delay: 10 expiration_date: 2024-11-03 crated_at: 2023-05-03 updated_at: 2023-05-04 tag: Product_tag group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin - id: product_id_2 name: product name 2 product_url: www.productwebsite.com/product-url2 image_url: image/path/2 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "0" review_request_email_delay: 5 expiration_date: 2024-11-03 crated_at: 2023-05-03 updated_at: 2023-05-04 tag: Product_tag group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock reviews: - id: "12345" title: レビュータイトル content: 説明の確認 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: Clearly Positive name: 商品名 customer_id: CustomerId email: customer@email.com post_type: email review_images: - image/path/1 - image/path/2 nickname: ニックネーム reviewer_type: verified_buyer brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin - id: product_id_3 name: product name 3 product_url: www.productwebsite.com/product-url3 image_url: image/path/3 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "-1" review_request_email_delay: 0 expiration_date: 2024-11-03 crated_at: 2023-05-03 updated_at: 2023-05-04 tag: Product_tag group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin ViewProductBasicResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: products: type: array items: type: object properties: id: type: string name: type: string product_url: type: string image_url: type: string description: type: string short_description: type: string price: type: integer review_email_priority: type: number review_request_email_delay: type: number minimum: 0 description: An unsigned number (non-negative) expiration_date: type: string format: date tag: type: string created_at: type: string format: date updated_at: type: string format: date group: type: string is_published: type: integer description: 1 = 公開、0 = 非公開 sku: type: string condition: type: string availability: type: string reviews: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string post_type: type: string review_images: type: array items: {} nickname: type: string reviewer_type: type: string brand: type: string upc: type: string mpn: type: string isbn: type: string ean: type: string gtin: type: string example: - id: product_id name: product name product_url: www.productwebsite.com/product-url image_url: image/path/1 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "2" review_request_email_delay: 20 expiration_date: 2024-11-03 tag: Product_tag created_at: 2023-11-03 updated_at: 2023-11-03 group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock reviews: - id: "12345" title: レビュータイトル content: 説明の確認 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: Clearly Positive post_type: email review_images: - image/path/1 - image/path/2 nickname: ニックネーム reviewer_type: verified_buyer - id: "12346" title: レビュータイトル 1 content: 説明の確認 1 score: "5" created_at: 2018-06-13 15:31:34 updated_at: 2018-06-13 15:31:34 sentiment: Positive post_type: email review_images: - image/path/1 nickname: ニックネーム 1 reviewer_type: "" brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin - id: product_id_1 name: product name 2 product_url: www.productwebsite.com/product-url1 image_url: image/path/2 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "1" review_request_email_delay: 10 expiration_date: 2024-11-03 tag: Product_tag created_at: 2023-11-03 updated_at: 2023-11-03 group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin - id: product_id_2 name: product name 2 product_url: www.productwebsite.com/product-url2 image_url: image/path/2 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "0" review_request_email_delay: 5 expiration_date: 2024-11-03 tag: Product_tag created_at: 2023-11-03 updated_at: 2023-11-03 group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock reviews: - id: "12345" title: レビュータイトル content: 説明の確認 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-13 15:31:34 sentiment: Clearly Positive post_type: email review_images: - image/path/1 - image/path/2 nickname: ニックネーム reviewer_type: verified_buyer brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin - id: product_id_3 name: product name 3 product_url: www.productwebsite.com/product-url3 image_url: image/path/3 description: 商品説明 short_description: 簡潔な商品説明 price: "123" review_email_priority: "-1" review_request_email_delay: 0 expiration_date: 2024-11-03 tag: Product_tag created_at: 2023-11-03 updated_at: 2023-11-03 group: group1 is_published: 1 sku: product_sku condition: "" availability: In Stock brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin RetrieveProductResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: products: type: array items: type: object properties: id: type: string name: type: string product_url: type: string image_url: type: string description: type: string short_description: type: string price: type: string review_email_priority: type: number review_request_email_delay: type: number minimum: 0 description: 0以上の数値 expiration_date: type: string format: date tag: type: string created_at: type: string format: date updated_at: type: string format: date group: type: string blacklisted: type: integer description: 0 = ブラックリスト未登録、1 = ブラックリスト登録済 is_published: type: integer description: 1 = 公開、0 = 非公開 sku: type: string condition: type: string availability: type: string brand: type: string upc: type: string mpn: type: string isbn: type: string ean: type: string gtin: type: string example: - id: product_id name: product name product_url: www.productwebsite.com/product-url image_url: image/path/1 description: Product description short_description: Product short description price: "55000.00" review_email_priority: "2" review_request_email_delay: 20 expiration_date: 2024-11-03 tag: Product_tag created_at: 2023-05-03 updated_at: 2023-05-04 group: group1 blacklisted: 0 is_published: 1 sku: product_sku condition: "" availability: in_stock brand: Product brand upc: Product upc mpn: Product mpn isbn: Product isbn ean: Product ean gtin: Product gtin CreateProducts: type: object required: - access_token - products properties: access_token: type: string example: access_token products: type: object description: product_id is ID of the product in store properties: product_id: $ref: "#/components/schemas/OneProductObject" CreateProductResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 errors: type: array items: type: object properties: message: type: string InlineReviewFormTokenRequest: type: object required: - access_token - orders properties: access_token: type: string example: access_token orders: type: array items: $ref: "#/components/schemas/InlineReviewFormTokenRequestOrderObject" InlineReviewFormTokenRequestOrderObject: type: object required: - order_id - product_id properties: order_id: type: string example: "12345" product_id: type: string example: "12345" InlineReviewFormTokenResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 orders: type: array items: $ref: "#/components/schemas/InlineReviewFormTokenResponseOrderObject" InlineReviewFormTokenResponseOrderObject: type: object properties: order_id: type: string example: "12345" product_id: type: string example: "12345" verification_token: type: string example: review_verification_token CreateOrder: type: object required: - access_token - orders properties: access_token: type: string example: access_token orders: type: array items: $ref: "#/components/schemas/CreateOrderObject" ViewReviewObject: type: object required: - access_token properties: access_token: type: string example: access_token reviews: type: object description: Review search parameters properties: from_id: type: string example: 指定されたID以降のレビューを取得 from_date: example: 指定された日付以降のレビューを取得 type: string updated_date: example: Get review updated/created after selected date Eg.2017-11-03 type: string count: example: 指定された数のレビューを取得 type: string page: example: 指定されたページ数のレビューを取得 type: string deleted: example: 非公開レビューを含む type: string sort: example: レビューの表示順（指定可能表示順：date/stars/like/sentiment/buyer/picture/response デフォルトはdate） type: string sort_order: example: 昇順と降順の表示順（指定可能表示順：asc, desc） type: string stars: example: 指定された評価のみを取得（指定可能評価：1-5） type: string stars_sorting: example: 評価の表示順（指定可能表示順：great/less/equal デフォルトはequal） type: string FilterForReviewSummaryParam: type: object properties: filter: type: array example: expiration: expired/not_expired items: {} GroupReviewSummaryParam: type: object required: - groups properties: groups: type: array example: - group1 - group2 items: {} filter: type: array example: expiration: expired/not_expired merge: 0/1 empty: 0/1 items: {} CustomerReviewSummaryParam: type: object properties: access_token: type: string description: 任意項目。filter.mergeが"0"で全顧客を取得する場合は必須です。 example: access_token customers: oneOf: - type: array items: type: string - type: string description: 顧客IDの配列またはカンマ区切りの文字列。指定しない場合は全顧客を返します。 example: - customer_id1 - customer_id2 filter: type: object description: フィルターオプション example: merge: 0/1 empty: 0/1 updated_date: type: string example: 2024-01-15 cursor: type: string description: ページネーション用のカーソル。次のページを取得するには、前回のレスポンスのcursor値を使用してください。filter.mergeが'0'でcustomersが指定されていない場合のみ有効です。 example: cursor_value count: type: integer description: 1ページあたりのレコード数。デフォルトは10、最大は1000です。 example: 10 ViewAllReviewWithOrderResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string name: type: string email: type: string nickname: type: string reviewer_type: type: string post_type: type: string review_images: type: array items: {} order: type: object properties: id: type: string user_name: type: string user_email: type: string user_nickname: type: string product_sku: type: integer product_name: type: string product_url: type: string order_date: type: string coupon_code: type: string example: - id: "12345" title: レビュータイトル content: 説明の確認 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: Clearly Positive name: 商品名 email: customer@email.com nickname: ニックネーム reviewer_type: verified_buyer post_type: email review_images: - image/path/1 - image/path/2 order: id: "12345" user_name: 商品名 user_email: customer@email.com user_nickname: ニックネーム product_sku: "10" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 order_date: 2017-11-03 coupon_code: u-komi-write-review - id: "12346" title: レビュータイトル 1 content: 説明の確認 1 score: "5" created_at: 2018-06-13 15:31:34 updated_at: 2018-06-13 15:31:34 sentiment: Positive name: 商品名 1 email: customer1@email.com nickname: ニックネーム 1 reviewer_type: "" post_type: email review_images: - image/path/1 order: id: "123456" user_name: 商品名 user_email: customer@email.com user_nickname: ニックネーム product_sku: "10" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 order_date: 2017-11-03 coupon_code: u-komi-upload-photo - id: "12347" title: レビュータイトル 2 content: 説明の確認 2 score: "3" created_at: 2018-06-11 15:31:34 updated_at: 2018-06-11 15:31:34 sentiment: Mixed name: 商品名 2 email: customer2@email.com nickname: ニックネーム 2 reviewer_type: "" post_type: email review_images: - image/path/1 - image/path/2 - image/path/3 order: id: "1234567" user_name: 商品名 user_email: customer@email.com user_nickname: ニックネーム product_sku: "10" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 order_date: 2017-11-03 coupon_code: u-komi-share-review - id: "12348" title: レビュータイトル 3 content: 説明の確認 3 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: Clearly Positive name: 商品名 3 email: customer3@email.com nickname: ニックネーム 3 reviewer_type: verified_buyer post_type: website review_images: - image/path/1 - image/path/2 order: id: "12345678" user_name: 商品名 user_email: customer@email.com user_nickname: ニックネーム product_sku: "10" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 order_date: 2017-11-03 coupon_code: u-komi-write-review CreateOrderObject: type: object required: - customer_email - customer_name - order_id - products properties: customer_email: type: string format: email example: customer@email.com customer_name: type: string example: お名前 customer_id: type: string example: Customer_id line_id: type: string example: Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx customer_nickname: type: string example: お名前 order_id: type: string example: "12345" order_date: type: string format: date example: 2017-11-03 currency_iso: type: string example: JPY description: 通過ISOコード coupon_code: type: string example: coupon_code email_lang: type: string description: レビュー依頼メールの送信言語（指定可能言語：ja/en/zh/zh-tw/zh-cn/ko/fr/th/de） enum: - ja - en - zh - zh-tw - zh-cn - ko - fr - th - de example: ja products: type: object description: 商品ID properties: product_id: $ref: "#/components/schemas/OneProductObject" ViewProductObject: type: object required: - access_token properties: access_token: type: string example: access_token product: type: object description: 商品検索パラメータ properties: group: type: string example: group_name tag: type: string example: tag name from_date: type: string example: 2017-11-03 updated_date: type: string example: 2017-11-03 has_reviews: type: integer example: レビューがある商品のフィルタリング（0/1 デフォルトは0） review_updated_date: type: string example: 2017-11-03 review: type: integer example: レビューデータを含む（0/1 デフォルトは0） review_count: type: integer example: 商品ごとのレビュー件数（1以上 デフォルトは10） review_sort: type: string example: レビューの表示順（指定可能表示順：date/stars/like/sentiment/buyer/picture/response デフォルトはdate） review_sort_order: type: string example: 表示順（指定可能表示順：asc/desc デフォルトはdesc） count: type: integer example: "10" page: type: integer example: "1" ViewBasicProductObject: type: object required: - access_token properties: access_token: type: string example: access_token product: type: object description: 商品検索パラメータ properties: group: type: string example: group_name tag: type: string example: tag name from_date: type: string example: 2017-11-03 updated_date: type: string example: 2017-11-03 has_reviews: type: integer example: レビューがある商品のフィルタリング（0/1 デフォルトは0） review_updated_date: type: string example: 2017-11-03 review: type: integer example: レビューデータを含む（0/1 デフォルトは0） review_count: type: integer example: 商品ごとのレビュー件数（1以上 デフォルトは10） review_sort: type: string example: レビューの表示順（指定可能表示順：date/stars/like/sentiment/buyer/picture/response デフォルトはdate） review_sort_order: type: string example: 表示順（指定可能表示順：asc/desc デフォルトはdesc） count: type: integer example: "10" page: type: integer example: "1" RetrieveProductObject: type: object required: - access_token - product_id properties: access_token: type: string example: access_token product_id: type: string description: 単一の product_id またはカンマ区切りの product_id example: P001,P002,P003 ViewOrderObject: type: object required: - access_token properties: access_token: type: string example: access_token orders: type: object description: Order search parameters properties: from_id: type: string example: "12345" from_date: type: string format: date example: 2017-11-03 count: type: integer example: "10" page: type: integer example: "4" retrieve_reviews: type: integer example: "1" order_id: type: string example: order_id sort_order: type: string example: new/old — デフォルトは new です cursor_date: type: string example: 2017-11-03 cursor_source: type: integer example: 1 cursor_id: type: integer example: 12345 ViewBlacklistProductObject: type: object required: - access_token properties: access_token: type: string example: access_token product: type: object description: Product search parameters properties: count: type: integer example: "10" page: type: integer example: "1" ViewBlacklistProductResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: products: type: array items: type: string example: - - product_id_1 - product_id_2 - product_id_3 - product_id_4 - product_id_5 CreateBlacklistProducts: type: object required: - access_token - product_id properties: access_token: type: string example: access_token product_id: type: array items: type: string example: - productid1 - productid2 - productid3 - productid4 - productid5 description: product_id is ID of the product in store CreateBlacklistProductResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 ViewOrderResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: order: type: array items: type: object properties: id: type: string customer_id: type: string line_id: type: string user_name: type: string user_email: type: string user_nickname: type: string product_sku: type: integer product_name: type: string product_url: type: string product_image: type: string product_description: type: string order_date: type: string coupon_code: type: string review: type: object example: - id: "1" customer_id: Customer_id line_id: Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx user_name: お名前 user_email: customer@email.com user_nickname: ニックネーム product_sku: "10" product_name: 商品名 product_url: www.productwebsite.com/product-url product_image: www.productwebsite.com/product-image-url product_description: 商品詳細テキスト order_date: 2017-11-03 coupon_code: u-komi-write-review review: id: abtocde title: レビュータイトル content: コンテンツを確認する score: "5.00" sentiment: Mixed published: "1" created_at: 2017-12-13 09:30:07 updated_at: 2017-12-13 09:30:07 - id: "2" customer_id: Customer_id line_id: Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx user_name: お名前 user_email: customer@email.com user_nickname: ニックネーム product_sku: "11" product_name: 商品名 1 product_url: www.productwebsite.com/product-url1 product_image: www.productwebsite.com/product-image-url1 product_description: 商品詳細テキスト order_date: 2017-11-03 coupon_code: u-komi-upload-photo review: [] - id: "3" customer_id: Customer_id line_id: Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx user_name: お名前 user_email: customer@email.com user_nickname: ニックネーム product_sku: "12" product_name: 商品名 2 product_url: www.productwebsite.com/product-url2 product_image: www.productwebsite.com/product-image-url2 product_description: 商品詳細テキスト order_date: 2017-11-03 coupon_code: u-komi-share-review review: [] - id: "4" customer_id: Customer_id line_id: Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx user_name: お名前 user_email: customer@email.com user_nickname: ニックネーム product_sku: "13" product_name: 商品名 3 product_url: www.productwebsite.com/product-url3 product_image: www.productwebsite.com/product-image-url3 product_description: 商品詳細テキスト order_date: 2017-11-03 coupon_code: u-komi-write-review review: [] total_order: type: integer example: 4 total_purchase: type: number example: 400 cursor: type: object properties: cursor_date: type: string cursor_source: type: integer cursor_id: type: integer OneProductObject: type: object required: - url - name properties: url: type: string format: uri example: http://www.yoursite.com/product_url.html name: type: string example: 商品名 image: type: string format: uri example: http://www.yoursite.com/image_path/image_name.jpg description: type: string example: 商品詳細テキスト short_description: type: string example: 簡潔な商品説明テキスト group_name: type: string example: グループ名 price: type: number example: "123" review_email_priority: type: number example: 2/1/0/-1/-2 review_request_email_delay: type: number minimum: 0 example: 10 expiration_date: type: string format: date example: 2021-04-03 coupon_code: type: string example: coupon_code specs: type: object additionalProperties: type: string tag: type: string example: Tag product_tags: type: string example: Tag1,Tag2 created_at: type: string format: date example: 2017-11-03 updated_at: type: string format: date example: 2017-11-03 is_published: type: integer enum: - 0 - 1 example: 1 description: 1 = 公開、0 = 非公開（U-KOMIのレビューポータルサイトに表示されません）。省略した場合、既存の商品は変更されず、新しい商品は1になります。 CreateOrderResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 CancelOrderObject: type: object required: - access_token - orders properties: access_token: type: string example: access_token orders: type: array items: type: object required: - order_id properties: order_id: type: string product_ids: type: array items: type: string example: - order_id: "12345" product_ids: - product_id1 - product_id2 - order_id: "12346" CancelOrderResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 CreatGroupObject: type: object required: - access_token - group_name properties: access_token: type: string example: access_token group_name: type: string example: グループ名 CreatGroupResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 ViewAllGroupObject: type: object properties: access_token: type: string example: access_token group: type: object description: Group search parameters properties: from_date: type: string format: date example: 2017-11-03 updated_date: type: string format: date example: 2017-11-03 ViewAllGroupResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 groups: type: array items: type: string example: - group 3 - group 2 - group 1 DeleteGroupObject: type: object required: - access_token - group_name properties: access_token: type: string example: access_token group_name: type: string example: グループ名 DeleteGroupResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 ProductGroupsObject: type: object required: - access_token - group_name - product_action - product_id properties: access_token: type: string example: access_token group_name: type: string example: グループ名 product_action: type: string enum: - add - remove example: add product_id: type: string example: 101,102,103 ProductGroupsResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 ViewGroupsObject: type: object required: - group_name properties: access_token: type: string example: access_token group_name: type: string example: グループ名 ViewGroupsResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: groups: type: object required: - name properties: name: type: string example: グループ名 products: type: array items: type: object properties: sku: type: string example: "12345" name: type: string example: 商品名 url: type: string example: www.productwebsite.com/product-url ViewAllQuestionResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: total_questions: type: string total_unaswer_count: type: string questions: type: array items: type: object properties: id: type: string product_id: type: string question: type: string questioner: type: object properties: name: type: string customer_id: type: string email: type: string time: type: string answer: type: string answerer: type: object properties: avtar: type: string email: type: string time: type: string bazora: type: string label: type: string published: type: string example: total_questions: "367" total_unaswer_count: "39" questions: - id: zaSxasQ product_id: "12345" question: is it applicable on curly hair? questioner: name: Customer Name custome_id: null email: customer@email.com time: 2018-06-12 15:31:34 answer: Yes, It is suitable for all types of hair. answerer: name: Customer Name avtar: http://www.server.com/image_path time: 2018-06-12 15:31:34 bazora: "1" label: label,label 1,label 2 published: "1" - id: DeJdEe3 product_id: "12345" question: is it availble in blue color? questioner: name: Customer1 Name custome_id: Customer1 email: customer1@email.com time: 2019-07-12 15:31:34 answer: It is avaible in 5 more color. answerer: name: Store Admin avtar: http://www.server.com/image_path time: 2019-10-12 15:31:34 bazora: "0" label: label,label 1,label 2 published: "0" - id: "12347" product_id: "12345" question: Is this only for men?! questioner: name: Customer2 Name custome_id: customer2 email: customer2@email.com time: 2020-05-10 15:31:34 answer: Yes answerer: name: Store Admin avtar: http://www.server.com/image_path time: 2020-06-12 15:31:34 bazora: "1" label: label,label 1,label 2 published: "1" ViewQuestionResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: questions: type: array items: type: object properties: id: type: string question: type: string questioner: type: object properties: name: type: string email: type: string time: type: string answer: type: integer answerer: type: object properties: avtar: type: string email: type: string time: type: string label: type: string example: questions: - id: zaSxasQ question: is it applicable on curly hair? questioner: name: Customer Name email: customer@email.com time: 2018-06-12 15:31:34 answer: Yes, It is suitable for all types of hair. answerer: name: Customer Name avtar: http://www.server.com/image_path time: 2018-06-12 15:31:34 label: label,label 1,label 2 - id: DeJdEe3 question: is it availble in blue color? questioner: name: Customer1 Name email: customer1@email.com time: 2019-07-12 15:31:34 answer: It is avaible in 5 more color. answerer: name: Store Admin avtar: http://www.server.com/image_path time: 2019-10-12 15:31:34 label: label,label 1,label 2 - id: "12347" question: Is this only for men?! questioner: name: Customer2 Name email: customer2@email.com time: 2020-05-10 15:31:34 answer: Yes answerer: name: Store Admin avtar: http://www.server.com/image_path time: 2020-06-12 15:31:34 label: label,label 1,label 2 ViewQuestionCountResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: count: type: integer example: 450 ViewReviewBasicResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string nickname: type: string review_images: type: array items: {} reviewer_type: type: string product_sku: type: string product_name: type: string product_url: type: string example: - id: "12345" title: レビュータイトル content: レビュー詳細 score: "4" created_at: 2018-06-12 15:31:34 updated_at: 2018-06-12 15:31:34 sentiment: 最高 nickname: ニックネーム review_images: - image/path/1 - image/path/2 reviewer_type: verified_buyer product_sku: "10" product_name: 商品名 product_url: www.productwebsite.com/product-url ViewAllProductReviewBasicResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string nickname: type: string review_images: type: array items: {} reviewer_type: type: string product_sku: type: string product_name: type: string product_url: type: string ReviewWithOrdersBasicObject: type: object properties: reviews: type: object properties: count: type: integer example: 10 page: type: integer example: 1 from_id: type: string example: abc123 from_date: type: string example: 2025-01-01 updated_date: type: string example: 2025-01-01 stars: type: integer example: 5 stars_sorting: type: string example: greater sort: type: string example: date sort_order: type: string example: desc deleted: type: string example: no ReviewWithOrdersBasicResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: review: type: array items: type: object properties: id: type: string title: type: string content: type: string score: type: integer created_at: type: string format: date updated_at: type: string format: date sentiment: type: string nickname: type: string review_images: type: array items: {} reviewer_type: type: string order: type: object properties: id: type: string order_date: type: string product_sku: type: string product_name: type: string product_url: type: string ReviewLikeObject: type: object properties: user_identifier: type: string example: cust_abc123 vote: type: string example: up でいいね、down で低評価。デフォルトは up。 ReviewLikeResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 data: type: object description: disliked と dislike_count は、アカウントで低評価が有効な場合のみ返却されます。 properties: review_id: type: string example: abc123 liked: type: boolean example: true like_count: type: integer example: 42 disliked: type: boolean example: false dislike_count: type: integer example: 3 ReviewLikesListResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 data: type: array items: type: object properties: review_id: type: string liked: type: boolean like_count: type: integer disliked: type: boolean dislike_count: type: integer ViewAllQuestionBasicResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: total_questions: type: string total_unaswer_count: type: string questions: type: array items: type: object properties: id: type: string product_id: type: string question: type: string questioner: type: object properties: name: type: string time: type: string answer: type: string answerer: type: object properties: avtar: type: string time: type: string label: type: string published: type: string ViewQuestionBasicResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 response: type: object properties: questions: type: array items: type: object properties: id: type: string question: type: string questioner: type: object properties: name: type: string time: type: string answer: type: string answerer: type: object properties: avtar: type: string time: type: string label: type: string QuestionLikeObject: type: object properties: user_identifier: type: string example: cust_abc123 vote: type: string example: up でいいね、down で低評価。デフォルトは up。 QuestionLikeResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 data: type: object description: disliked と dislike_count は、アカウントで低評価が有効な場合のみ返却されます。 properties: question_id: type: string example: qabc123 liked: type: boolean example: true like_count: type: integer example: 12 disliked: type: boolean example: false dislike_count: type: integer example: 2 QuestionLikesListResponse: type: object properties: status: type: string example: OK code: type: integer example: 200 data: type: array items: type: object properties: question_id: type: string liked: type: boolean like_count: type: integer disliked: type: boolean dislike_count: type: integer ReviewFormFieldsObject: type: object required: - product_id properties: product_id: type: string example: "12345" order_id: type: string example: ORDER123 ReviewFormFieldsResponse: type: object properties: status: type: string example: success message: type: string example: Form fields retrieved successfully data: type: object properties: product: type: object properties: product_id: type: string product_name: type: string product_image: type: string is_site_review: type: boolean form_config: type: object properties: language: type: string email_required: type: boolean submit_button_text: type: string success_message: type: string fields: type: array items: type: object properties: field_key: type: string field_type: type: string label: type: string validation: type: object options: type: array items: {} ReviewSubmitObject: type: object required: - product_id - score - review properties: product_id: type: string example: "12345" score: type: integer example: 5 review: type: string example: とても良い商品です。おすすめします。 title: type: string example: 気に入りました name: type: string example: 山田太郎 email: type: string example: taro@example.com nickname: type: string example: タロー order_id: type: string example: ORDER123 custom_form_ans: type: object description: カスタム質問への回答。質問IDをキーとします。 example: "123": answer ReviewSubmitResponse: type: object properties: status: type: string example: success message: type: string example: ありがとうございます。レビューを確認するためのメールをご確認ください。 data: type: object properties: verification_email_sent: type: boolean example: true message: type: string ReviewSubmitFieldErrorResponse: type: object properties: status: type: string example: field_error errors: type: object description: フィールドごとの検証メッセージ。 example: score: 評価を選択してください email: 有効なメールアドレスを入力してください CustomerOrderObject: type: object required: - access_token properties: access_token: type: string example: access_token customer_id: type: string example: 顧客ID。customer_id または email を指定。両方指定された場合は customer_id が優先されます。 email: type: string example: taro@example.com page: type: integer example: 1 limit: type: integer example: 1ページあたりの件数（一括モードでは顧客ごとの件数）。デフォルトは10、最大は100。 customer_ids: type: array description: "一括モード: 顧客ID（文字列または整数）を最大50件。指定した場合、customer_id と email は無視されます。" items: type: string example: - C001 - C002 order_ids: type: array description: "その顧客の指定した注文のみを返します（注文IDを最大100件）。この場合、limit と page は無視されます。" items: type: string example: - "1001" - "1002" CustomerOrderItem: type: object properties: order_id: type: string order_date: type: string product_ids: type: string products: type: array items: type: object properties: product_id: type: string product_name: type: string product_url: type: string product_image_url: type: string token: type: string is_review_submitted: type: integer nullable: true description: "1 = この商品のレビュー依頼は投稿済み、0 = 未投稿、null = この商品にレビュー依頼がありません。" example: 0 is_cancelled: type: integer description: "1 = この商品はキャンセル済み、0 = キャンセルされていません。" example: 0 reviewed_at: type: string nullable: true description: "顧客がこの商品に投稿した最新レビューの日時（Y-m-d H:i:s）。customer_id または email が一致するレビュー、またはこの商品のレビュー依頼から投稿されたレビューが対象です。スタッフレビューは含みません。該当がない場合は null。この注文とは紐付かないため、order_date と比較してください。" example: "2026-10-03 12:00:00" CustomerOrderResponse: type: object properties: status: type: string example: success orders: type: array items: $ref: "#/components/schemas/CustomerOrderItem" metadata: type: object properties: total_orders: type: integer page: type: integer limit: type: integer count: type: integer total_pages: type: integer CustomerOrderBulkResponse: type: object properties: status: type: string example: success customers: type: array description: "リクエストした顧客ごとに1件（リクエスト順）。注文がない顧客も含みます。" items: type: object properties: customer_id: type: string total_orders: type: integer description: "顧客の注文数（limit 適用前）。" orders: type: array items: $ref: "#/components/schemas/CustomerOrderItem" metadata: type: object properties: customer_count: type: integer description: "レスポンスに含まれる顧客数。" limit: type: integer description: "顧客ごとの件数。order_ids を指定した場合は指定した注文IDの数。" StoreBadgesResponse: type: object properties: status: type: string example: OK code: type: string example: "200" data: type: array items: type: object properties: category: type: string description: カテゴリ名。未設定の場合は空文字。 name: type: string description: バッジ名。アカウントに設定された言語。翻訳がない場合は日本語。 description: type: string description: バッジの説明。アカウントに設定された言語。翻訳がない場合は日本語。 image_url: type: string description: バッジ画像のSSL配信URL。 priority: type: integer description: 優先度。値が大きいほど重要。 earned_at: type: string description: 獲得日時。YYYY-MM-DD HH:MM:SS 形式。 example: - category: レビュー件数 name: 1000レビュー達成 description: 累計1000件以上のレビューを獲得したストアに付与されます。 image_url: https://storage.googleapis.com/example/badge.png priority: 100 earned_at: 2026-01-15 09:30:00 FaqsResponse: type: object properties: status: type: string example: OK code: type: string example: "200" data: type: object properties: enabled: type: boolean description: FAQ機能が利用できない場合、または公開中FAQがない場合は false。 settings: type: object description: FAQウィジェットの表示設定。 properties: faq_per_page: type: integer accordion_default_open: type: boolean search_box_enabled: type: boolean category_nav_enabled: type: boolean accent_color: type: string custom_css: type: string categories: type: array description: 表示順のカテゴリ。カテゴリなしのFAQは空タイトルで最後に含まれます。 items: type: object properties: title: type: string custom_id: type: string description: 任意のカテゴリID。未設定時は null。 nullable: true faqs: type: array items: type: object properties: question: type: string answer: type: string description: 簡易なHTML（p, br, ol, ul, li, a, b, strong, em, i）を含む場合があります。 lang: type: object description: ウィジェットUI文言。 example: enabled: true settings: faq_per_page: 10 accordion_default_open: false search_box_enabled: true category_nav_enabled: true accent_color: "#333333" custom_css: "" categories: - title: 配送について custom_id: shipping faqs: - question: 商品はいつ届きますか？ answer:

ご注文から2営業日以内に発送いたします。

lang: search_placeholder: FAQを検索 no_results: 該当するFAQがありません。 all_categories: すべて uncategorized: その他 snippet: type: string description: FAQPage JSON-LDのscriptタグ。リッチスニペット有効時のみ。 example: