U-KOMI API (1.0.1)

Download OpenAPI specification:Download

E-mail: info@u-komi.com License: Apache 2.0

U-KOMI　APIドキュメント

レート制限

IPアドレスごとに秒間1リクエストを超えるリクエストは制限される場合があります。制限された場合は 429 Too Many Requests が返却されます。

Authentication

API認証

アクセストークンの取得

アクセストークンはアカウント認証のために利用するものです。権限を持ってるユーザーのみがアクセスできるように非公共のAPIコールで利用されています。

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

初期の有効期限:
access_token は作成日から 14日間 有効です。
自動延長:
トークンが この14日間の有効期間内に使用された場合、最後に使用された日から さらに14日間 自動的に有効期限が延長されます。

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

Request Body schema: application/x-www-form-urlencoded
required

api_key required	string APIキー
api_secret required	string APIシークレット

Responses

Response samples

200
401
402
403

Content type

application/json

{"status": "OK",
"code": 200,
"access_token": 200
}

Account

アカウント基本情報の取得

アカウント詳細を取得する

アカウント詳細を取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/x-www-form-urlencoded
required

access_token

required

string

アクセストークン

Responses

Response samples

200
401
402
403
404

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"name": "account1",
"url": "www.account1.com",
"framework": "test"
}
}

Reviews

レビュー取得

すべてのレビューを取得する

すべてのレビューを取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

query Parameters

access_token required	string アクセストークン
from_id	string 指定されたID以降のレビューを取得
customer_id	string 顧客IDでレビューを取得（例：12345）。複数指定する場合はcustomersを使用してください。
	Array of strings or string Example: customers=cust_1&customers=cust_2 複数の顧客IDでレビューを取得します。配列（customers[]=cust_1&customers[]=cust_2）またはカンマ区切りの文字列（customers=cust_1,cust_2）で指定できます。最大100件まで指定可能です。 customer_idと同時に指定した場合は、いずれかの顧客IDに一致するレビューを返します。
from_date	string 指定された日付以降のレビューを取得
updated_date	string ある日付以降に作成または更新されたデータを取得
count	string 指定された数のレビューを取得
page	string 指定されたページ数のレビューを取得
likes	string いいねを取得（0/1 デフォルトは0）
custom_questions	string カスタム質問を取得（0/1 デフォルトは0）
question_public	string 公開されているカスタム質問のみ取得するかどうか（0/1 デフォルトは1）
question_enable	string 有効にされているカスタム質問のみ取得するかどうか（0/1 デフォルトは1）
deleted	string 非公開レビューを含む（0/1 デフォルトは0）
sort	string 取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）
sort_order	string 昇順と降順の表示順（指定可能表示順：asc, desc）
stars	string 指定された評価のみを取得（指定可能評価：1-5）
stars_sorting	string 評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）
post_type	string 取得するレビューの種類を指定（指定可能表示順（カンマ切りで複数の指定は可能）：email, import, website, line, inline_form）
review_type	string レビューの種類（site/product/all デフォルトはall）
product_id	string 商品ID（デフォルトはall）
group	string グループステータス（true/false デフォルトはfalse）
group_name	string グループ名（デフォルトは空）
label	string ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）

Responses

Response samples

200
401
402
403
406

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"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"
}
]
}
}

すべてのレビューを取得する

すべてのレビューを取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

query Parameters

from_id	string 指定されたID以降のレビューを取得
from_date	string 指定された日付以降のレビューを取得
updated_date	string ある日付以降に作成または更新されたデータを取得
count	string 指定された数のレビューを取得
page	string 指定されたページ数のレビューを取得
likes	string いいねを取得（0/1 デフォルトは0）
custom_questions	string カスタム質問を取得（0/1 デフォルトは0）
sort	string 取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）
sort_order	string 昇順と降順の表示順（指定可能表示順：asc, desc）
stars	string 指定された評価のみを取得（指定可能評価：1-5）
stars_sorting	string 評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）
post_type	string 取得するレビューの種類を指定（指定可能表示順（カンマ切りで複数の指定は可能）：email, import, website, line, inline_form）
review_type	string レビューの種類（site/product/all デフォルトはall）
product_id	string 商品ID（デフォルトはall）
group	string グループステータス（true/false デフォルトはfalse）
group_name	string グループ名（デフォルトは空）
label	string ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）

Responses

Response samples

200
401
402
403
406

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"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"
}
]
}
}

すべてのレビューとレビューの受注データを取得

すべてのレビューとレビューの受注データを取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

レビューフィルターのパラメーターを確認する

access_token required	string
	object Review search parameters

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"reviews": {"from_id": "指定されたID以降のレビューを取得",
"from_date": "指定された日付以降のレビューを取得",
"updated_date": "Get review updated/created after selected date Eg.2017-11-03",
"count": "指定された数のレビューを取得",
"page": "指定されたページ数のレビューを取得",
"deleted": "非公開レビューを含む",
"sort": "レビューの表示順（指定可能表示順：date/stars/like/sentiment/buyer/picture/response デフォルトはdate）",
"sort_order": "昇順と降順の表示順（指定可能表示順：asc, desc）",
"stars": "指定された評価のみを取得（指定可能評価：1-5）",
"stars_sorting": "評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）"
}
}

Response samples

200
401
402
403
406

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"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"
}
}
]
}
}

グループのレビュー概要を取得

あるフィルター付きのグループのレビュー概要を取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

グループのレビュー概要を取得するためのパラメータ

groups required	Array of any
filter	Array of any

Responses

Request samples

Payload

Content type

application/json

{"groups": ["group1",
"group2"
],
"filter": {"expiration": "expired/not_expired",
"merge": "0/1",
"empty": "0/1"
}
}

Response samples

200
403

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"total_reviews": 10,
"average_ratings": 4.5,
"ai_summary": { },
"q_n_a_summary": { },
"rating_breakdown": {"1": 2,
"2": 1,
"3": 0,
"4": 3,
"5": 4
}
}
}

指定された顧客IDのレビュー概要を取得する

フィルターを使用して顧客のレビュー概要を取得するためにAPIを呼び出す

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

U-KOMIシステムからレビューサマリーを取得するための顧客IDのパラメータ

access_token	string 任意項目。filter.mergeが"0"で全顧客を取得する場合は必須です。
	Array of strings or string 顧客IDの配列またはカンマ区切りの文字列。指定しない場合は全顧客を返します。
filter	object フィルターオプション
updated_date	string
cursor	string ページネーション用のカーソル。次のページを取得するには、前回のレスポンスのcursor値を使用してください。filter.mergeが'0'でcustomersが指定されていない場合のみ有効です。
count	integer 1ページあたりのレコード数。デフォルトは10、最大は1000です。

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"customers": ["customer_id1",
"customer_id2"
],
"filter": {"merge": "0/1",
"empty": "0/1"
},
"updated_date": "2024-01-15",
"cursor": "cursor_value",
"count": 10
}

Response samples

200
401
403

Content type

application/json

{"status": "OK",
"code": 200,
"data": [{"customer_id": "customer_id1",
"total_reviews": 10,
"average_ratings": 4.5,
"review_ids": "abc123,def456",
"review_product_ids": "prod_1,prod_2",
"review_first_date": "2024-01-15",
"review_last_date": "2025-02-10"
}
],
"cursor": "cursor_value",
"count": 100
}

フィルター付きレビュー概要を取得

あるレビュー概要をフィルター付きで取得するためのAPIコールです。

path Parameters

API_KEY required	string APIキー
review_type required	string レビューの種類（site/product/all）

Request Body schema: application/json
required

フィルター付きのレビュー概要を取得するためのAPIコールです。

filter

Array of any

Responses

Request samples

Payload

Content type

application/json

{"filter": {"expiration": "expired/not_expired"
}
}

Response samples

200

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"total_reviews": 10,
"average_ratings": 4.5,
"ai_summary": { },
"q_n_a_summary": { },
"rating_breakdown": {"1": 2,
"2": 1,
"3": 0,
"4": 3,
"5": 4
}
}
}

レビュー概要を取得

あるレビュー概要を取得するためのAPIコールです。

path Parameters

API_KEY required	string APIキー
review_type required	string レビューの種類（site/product/all）

query Parameters

product_id	string 商品ID（デフォルトはall）
group	string グループステータス（true/false デフォルトはfalse）
group_name	string グループ名（デフォルトは空）
ai_summary	string AIによるレビュー要約を含めるかどうか（0/1 デフォルトは0）
q_n_a_summary	string カスタム質問と回答の要約を含めるかどうか（0/1 デフォルトは0）
rating_breakdown	string 評価内訳を含めるかどうか（0/1 デフォルトは0）

Responses

Response samples

200

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"total_reviews": 10,
"average_ratings": 4.5,
"ai_summary": { },
"q_n_a_summary": { },
"rating_breakdown": {"1": 2,
"2": 1,
"3": 0,
"4": 3,
"5": 4
}
}
}

指定されたレビューを取得

指定されたレビューを取得するためのAPIコールです。

path Parameters

API_KEY required	string APIキー
review_id required	string レビューID

query Parameters

access_token required	string アクセストークン
deleted	string 非公開レビューを含む（0/1）。review_images_with_status の各要素は {"url": ..., "deleted": 0\|1} です。deleted=1 では非公開の写真・動画もそこに含まれます。

Responses

Response samples

200
401
402
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"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"
}
]
}
}

指定された商品のレビューを取得

指定された商品のレビューを取得するためのAPIコールです。

path Parameters

API_KEY required	string APIキー
product_id required	string 商品ID

query Parameters

access_token required	string アクセストークン
count	string 指定された数のレビューを取得
page	string 指定されたページ数のレビューを取得
sort	string 取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）
sort_order	string 昇順と降順の表示順（指定可能表示順：asc, desc）
stars	string 指定された評価のみを取得（指定可能評価：1-5）
stars_sorting	string 評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）
customer_id	string 顧客IDでレビューを絞り込みます。

Responses

Response samples

200
401
402
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"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"
}
]
}
}

U-KOMIからインラインフォームトークンを取得する

注文番号と商品番号を送信してトークンを取得

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

トークンを取得するための注文番号と商品番号

access_token required	string
required	Array of objects (InlineReviewFormTokenRequestOrderObject)

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"orders": [{"order_id": "12345",
"product_id": "12345"
}
]
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"orders": [{"order_id": "12345",
"product_id": "12345",
"verification_token": "review_verification_token"
}
]
}

指定されたレビューを取得（基本）

指定されたレビューを取得します。基本レスポンスでは、氏名やメールアドレスなどのレビュアー個人情報は含まれません。

path Parameters

API_KEY required	string APIキー
review_id required	string レビューID

Responses

Response samples

200
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"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"
}
]
}
}

指定された商品のレビューを取得（基本）

指定された商品のレビューを取得します。基本レスポンスでは、氏名やメールアドレスなどのレビュアー個人情報は含まれません。

path Parameters

API_KEY required	string APIキー
product_id required	string 商品ID

query Parameters

count	string 指定された数のレビューを取得
page	string 指定されたページ数のレビューを取得
sort	string 取得されたデータの表示順を指定する（指定可能表示順：date/stars/like/sentiment/buyer/picture/response）
sort_order	string 昇順と降順の表示順（指定可能表示順：asc, desc）
stars	string 指定された評価のみを取得（指定可能評価：1-5）
stars_sorting	string 評価の表示順（指定可能表示順：great/less/equal デフォルトはequal）

Responses

Response samples

200
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"id": "string",
"title": "string",
"content": "string",
"score": 0,
"created_at": "2019-08-24",
"updated_at": "2019-08-24",
"sentiment": "string",
"nickname": "string",
"review_images": [null
],
"reviewer_type": "string",
"product_sku": "string",
"product_name": "string",
"product_url": "string"
}
]
}
}

注文情報付きレビューを取得（基本）

注文情報付きのレビューを取得します。基本レスポンスでは、レビュアーおよび購入者の個人情報は含まれません。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json

取得するレビューの絞り込み条件（任意）

object

Responses

Request samples

Payload

Content type

application/json

{"reviews": {"count": 10,
"page": 1,
"from_id": "abc123",
"from_date": "2025-01-01",
"updated_date": "2025-01-01",
"stars": 5,
"stars_sorting": "greater",
"sort": "date",
"sort_order": "desc",
"deleted": "no"
}
}

Response samples

200
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"review": [{"id": "string",
"title": "string",
"content": "string",
"score": 0,
"created_at": "2019-08-24",
"updated_at": "2019-08-24",
"sentiment": "string",
"nickname": "string",
"review_images": [null
],
"reviewer_type": "string",
"order": {"id": "string",
"order_date": "string",
"product_sku": "string",
"product_name": "string",
"product_url": "string"
}
}
]
}
}

レビューにいいね・低評価

レビューにいいねまたは低評価を記録します。低評価は、アカウントで低評価が有効な場合のみ受け付けられます。

path Parameters

API_KEY required	string APIキー
review_id required	string レビューID

Request Body schema: application/json

投票内容

user_identifier	string
vote	string

Responses

Request samples

Payload

Content type

application/json

{"user_identifier": "cust_abc123",
"vote": "up でいいね、down で低評価。デフォルトは up。"
}

Response samples

200
400
401

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"review_id": "abc123",
"liked": true,
"like_count": 42,
"disliked": false,
"dislike_count": 3
}
}

レビューのいいね数を取得

レビューのいいね（および低評価）数を取得します。user_identifier を指定すると、そのユーザーの現在の投票も返却されます。

path Parameters

API_KEY required	string APIキー
review_id required	string レビューID

query Parameters

user_identifier

string

現在のユーザーの識別子（任意。そのユーザーの投票を返却）

Responses

Response samples

200
400
401

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"review_id": "abc123",
"liked": true,
"like_count": 42,
"disliked": false,
"dislike_count": 3
}
}

複数レビューのいいね数を取得

複数のレビューのいいね（および低評価）数をまとめて取得します。review_ids はカンマ区切りで指定します（最大100件）。

path Parameters

API_KEY

required

string

APIキー

query Parameters

review_ids required	string レビューIDをカンマ区切りで指定（最大100件）例：abc123,def456
user_identifier	string 現在のユーザーの識別子（任意。そのユーザーの投票を返却）

Responses

Response samples

200
400
401

Content type

application/json

{"status": "OK",
"code": 200,
"data": [{"review_id": "string",
"liked": true,
"like_count": 0,
"disliked": true,
"dislike_count": 0
}
]
}

レビューフォームの項目を取得

商品のレビューフォームを表示するために必要な項目とラベルを取得します。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

フォームを作成する商品

product_id required	string
order_id	string

Responses

Request samples

Payload

Content type

application/json

{"product_id": "12345",
"order_id": "ORDER123"
}

Response samples

200
400
401

Content type

application/json

{"status": "success",
"message": "Form fields retrieved successfully",
"data": {"product": {"product_id": "string",
"product_name": "string",
"product_image": "string",
"is_site_review": true
},
"form_config": {"language": "string",
"email_required": true,
"submit_button_text": "string",
"success_message": "string"
},
"fields": [{"field_key": "string",
"field_type": "string",
"label": "string",
"validation": { },
"options": [null
]
}
]
}
}

レビューを投稿

レビューを投稿します。確認のためのメールが送信されます。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

投稿するレビュー

product_id required	string
score required	integer
review required	string
title	string
name	string
email	string
nickname	string
order_id	string
custom_form_ans	object カスタム質問への回答。質問IDをキーとします。

Responses

Request samples

Payload

Content type

application/json

{"product_id": "12345",
"score": 5,
"review": "とても良い商品です。おすすめします。",
"title": "気に入りました",
"name": "山田太郎",
"email": "taro@example.com",
"nickname": "タロー",
"order_id": "ORDER123",
"custom_form_ans": {"123": "answer"
}
}

Response samples

200
400
401
422

Content type

application/json

{"status": "success",
"message": "ありがとうございます。レビューを確認するためのメールをご確認ください。",
"data": {"verification_email_sent": true,
"message": "string"
}
}

Products

商品データを取得・作成・編集

商品を取得

データやアクション送信せずにAPIのみコールする

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

U-KOMIから商品データを取得するための商品パラメータ

access_token required	string
	object 商品検索パラメータ

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"product": {"group": "group_name",
"tag": "tag name",
"from_date": "2017-11-03",
"updated_date": "2017-11-03",
"has_reviews": "レビューがある商品のフィルタリング（0/1 デフォルトは0）",
"review_updated_date": "2017-11-03",
"review": "レビューデータを含む（0/1 デフォルトは0）",
"review_count": "商品ごとのレビュー件数（1以上 デフォルトは10）",
"review_sort": "レビューの表示順（指定可能表示順：date/stars/like/sentiment/buyer/picture/response デフォルトはdate）",
"review_sort_order": "表示順（指定可能表示順：asc/desc デフォルトはdesc）",
"count": "10",
"page": "1"
}
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"products": [{"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"
}
]
}
}

商品を取得

データやアクション送信せずにAPIのみコールする

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

U-KOMIから商品データを取得するための商品パラメータ

access_token required	string
	object 商品検索パラメータ

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"product": {"group": "group_name",
"tag": "tag name",
"from_date": "2017-11-03",
"updated_date": "2017-11-03",
"has_reviews": "レビューがある商品のフィルタリング（0/1 デフォルトは0）",
"review_updated_date": "2017-11-03",
"review": "レビューデータを含む（0/1 デフォルトは0）",
"review_count": "商品ごとのレビュー件数（1以上 デフォルトは10）",
"review_sort": "レビューの表示順（指定可能表示順：date/stars/like/sentiment/buyer/picture/response デフォルトはdate）",
"review_sort_order": "表示順（指定可能表示順：asc/desc デフォルトはdesc）",
"count": "10",
"page": "1"
}
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"products": [{"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"
}
]
}
}

商品IDで商品詳細を取得

単一の product_id またはカンマ区切りの product_id を渡して商品詳細を取得します。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

商品取得用パラメータ（access_token と product_id）

access_token required	string
product_id required	string 単一の product_id またはカンマ区切りの product_id

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"product_id": "P001,P002,P003"
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"products": [{"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"
}
]
}
}

商品データを作成する

商品データを作成するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

U-KOMIに追加する商品データの詳細

access_token required	string
required	object product_id is ID of the product in store

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"products": {"product_id": {"url": "http://www.yoursite.com/product_url.html",
"name": "商品名",
"image": "http://www.yoursite.com/image_path/image_name.jpg",
"description": "商品詳細テキスト",
"short_description": "簡潔な商品説明テキスト",
"group_name": "グループ名",
"price": "123",
"review_email_priority": "2/1/0/-1/-2",
"review_request_email_delay": 10,
"expiration_date": "2021-04-03",
"coupon_code": "coupon_code",
"specs": {"property1": "string",
"property2": "string"
},
"tag": "Tag",
"product_tags": "Tag1,Tag2",
"created_at": "2017-11-03",
"updated_at": "2017-11-03",
"is_published": 1
}
}
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"errors": [{"message": "string"
}
]
}

レビュー概要を取得

ある商品のレビュー概要を取得するためのAPIコールです。こちらのデータをリッチスニペット対応などで利用できます。

path Parameters

API_KEY required	string APIキー
product_id required	string 商品ID
group_status required	string グループに入ってる商品で、そのグループの全商品データを取得したい場合（指定可能の値：true, false）

Responses

Response samples

200
401
402
403
404

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"total_reviews": 10,
"average_ratings": 4.5,
"ai_summary": { },
"q_n_a_summary": { },
"rating_breakdown": {"1": 2,
"2": 1,
"3": 0,
"4": 3,
"5": 4
}
}
}

ogタグのmetadataを取得

ある商品のレビューmetadataを取得するためのAPIコールです。

path Parameters

API_KEY required	string APIキー
product_id required	integer 商品ID
review_code required	string レビューコード

Responses

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"review_meta": "<meta property=\"og:url\" content=\"https://example.com/product_url?review_code=レビューコードはここ\" /><meta property=\"og:title\" content=\"レビュータイトルはここ\" /><meta property=\"og:description\" content=\"レビュー詳細はここ\" /><meta property=\"og:image\" content=\"https://example.com/product-image.jpg\" />"
}

ブラックリスト商品を取得

データやアクション送信せずにAPIのみコールする

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

U-KOMIから商品データを取得するための商品パラメータ

access_token required	string
	object Product search parameters

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"product": {"count": "10",
"page": "1"
}
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"products": [["product_id_1",
"product_id_2",
"product_id_3",
"product_id_4",
"product_id_5"
]
]
}
}

U-KOMIにブラックリスト商品を追加

商品をブラックリスト商品に追加するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

ブラックリスト商品に追加する商品IDを送信する。

access_token required	string
product_id required	Array of strings product_id is ID of the product in store

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"product_id": ["productid1",
"productid2",
"productid3",
"productid4",
"productid5"
]
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200
}

U-KOMIからブラックリスト商品を削除

商品をブラックリスト商品から削除するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

ブラックリスト商品から削除する商品IDを送信する。

access_token required	string
product_id required	Array of strings product_id is ID of the product in store

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"product_id": ["productid1",
"productid2",
"productid3",
"productid4",
"productid5"
]
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200
}

Orders

受注データを取得・作成・編集

受注データを取得

受注データを取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

受注データを取得するためのパラメータ

access_token required	string
	object Order search parameters

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"orders": {"from_id": "12345",
"from_date": "2017-11-03",
"count": "10",
"page": "4",
"retrieve_reviews": "1",
"order_id": "order_id",
"sort_order": "new/old — デフォルトは new です",
"cursor_date": "2017-11-03",
"cursor_source": 1,
"cursor_id": 12345
}
}

Response samples

200
401
402
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"order": [{"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": 4,
"total_purchase": 400,
"cursor": {"cursor_date": "string",
"cursor_source": 0,
"cursor_id": 0
}
}
}

受注データを作成

受注データを作成するためのAPIコールです。

U-KOMIに登録済みの注文はスキップされ、その注文の商品も更新されません。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

受注データを取得するためのパラメータ

access_token required	string
required	Array of objects (CreateOrderObject)

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"orders": [{"customer_email": "customer@email.com",
"customer_name": "お名前",
"customer_id": "Customer_id",
"line_id": "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"customer_nickname": "お名前",
"order_id": "12345",
"order_date": "2017-11-03",
"currency_iso": "JPY",
"coupon_code": "coupon_code",
"email_lang": "ja",
"products": {"product_id": {"url": "http://www.yoursite.com/product_url.html",
"name": "商品名",
"image": "http://www.yoursite.com/image_path/image_name.jpg",
"description": "商品詳細テキスト",
"short_description": "簡潔な商品説明テキスト",
"group_name": "グループ名",
"price": "123",
"review_email_priority": "2/1/0/-1/-2",
"review_request_email_delay": 10,
"expiration_date": "2021-04-03",
"coupon_code": "coupon_code",
"specs": {"property1": "string",
"property2": "string"
},
"tag": "Tag",
"product_tags": "Tag1,Tag2",
"created_at": "2017-11-03",
"updated_at": "2017-11-03",
"is_published": 1
}
}
}
]
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200
}

受注データを取り消す

受注データを取り消してレビュー依頼メール送信を止めるためのAPIコールです。商品IDを指定しない場合は受注データにある全商品データが対象になります。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

受注データを取り消すための受注ID・商品IDが含まれたパラメータ

access_token required	string
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"orders": [{"order_id": "12345",
"product_ids": ["product_id1",
"product_id2"
]
},
{"order_id": "12346"
}
]
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200
}

顧客の注文を取得

顧客の注文と商品、レビュー未投稿の場合はレビュートークンを取得します。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 は無視されます。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

アクセストークンと検索する顧客

access_token required	string
customer_id	string
email	string
page	integer
limit	integer
customer_ids	Array of strings 一括モード: 顧客ID（文字列または整数）を最大50件。指定した場合、customer_id と email は無視されます。
order_ids	Array of strings その顧客の指定した注文のみを返します（注文IDを最大100件）。この場合、limit と page は無視されます。

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"customer_id": "顧客ID。customer_id または email を指定。両方指定された場合は customer_id が優先されます。",
"email": "taro@example.com",
"page": 1,
"limit": "1ページあたりの件数（一括モードでは顧客ごとの件数）。デフォルトは10、最大は100。",
"customer_ids": ["C001",
"C002"
],
"order_ids": ["1001",
"1002"
]
}

Response samples

200
401
403
405
406

Content type

application/json

Example

CustomerOrderResponse

{"status": "success",
"orders": [{"order_id": "string",
"order_date": "string",
"product_ids": "string",
"products": [{"product_id": "string",
"product_name": "string",
"product_url": "string",
"product_image_url": "string",
"token": "string",
"is_review_submitted": 0,
"is_cancelled": 0,
"reviewed_at": "2026-10-03 12:00:00"
}
]
}
],
"metadata": {"total_orders": 0,
"page": 0,
"limit": 0,
"count": 0,
"total_pages": 0
}
}

Groups

商品グループを取得・作成・編集・削除

すべてのグループを取得

すべてのグループを取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

グループを取得するためのパラメータ

access_token	string
	object Group search parameters

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"group": {"from_date": "2017-11-03",
"updated_date": "2017-11-03"
}
}

Response samples

200
401
402
403
406

Content type

application/json

{"status": "OK",
"code": 200,
"groups": ["group 3",
"group 2",
"group 1"
]
}

グループを作成

グループを作成するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

グループを作成するためのパラメータ

access_token required	string
group_name required	string

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"group_name": "グループ名"
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200
}

グループに商品を追加・削除

グループに商品を追加・削除するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

グループに商品を追加・削除するためのパラメータ

access_token required	string
group_name required	string
product_action required	string Enum: "add" "remove"
product_id required	string

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"group_name": "グループ名",
"product_action": "add",
"product_id": "101,102,103"
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200
}

指定されたグループの詳細を取得

指定されたグループの詳細を取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

グループ名

access_token	string
group_name required	string

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"group_name": "グループ名"
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"groups": {"name": "グループ名",
"products": [{"sku": "12345",
"name": "商品名",
"url": "www.productwebsite.com/product-url"
}
]
}
}
}

グループを削除

グループを削除するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

Request Body schema: application/json
required

グループ名

access_token required	string
group_name required	string

Responses

Request samples

Payload

Content type

application/json

{"access_token": "access_token",
"group_name": "グループ名"
}

Response samples

Content type

application/json

{"status": "OK",
"code": 200
}

Q&A

指定された商品のQ&Aを取得

すべてのQ&Aを取得

すべてのQ&Aデータを取得するためのAPIコールです。

path Parameters

API_KEY

required

string

APIキー

query Parameters

access_token required	string アクセストークン
grab_all	string すべての質問を取得します。オプション: 1 / 0。BAZORAを含める: 1 の場合のみ、それ以外は含めない。デフォルトは「0」。
from_date	string 指定された日付以降のQ&Aを取得
updated_date	string ある日付以降に作成または更新されたデータを取得
count	string 指定された数のQ&Aを取得
page	string 指定されたページ数のQ&Aを取得
label	string ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）
published	string どのQ&Aを取得するか公開・非公開ステータスで取得（0/1/all デフォルトはall）

Responses

Response samples

200
401
402
403
406

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"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"
}
]
}
}

指定された商品のQ&Aを取得

指定された商品のQ&Aデータを取得するためのAPIコールです。

path Parameters

API_KEY required	string APIキー
product_id required	string 商品ID

query Parameters

access_token

required

string

アクセストークン

Responses

Response samples

200
401
402
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"questions": {"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"
}
]
}
}
}

指定された商品のQ&Aカウントを取得

指定された商品のQ&Aカウントを取得するためのAPIコールです。

path Parameters

API_KEY required	string APIキー
product_id required	string 商品ID

Responses

Response samples

200
401
402
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"count": 450
}
}

すべてのQ&Aを取得（基本）

すべてのQ&Aを取得します。基本レスポンスでは、質問者のメールアドレスは含まれません。

path Parameters

API_KEY

required

string

APIキー

query Parameters

grab_all	string すべての質問を取得します。コミュニティの質問を含める: 1 の場合のみ。デフォルトは「0」。
from_date	string 指定された日付以降のQ&Aを取得
updated_date	string ある日付以降に作成または更新されたデータを取得
count	string 指定された数のQ&Aを取得
page	string 指定されたページ数のQ&Aを取得
label	string ラベル名。デフォルトは空。（カンマ切りで複数の指定は可能）
published	string どのQ&Aを取得するか公開・非公開ステータスで取得（0/1/all デフォルトはall）

Responses

Response samples

200
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"total_questions": "string",
"total_unaswer_count": "string",
"questions": [{"id": "string",
"product_id": "string",
"question": "string",
"questioner": {"name": "string",
"time": "string"
},
"answer": "string",
"answerer": {"avtar": "string",
"time": "string"
},
"label": "string",
"published": "string"
}
]
}
}

商品のQ&Aを取得（基本）

指定された商品のQ&Aを取得します。基本レスポンスでは、質問者のメールアドレスは含まれません。

path Parameters

API_KEY required	string APIキー
product_id required	string 商品ID

Responses

Response samples

200
403

Content type

application/json

{"status": "OK",
"code": 200,
"response": {"questions": [{"id": "string",
"question": "string",
"questioner": {"name": "string",
"time": "string"
},
"answer": "string",
"answerer": {"avtar": "string",
"time": "string"
},
"label": "string"
}
]
}
}

質問にいいね・低評価

質問にいいねまたは低評価を記録します。低評価は、アカウントで低評価が有効な場合のみ受け付けられます。

path Parameters

API_KEY required	string APIキー
question_id required	string 質問ID

Request Body schema: application/json

投票内容

user_identifier	string
vote	string

Responses

Request samples

Payload

Content type

application/json

{"user_identifier": "cust_abc123",
"vote": "up でいいね、down で低評価。デフォルトは up。"
}

Response samples

200
400
401

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"question_id": "qabc123",
"liked": true,
"like_count": 12,
"disliked": false,
"dislike_count": 2
}
}

質問のいいね数を取得

質問のいいね（および低評価）数を取得します。user_identifier を指定すると、そのユーザーの現在の投票も返却されます。

path Parameters

API_KEY required	string APIキー
question_id required	string 質問ID

query Parameters

user_identifier

string

現在のユーザーの識別子（任意。そのユーザーの投票を返却）

Responses

Response samples

200
400
401

Content type

application/json

{"status": "OK",
"code": 200,
"data": {"question_id": "qabc123",
"liked": true,
"like_count": 12,
"disliked": false,
"dislike_count": 2
}
}

複数質問のいいね数を取得

複数の質問のいいね（および低評価）数をまとめて取得します。question_ids はカンマ区切りで指定します（最大100件）。

path Parameters

API_KEY

required

string

APIキー

query Parameters

question_ids required	string 質問IDをカンマ区切りで指定（最大100件）例：q1,q2,q3
user_identifier	string 現在のユーザーの識別子（任意。そのユーザーの投票を返却）

Responses

Response samples

200
400
401

Content type

application/json

{"status": "OK",
"code": 200,
"data": [{"question_id": "string",
"liked": true,
"like_count": 0,
"disliked": true,
"dislike_count": 0
}
]
}

Visual Curation

ビジュアルUGC（Instagram・X(Twitter)・TikTok・YouTube・レビュー写真・管理者アップロード）をアルバム／アルバムメディア／ギャラリー単位で取得

アルバム一覧の取得

アカウントのビジュアルキュレーション・アルバムを一覧取得します。結果は認証されたアカウントにスコープされます。アクセストークンは Authorization ヘッダーに Bearer 形式で送信することもできます。

path Parameters

API_KEY

required

string

ベンダーから提供される API KEY

Request Body schema: application/json
required

アクセストークンおよび任意のフィルター／ページネーション

access_token required	string アクセストークン。Authorization ヘッダーに 'Bearer ' として送信することもできます。
album_type	string アルバム種別で絞り込み: custom / product / official / user。省略するとすべて。
count	integer 1ページあたりの件数。既定 10、最大 100。
page	integer ページ番号。既定 1。
from_date	string created_at で絞り込み（>=）。
updated_date	string updated_at で絞り込み（>=）。

Responses

Request samples

Payload

Content type

application/json

{"access_token": "YOUR_ACCESS_TOKEN",
"album_type": "",
"count": 10,
"page": 1,
"from_date": "",
"updated_date": ""
}

Response samples

200
401
410

Content type

application/json

{"status": "success",
"code": 200,
"message": "OK",
"data": {"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
}
}
}

アルバム内メディアの取得

アルバム内のすべてのメディア（Instagram・X(Twitter)・TikTok・YouTube・レビュー写真・管理者アップロード）を統一フォーマットで取得します。カーソルベースのページネーションに対応し、結果は認証されたアカウントにスコープされます。アクセストークンは Authorization ヘッダーに Bearer 形式で送信することもできます。

path Parameters

API_KEY required	string ベンダーから提供される API KEY
album_id required	string エンコードされた album_id（albums エンドポイントが返す値）

Request Body schema: application/json
required

アクセストークンおよび任意のフィルター／ソート／ページネーション

access_token required	string アクセストークン。Authorization ヘッダーに 'Bearer ' として送信することもできます。
source	string ソースで絞り込み: instagram / review_picture / upload / tiktok / twitter / youtube。省略するとすべて。
rights_status	string 権利ステータスで絞り込み: approved / pending / rejected。省略するとすべて。
sort	string ソートキー: date / likes。既定は date。
sort_order	string ソート方向: asc / desc。既定は desc。
cursor	string 次ページ取得用のカーソル（前回レスポンスの next_cursor）。初回は省略。
count	integer 1ページあたりの件数。既定 10、最大 100。

Responses

Request samples

Payload

Content type

application/json

{"access_token": "YOUR_ACCESS_TOKEN",
"source": "",
"rights_status": "",
"sort": "date",
"sort_order": "desc",
"cursor": "",
"count": 10
}

Response samples

200
401
404
410

Content type

application/json

{"status": "success",
"code": 200,
"message": "OK",
"data": {"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=="
}
}
}

ギャラリー一覧の取得

ギャラリーと紐づくアルバムを一覧取得します。結果は認証されたアカウントにスコープされます。アクセストークンは Authorization ヘッダーに Bearer 形式で送信することもできます。

path Parameters

API_KEY

required

string

ベンダーから提供される API KEY

Request Body schema: application/json
required

アクセストークンおよび任意のページネーション

access_token required	string アクセストークン。Authorization ヘッダーに 'Bearer ' として送信することもできます。
count	integer 1ページあたりの件数。既定 10、最大 100。
page	integer ページ番号。既定 1。

Responses

Request samples

Payload

Content type

application/json

{"access_token": "YOUR_ACCESS_TOKEN",
"count": 10,
"page": 1
}

Response samples

200
401
410

Content type

application/json

{"status": "success",
"code": 200,
"message": "OK",
"data": {"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
}
}
}

Store Badges

ストアが公開表示しているバッジを取得

ストアバッジを取得

APIキーを指定して、ストアが公開表示しているバッジを取得します。バッジ名と説明はアカウントに設定された言語で返却され、該当する翻訳がない場合は日本語が返却されます。公開バッジがない場合、data は空配列になります。

path Parameters

API_KEY

required

string

APIキー

Responses

Response samples

Content type

application/json

{"status": "OK",
"code": "200",
"data": [{"category": "レビュー件数",
"name": "1000レビュー達成",
"description": "累計1000件以上のレビューを獲得したストアに付与されます。",
"image_url": "https://storage.googleapis.com/example/badge.png",
"priority": 100,
"earned_at": "2026-01-15 09:30:00"
}
]
}

FAQ

公開中のFAQをJSONで取得（静的HTMLでの表示などに利用）

公開中のFAQを取得

アカウントの公開中FAQ（カテゴリ・質問・回答）を返却します。FAQ機能が利用できない場合、または公開中FAQがない場合も200を返却し、data.enabled は false になります。リッチスニペットが有効な場合、snippet にそのまま利用できるFAQPage JSON-LDのscriptタグが含まれます。

path Parameters

API_KEY

required

string

APIキー

query Parameters

lang	string コンテンツの言語（例: ja, en）。FAQ翻訳が有効な場合のみ翻訳を返却。未指定時はアカウントの言語。
category	string JSON-LD（snippet）を1カテゴリに限定。custom_id またはタイトルで指定。カテゴリなしは uncategorized。

Responses

Response samples

Content type

application/json

{"status": "OK",
"code": "200",
"data": {"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": "<p>ご注文から2営業日以内に発送いたします。</p>"
}
]
}
],
"lang": {"search_placeholder": "FAQを検索",
"no_results": "該当するFAQがありません。",
"all_categories": "すべて",
"uncategorized": "その他"
}
},
"snippet": "<script type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[...]}</script>"
}

U-KOMI API (1.0.1)

レート制限

Authentication

アクセストークンの取得

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

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Account

アカウント詳細を取得する

path Parameters

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Reviews

すべてのレビューを取得する

path Parameters

query Parameters

Responses

Response samples

すべてのレビューを取得する

path Parameters

query Parameters

Responses

Response samples

すべてのレビューとレビューの受注データを取得

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

グループのレビュー概要を取得

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

指定された顧客IDのレビュー概要を取得する

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

フィルター付きレビュー概要を取得

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

レビュー概要を取得

path Parameters

query Parameters

Responses

Response samples

指定されたレビューを取得

path Parameters

query Parameters

Responses

Response samples

指定された商品のレビューを取得

path Parameters

query Parameters

Responses

Response samples

U-KOMIからインラインフォームトークンを取得する

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

指定されたレビューを取得（基本）

path Parameters

Responses

Response samples

指定された商品のレビューを取得（基本）

path Parameters

query Parameters

Responses

Response samples

注文情報付きレビューを取得（基本）

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required