Download OpenAPI specification:Download
API documentation for U-KOMI app
Requests exceeding 1 request per second per IP address may be rate limited. Rate-limited requests return 429 Too Many Requests.
access_token are used to authenticate and authorize an account. An access_token is required in non-public API calls to ensure private account data is accessible only by authorized users.
access_token is valid for 14 days from the date of its creation.
⚠️ Note: If the token is not used within the initial 14-day window, it will expire and require regeneration.
| api_key required | string API KEY provided by Vendor |
| api_secret required | string API Secret provided by Vendor |
{- "status": "OK",
- "code": 200,
- "access_token": 200
}Call api to retrieve account details.
| API_KEY required | string API KEY provided by Vendor |
| access_token required | string ACCESS TOKEN provided by API |
{- "status": "OK",
- "code": 200,
- "data": {
- "name": "account1",
- "url": "www.account1.com",
- "framework": "test"
}
}Call api for all review and Pass data in given format to get selected review
| API_KEY required | string API KEY provided by Vendor |
| access_token required | string ACCESS TOKEN provided by API |
| from_id | string Get review after selected id Eg.12345 |
| customer_id | string Get review from customer id Eg.cust. Use customers to specify multiple customer ids. |
Array of strings or string Example: customers=cust_1&customers=cust_2 Get reviews from multiple customer ids. Pass an array (customers[]=cust_1&customers[]=cust_2) or a comma-separated string (customers=cust_1,cust_2). Up to 100 customer ids are allowed. If customer_id is also passed, reviews matching any of the given customer ids are returned. | |
| from_date | string Get review after selected date Eg.2017-11-03 |
| updated_date | string Get data updated/created after selected date Eg.2017-11-03 |
| count | string Number of reviews to return eg.10 |
| page | string Page number to return reviews for eg.2 |
| likes | string Add likes in result Eg.0/1. 0 is default |
| custom_questions | string Add custom questions in result Eg.0/1. 0 is default |
| question_public | string Get private/public questions in result Eg.0/1. 1 is default public |
| question_enable | string Get disable/enable questions in result Eg.0/1. 1 is default enable |
| deleted | string Include unpublished reviews Eg.0/1 |
| sort | string Responses can be sorted by: date/stars/like/sentiment/buyer/picture/response |
| sort_order | string Sorting order. Option is asc/desc |
| stars | string Star rating for the product (1 to 5) Eg.5 |
| stars_sorting | string Options are greater/less/equal. Default is equal |
| post_type | string Options are email/import/website/line/inline_form. You can use multiple by comma separated. Default is null |
| review_type | string Options are site/product/all. Default is all |
| product_id | string Product id. Default is all |
| group | string Group status are true/false. Default is false |
| group_name | string Group name. Default is blank |
| label | string Label name. Default is blank. Comma seprated for multiple |
{- "status": "OK",
- "code": 200,
- "response": {
- "review": [
- {
- "id": "12345",
- "title": "Review title",
- "content": "Review description",
- "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": "Clearly Positive",
- "order_id": "1234",
- "name": "Customer Name",
- "customer_id": "cust",
- "email": "customer@email.com",
- "nickname": "Customer 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 name",
- "product_url": "www.productwebsite.com/product-url"
}, - {
- "id": "12346",
- "title": "Review title 1",
- "content": "Review description 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": "Positive",
- "name": "Customer Name 1",
- "customer_id": "cust_1",
- "email": "customer1@email.com",
- "nickname": "Customer Nickname 1",
- "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": "Product name 1",
- "product_url": "www.productwebsite.com/product-url1"
}, - {
- "id": "12347",
- "title": "Review title 2",
- "content": "Review description 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": "Mixed",
- "name": "Customer Name 2",
- "customer_id": "cust_2",
- "email": "customer2@email.com",
- "nickname": "Customer Nickname 2",
- "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": "Product name 1",
- "product_url": "www.productwebsite.com/product-url2"
}, - {
- "id": "12348",
- "title": "Review title 3",
- "content": "Review description 3",
- "label": "label,label 1,label 2",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name 3",
- "customer_id": "cust_3",
- "email": "customer3@email.com",
- "nickname": "Customer Nickname 3",
- "reviewer_type": "verified_buyer",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "question_answer": [
- {
- "id": "1",
- "question": "Question 1",
- "answer": "Answer 1"
}
], - "post_type": "website",
- "product_sku": "10",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url"
}
]
}
}Call api for all review and Pass data in given format to get selected review
| API_KEY required | string API KEY provided by Vendor |
| from_id | string Get review after selected id Eg.12345 |
| from_date | string Get review after selected date Eg.2017-11-03 |
| updated_date | string Get data updated/created after selected date Eg.2017-11-03 |
| count | string Number of reviews to return eg.10 |
| page | string Page number to return reviews for eg.2 |
| likes | string Add likes in result Eg.0/1. 0 is default |
| custom_questions | string Add custom questions in result Eg.0/1. 0 is default |
| sort | string Responses can be sorted by: date/stars/like/sentiment/buyer/picture/response |
| sort_order | string Sorting order. Option is asc/desc |
| stars | string Star rating for the product (1 to 5) Eg.5 |
| stars_sorting | string Options are greater/less/equal. Default is equal |
| post_type | string Options are email/import/website/line/inline_form. You can use multiple by comma separated. Default is null |
| review_type | string Options are site/product/all. Default is all |
| product_id | string Product id. Default is all |
| group | string Group status are true/false. Default is false |
| group_name | string Group name. Default is blank |
| label | string Label name. Default is blank. Comma seprated for multiple |
{- "status": "OK",
- "code": 200,
- "response": {
- "review": [
- {
- "id": "12345",
- "title": "Review title",
- "content": "Review description",
- "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": "Clearly Positive",
- "nickname": "Customer 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 name",
- "product_url": "www.productwebsite.com/product-url"
}, - {
- "id": "12346",
- "title": "Review title 1",
- "content": "Review description 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": "Positive",
- "nickname": "Customer Nickname 1",
- "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": "Product name 1",
- "product_url": "www.productwebsite.com/product-url1"
}, - {
- "id": "12347",
- "title": "Review title 2",
- "content": "Review description 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": "Mixed",
- "nickname": "Customer Nickname 2",
- "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": "Product name 1",
- "product_url": "www.productwebsite.com/product-url2"
}, - {
- "id": "12348",
- "title": "Review title 3",
- "content": "Review description 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": "Clearly Positive",
- "nickname": "Customer Nickname 3",
- "reviewer_type": "verified_buyer",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "question_answer": [
- {
- "id": "1",
- "question": "Question 1",
- "answer": "Answer 1"
}
], - "post_type": "website",
- "product_sku": "10",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url"
}
]
}
}Call api for all review and Pass data in given format to get selected review with orders
| API_KEY required | string API KEY provided by Vendor |
Review param to fetch review according to it form the U-KOMI system
| access_token required | string |
object Review search parameters |
{- "access_token": "access_token",
- "reviews": {
- "from_id": "Get review after selected id Eg.12345",
- "from_date": "Get review after selected date Eg.2017-11-03",
- "updated_date": "Get review updated/created after selected date Eg.2017-11-03",
- "count": "Number of reviews to return eg.10",
- "page": "Page number to return reviews for eg.2",
- "deleted": "Include unpublished reviews Eg.0/1",
- "sort": "Review sort order (date/stars/like/sentiment/buyer/picture/response) Default is date",
- "sort_order": "Sorting order. Option is asc/desc",
- "stars": "Star rating for the product (1 to 5) Eg.5",
- "stars_sorting": "Options are greater/less/equal. Default is equal"
}
}{- "status": "OK",
- "code": 200,
- "response": {
- "review": [
- {
- "id": "12345",
- "title": "Review title",
- "content": "Review description",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name",
- "email": "customer@email.com",
- "nickname": "Customer Nickname",
- "reviewer_type": "verified_buyer",
- "post_type": "email",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "order": {
- "id": "12345",
- "user_name": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "10",
- "product_name": "Product name 1",
- "product_url": "www.productwebsite.com/product-url1",
- "order_date": "2017-11-03",
- "coupon_code": "u-komi-write-review"
}
}, - {
- "id": "12346",
- "title": "Review title 1",
- "content": "Review description 1",
- "score": "5",
- "created_at": "2018-06-13 15:31:34",
- "updated_at": "2018-06-13 15:31:34",
- "sentiment": "Positive",
- "name": "Customer Name 1",
- "email": "customer1@email.com",
- "nickname": "Customer Nickname 1",
- "reviewer_type": "",
- "post_type": "email",
- "review_images": [
- "image/path/1"
], - "order": {
- "id": "123456",
- "user_name": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "10",
- "product_name": "Product name 1",
- "product_url": "www.productwebsite.com/product-url1",
- "order_date": "2017-11-03",
- "coupon_code": "u-komi-upload-photo"
}
}, - {
- "id": "12347",
- "title": "Review title 2",
- "content": "Review description 2",
- "score": "3",
- "created_at": "2018-06-11 15:31:34",
- "updated_at": "2018-06-11 15:31:34",
- "sentiment": "Mixed",
- "name": "Customer Name 2",
- "email": "customer2@email.com",
- "nickname": "Customer Nickname 2",
- "reviewer_type": "",
- "post_type": "email",
- "review_images": [
- "image/path/1",
- "image/path/2",
- "image/path/3"
], - "order": {
- "id": "1234567",
- "user_name": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "10",
- "product_name": "Product name 1",
- "product_url": "www.productwebsite.com/product-url1",
- "order_date": "2017-11-03",
- "coupon_code": "u-komi-share-review"
}
}, - {
- "id": "12348",
- "title": "Review title 3",
- "content": "Review description 3",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name 3",
- "email": "customer3@email.com",
- "nickname": "Customer Nickname 3",
- "reviewer_type": "verified_buyer",
- "post_type": "website",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "order": {
- "id": "12345678",
- "user_name": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "10",
- "product_name": "Product name 1",
- "product_url": "www.productwebsite.com/product-url1",
- "order_date": "2017-11-03",
- "coupon_code": "u-komi-write-review"
}
}
]
}
}Call api to retrieve review summary for group(s) with filter
| API_KEY required | string API KEY provided by Vendor |
Groups param to fetch review summary form the U-KOMI system
| groups required | Array of any |
| filter | Array of any |
{- "groups": [
- "group1",
- "group2"
], - "filter": {
- "expiration": "expired/not_expired",
- "merge": "0/1",
- "empty": "0/1"
}
}{- "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
}
}
}Call api to retrieve review summary for customer(s) with filter
| API_KEY required | string API KEY provided by Vendor |
Customer ids param to fetch review summary form the U-KOMI system
| access_token | string Optional. Required to list all customers when filter.merge is "0". |
Array of strings or string Array of customer IDs or comma-separated string of customer IDs. If not provided, returns all customers. | |
| filter | object Filter options |
| updated_date | string |
| cursor | string Cursor for pagination. Use the cursor value from the previous response to get the next page. Only works when filter.merge is '0' and customers is not provided. |
| count | integer Number of records per page. Default is 10, maximum is 1000. |
{- "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
}{- "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
}Call api with filter by passing API Key and review type you can receive filtered review summary
| API_KEY required | string API KEY provided by Vendor |
| review_type required | string Review type (site/product/all) |
Filter param to fetch review summary form the U-KOMI system
| filter | Array of any |
{- "filter": {
- "expiration": "expired/not_expired"
}
}{- "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
}
}
}By passing API Key and review type you can receive review summary
| API_KEY required | string API KEY provided by Vendor |
| review_type required | string Review type (site/product/all) |
| product_id | string Product id. Default is all |
| group | string Group status are true/false. Default is false |
| group_name | string Group name. Default is blank |
| ai_summary | string Include AI-generated summary in the response. Options are 0/1. Default is 0 (exclude summary). |
| q_n_a_summary | string Include Q&A summary in the response. Options are 0/1. Default is 0 (exclude summary). |
| rating_breakdown | string Include rating breakdown in the response. Options are 0/1. Default is 0 (exclude breakdown). |
{- "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
}
}
}Call api with review id to get selected review
| API_KEY required | string API KEY provided by Vendor |
| review_id required | string Review id |
| access_token required | string ACCESS TOKEN provided by API |
| deleted | string Include unpublished reviews Eg.0/1. Each entry of review_images_with_status is {"url": ..., "deleted": 0|1}; deleted=1 also returns unpublished photos/videos there. |
{- "status": "OK",
- "code": 200,
- "response": {
- "review": [
- {
- "id": "12345",
- "title": "Review title",
- "content": "Review description",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name",
- "email": "customer@email.com",
- "review_images": [
- "image/path/1",
- "image/path/2",
- "image/path/3"
], - "nickname": "Customer Nickname",
- "reviewer_type": "verified_buyer",
- "product_sku": "10",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url"
}
]
}
}Call api get selected product's reviews
| API_KEY required | string API KEY provided by Vendor |
| product_id required | string ID of the product to retrieve reviews |
| access_token required | string ACCESS TOKEN provided by API |
| count | string Number of reviews to return eg.10 |
| page | string Page number to return reviews for eg.2 |
| sort | string Responses can be sorted by: date/stars/like/sentiment/buyer/picture/response |
| sort_order | string Sorting order. Option is asc/desc |
| stars | string Star rating for the product (1 to 5) Eg.5 |
| stars_sorting | string Options are greater/less/equal. Default is equal |
| customer_id | string Filter reviews by customer ID. |
{- "status": "OK",
- "code": 200,
- "response": {
- "review": [
- {
- "id": "12345",
- "title": "Review title",
- "content": "Review description",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name",
- "customer_id": "cust",
- "email": "customer@email.com",
- "nickname": "Customer Nickname",
- "reviewer_type": "verified_buyer",
- "post_type": "email",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "product_sku": "10",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url"
}, - {
- "id": "12346",
- "title": "Review title 1",
- "content": "Review description 1",
- "score": "5",
- "created_at": "2018-06-13 15:31:34",
- "updated_at": "2018-06-13 15:31:34",
- "sentiment": "Positive",
- "name": "Customer Name 1",
- "customer_id": "cust_1",
- "email": "customer1@email.com",
- "nickname": "Customer Nickname 1",
- "reviewer_type": "",
- "post_type": "import",
- "review_images": [
- "image/path/1"
], - "product_sku": "11",
- "product_name": "Product name 1",
- "product_url": "www.productwebsite.com/product-url1"
}, - {
- "id": "12347",
- "title": "Review title 2",
- "content": "Review description 2",
- "score": "3",
- "created_at": "2018-06-11 15:31:34",
- "updated_at": "2018-06-11 15:31:34",
- "sentiment": "Mixed",
- "name": "Customer Name 2",
- "customer_id": "cust_2",
- "email": "customer2@email.com",
- "nickname": "Customer Nickname 2",
- "reviewer_type": "",
- "post_type": "email",
- "review_images": [
- "image/path/1",
- "image/path/2",
- "image/path/3"
], - "product_sku": "11",
- "product_name": "Product name 1",
- "product_url": "www.productwebsite.com/product-url2"
}, - {
- "id": "12348",
- "title": "Review title 3",
- "content": "Review description 3",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name 3",
- "customer_id": "cust_3",
- "email": "customer3@email.com",
- "nickname": "Customer Nickname 3",
- "reviewer_type": "verified_buyer",
- "post_type": "website",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "product_sku": "10",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url"
}
]
}
}Pass order_ids and product_ids in given format to get verification token
| API_KEY required | string API KEY provided by Vendor |
Order ID and Product ID that needs to be get verification token from the U-KOMI system
| access_token required | string |
required | Array of objects (InlineReviewFormTokenRequestOrderObject) |
{- "access_token": "access_token",
- "orders": [
- {
- "order_id": "12345",
- "product_id": "12345"
}
]
}{- "status": "OK",
- "code": 200,
- "orders": [
- {
- "order_id": "12345",
- "product_id": "12345",
- "verification_token": "review_verification_token"
}
]
}Retrieve a single review by its id. The basic response omits reviewer personal information such as name and email.
| API_KEY required | string API KEY provided by Vendor |
| review_id required | string Review id |
{- "status": "OK",
- "code": 200,
- "response": {
- "review": [
- {
- "id": "12345",
- "title": "Review title",
- "content": "Review description",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "nickname": "Customer Nickname",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "reviewer_type": "verified_buyer",
- "product_sku": "10",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url"
}
]
}
}Retrieve the reviews of a product. The basic response omits reviewer personal information such as name and email.
| API_KEY required | string API KEY provided by Vendor |
| product_id required | string ID of the product to retrieve reviews |
| count | string Number of reviews to return eg.10 |
| page | string Page number to return reviews for eg.2 |
| sort | string Responses can be sorted by: date/stars/like/sentiment/buyer/picture/response |
| sort_order | string Sorting order. Option is asc/desc |
| stars | string Star rating for the product (1 to 5) Eg.5 |
| stars_sorting | string Options are greater/less/equal. Default is equal |
{- "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"
}
]
}
}Retrieve reviews together with their related order details. The basic response omits reviewer and buyer personal information such as name and email.
| API_KEY required | string API KEY provided by Vendor |
Optional filters for the reviews to return
object |
{- "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"
}
}{- "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"
}
}
]
}
}Record a like or a dislike for a review. Dislikes are only accepted when dislikes are enabled for your account.
| API_KEY required | string API KEY provided by Vendor |
| review_id required | string Review id |
Vote details
| user_identifier | string |
| vote | string |
{- "user_identifier": "cust_abc123",
- "vote": "up to like, down to dislike. Default is up."
}{- "status": "OK",
- "code": 200,
- "data": {
- "review_id": "abc123",
- "liked": true,
- "like_count": 42,
- "disliked": false,
- "dislike_count": 3
}
}Retrieve the like (and dislike) count for a review. Pass user_identifier to also receive that user's current vote.
| API_KEY required | string API KEY provided by Vendor |
| review_id required | string Review id |
| user_identifier | string Optional identifier of the current user, to return that user's vote |
{- "status": "OK",
- "code": 200,
- "data": {
- "review_id": "abc123",
- "liked": true,
- "like_count": 42,
- "disliked": false,
- "dislike_count": 3
}
}Retrieve the like (and dislike) counts for several reviews at once. Pass review_ids as a comma separated list (up to 100).
| API_KEY required | string API KEY provided by Vendor |
| review_ids required | string Comma separated list of review ids (up to 100) eg.abc123,def456 |
| user_identifier | string Optional identifier of the current user, to return that user's vote |
{- "status": "OK",
- "code": 200,
- "data": [
- {
- "review_id": "string",
- "liked": true,
- "like_count": 0,
- "disliked": true,
- "dislike_count": 0
}
]
}Retrieve the fields and labels needed to render a review form for a product.
| API_KEY required | string API KEY provided by Vendor |
Product to build the form for
| product_id required | string |
| order_id | string |
{- "product_id": "12345",
- "order_id": "ORDER123"
}{- "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
]
}
]
}
}Submit a review. A verification email is sent to confirm the review.
| API_KEY required | string API KEY provided by Vendor |
Review to submit
| product_id required | string |
| score required | integer |
| review required | string |
| title | string |
| name | string |
string | |
| nickname | string |
| order_id | string |
| custom_form_ans | object Answers to custom questions, keyed by question id. |
{- "product_id": "12345",
- "score": 5,
- "review": "Great product, highly recommend.",
- "title": "Loved it",
- "name": "Taro Yamada",
- "email": "taro@example.com",
- "nickname": "Taro",
- "order_id": "ORDER123",
- "custom_form_ans": {
- "123": "answer"
}
}{- "status": "success",
- "message": "Thank you! Please check your email to verify your review.",
- "data": {
- "verification_email_sent": true,
- "message": "string"
}
}Just call api with out passing any data and actions
| API_KEY required | string API KEY provided by Vendor |
Product param to fetch product according to it form the U-KOMI system
| access_token required | string |
object Product search parameters |
{- "access_token": "access_token",
- "product": {
- "group": "group_name",
- "tag": "tag name",
- "from_date": "2017-11-03",
- "updated_date": "2017-11-03",
- "has_reviews": "Filter products having reviews (0/1) Default is 0",
- "review_updated_date": "2017-11-03",
- "review": "Include Review Data (0/1) Default is 0",
- "review_count": "Review count per product (1 or higher) Default is 10",
- "review_sort": "Review sort order (date/stars/like/sentiment/buyer/picture/response) Default is date",
- "review_sort_order": "Sort order (asc/desc) Default is desc",
- "count": "10",
- "page": "1"
}
}{- "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": "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": "Review title",
- "content": "Review description",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name",
- "customer_id": "CustomerId",
- "email": "customer@email.com",
- "post_type": "email",
- "review_images": [
- "image/path/1",
- "image/path/2"
], - "nickname": "Customer Nickname",
- "reviewer_type": "verified_buyer"
}, - {
- "id": "12346",
- "title": "Review title 1",
- "content": "Review description 1",
- "score": "5",
- "created_at": "2018-06-13 15:31:34",
- "updated_at": "2018-06-13 15:31:34",
- "sentiment": "Positive",
- "name": "Customer Name 1",
- "customer_id": "CustomerId1",
- "email": "customer1@email.com",
- "post_type": "email",
- "review_images": [
- "image/path/1"
], - "nickname": "Customer 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": "Product description",
- "short_description": "Product 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": "Product description",
- "short_description": "Product 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": "Review title",
- "content": "Review description",
- "score": "4",
- "created_at": "2018-06-12 15:31:34",
- "updated_at": "2018-06-12 15:31:34",
- "sentiment": "Clearly Positive",
- "name": "Customer Name",
- "customer_id": "CustomerId",
- "email": "customer@email.com",
- "post_type": "email",
- "review_images": [
- "image/path/1"
], - "nickname": "Customer 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": "Product description",
- "short_description": "Product 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"
}
]
}
}Just call api with out passing any data and actions
| API_KEY required | string API KEY provided by Vendor |
Product param to fetch product according to it form the U-KOMI system
| access_token required | string |
object Product search parameters |
{- "access_token": "access_token",
- "product": {
- "group": "group_name",
- "tag": "tag name",
- "from_date": "2017-11-03",
- "updated_date": "2017-11-03",
- "has_reviews": "Filter products having reviews (0/1) Default is 0",
- "review_updated_date": "2017-11-03",
- "review": "Include Review Data (0/1) Default is 0",
- "review_count": "Review count per product (1 or higher) Default is 10",
- "review_sort": "Review sort order (date/stars/like/sentiment/buyer/picture/response) Default is date",
- "review_sort_order": "Sort order (asc/desc) Default is desc",
- "count": "10",
- "page": "1"
}
}{- "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": "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": "Review title",
- "content": "Review description",
- "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": "Customer Nickname",
- "reviewer_type": "verified_buyer"
}, - {
- "id": "12346",
- "title": "Review title 1",
- "content": "Review description 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": "Customer 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": "Product description",
- "short_description": "Product 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": "Product description",
- "short_description": "Product 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": "Review title",
- "content": "Review description",
- "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",
- "image/path/3"
], - "nickname": "Customer 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": "Product description",
- "short_description": "Product 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"
}
]
}
}Pass a single product_id or a comma-separated list of product_ids to fetch product details.
| API_KEY required | string API KEY provided by Vendor |
Product retrieval parameters (access_token and product_id)
| access_token required | string |
| product_id required | string Single product_id or comma-separated product_ids |
{- "access_token": "access_token",
- "product_id": "P001,P002,P003"
}{- "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"
}
]
}
}Pass product data in given format to create product
| API_KEY required | string API KEY provided by Vendor |
Products object that needs to be added to the U-KOMI system
| access_token required | string |
required | object product_id is ID of the product in store |
{- "access_token": "access_token",
- "products": {
- "product_id": {
- "name": "Product Name",
- "description": "This is the description of a product",
- "short_description": "This is the short description of a product",
- "group_name": "Group Name",
- "price": "123",
- "review_email_priority": "2/1/0/-1/-2",
- "review_request_email_delay": 10,
- "expiration_date": "2017-11-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
}
}
}
{- "status": "OK",
- "code": 200,
- "errors": [
- {
- "message": "string"
}
]
}By passing API Key and product id you can receive product review summary which can be used for Rich Snippets
| API_KEY required | string API KEY provided by Vendor |
| product_id required | string ID of the product to retrieve reviews |
| group_status required | string If product is belong to group and you want to get whole group data eg.true/false |
{- "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
}
}
}By passing API Key, product id and review_code you can receive product review in meta tags.
| API_KEY required | string API KEY provided by Vendor |
| product_id required | integer ID of the product to retrieve reviews |
| review_code required | string review_code from Review URL |
{- "status": "OK",
- "code": 200,
- "review_meta": "<meta property=\"og:url\" content=\"https://example.com/product_url?review_code=code_here\" /><meta property=\"og:title\" content=\"review title here\" /><meta property=\"og:description\" content=\"revew content here\" /><meta property=\"og:image\" content=\"https://example.com/product-image.jpg\" />"
}Just call api with out passing any data and actions
| API_KEY required | string API KEY provided by Vendor |
Product param to fetch product according to it form the U-KOMI system
| access_token required | string |
object Product search parameters |
{- "access_token": "access_token",
- "product": {
- "count": "10",
- "page": "1"
}
}{- "status": "OK",
- "code": 200,
- "response": {
- "products": [
- [
- "product_id_1",
- "product_id_2",
- "product_id_3",
- "product_id_4",
- "product_id_5"
]
]
}
}Pass product id in given format to add blacklisted product
| API_KEY required | string API KEY provided by Vendor |
Product ids that needs to be added to the U-KOMI system
| access_token required | string |
| product_id required | Array of strings product_id is ID of the product in store |
{- "access_token": "access_token",
- "product_id": [
- "productid1",
- "productid2",
- "productid3",
- "productid4",
- "productid5"
]
}{- "status": "OK",
- "code": 200
}Pass product id in given format to delete blacklisted product
| API_KEY required | string API KEY provided by Vendor |
Blacklist product ids that needs to be delete to the U-KOMI system
| access_token required | string |
| product_id required | Array of strings product_id is ID of the product in store |
{- "access_token": "access_token",
- "product_id": [
- "productid1",
- "productid2",
- "productid3",
- "productid4",
- "productid5"
]
}{- "status": "OK",
- "code": 200
}Create, modify and retrieve orders in the U-KOMI system. Orders represents purchases made in the store. U-KOMI uses these orders to help generate more reviews from past shoppers.
Just call api with out passing any data and actions
| API_KEY required | string API KEY provided by Vendor |
Order param to fetch order according to it form the U-KOMI system
| access_token required | string |
object Order search parameters |
{- "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 Default is new",
- "cursor_date": "2017-11-03",
- "cursor_source": 1,
- "cursor_id": 12345
}
}{- "status": "OK",
- "code": 200,
- "response": {
- "order": [
- {
- "id": "1",
- "customer_id": "Customer_id",
- "line_id": "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "user_name": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "10",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url",
- "product_image": "www.productwebsite.com/product-image-url",
- "product_description": "This is the description of a product",
- "order_date": "2017-11-03",
- "coupon_code": "u-komi-write-review",
- "review": {
- "id": "abtocde",
- "title": "Review Title",
- "content": "Review 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": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "11",
- "product_name": "Product name",
- "product_url": "www.productwebsite.com/product-url1",
- "product_image": "www.productwebsite.com/product-image-url1",
- "product_description": "This is the description of a product",
- "order_date": "2017-11-03",
- "coupon_code": "u-komi-upload-photo",
- "review": [ ]
}, - {
- "id": "3",
- "customer_id": "Customer_id",
- "line_id": "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "user_name": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "12",
- "product_name": "Product name 2",
- "product_url": "www.productwebsite.com/product-url2",
- "product_image": "www.productwebsite.com/product-image-url2",
- "product_description": "This is the description of a product",
- "order_date": "2017-11-03",
- "coupon_code": "u-komi-share-review",
- "review": [ ]
}, - {
- "id": "4",
- "customer_id": "Customer_id",
- "line_id": "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "user_name": "Customer Name",
- "user_email": "customer@email.com",
- "user_nickname": "Customer Nickname",
- "product_sku": "13",
- "product_name": "Product name 2",
- "product_url": "www.productwebsite.com/product-url3",
- "product_image": "www.productwebsite.com/product-image-url3",
- "product_description": "This is the description of a product",
- "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
}
}
}Pass order data in given format to create order
Orders that already exist in U-KOMI are skipped, and so are their products.
| API_KEY required | string API KEY provided by Vendor |
Order object that needs to be added to the U-KOMI system
| access_token required | string |
required | Array of objects (CreateOrderObject) |
{- "access_token": "access_token",
- "orders": [
- {
- "customer_email": "customer@email.com",
- "customer_name": "Customer Name",
- "customer_id": "Customer_id",
- "line_id": "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "customer_nickname": "Customer Nickname",
- "order_id": "12345",
- "order_date": "2017-11-03",
- "currency_iso": "JPY",
- "coupon_code": "coupon_code",
- "email_lang": "ja",
- "products": {
- "product_id": {
- "name": "Product Name",
- "description": "This is the description of a product",
- "short_description": "This is the short description of a product",
- "group_name": "Group Name",
- "price": "123",
- "review_email_priority": "2/1/0/-1/-2",
- "review_request_email_delay": 10,
- "expiration_date": "2017-11-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
}
}
}
]
}{- "status": "OK",
- "code": 200
}This call stops U-KOMI sending out mails after order for the specific order and product. If you don't specify which product in the order then MAPS are not sent for all products in that order.
| API_KEY required | string API KEY provided by Vendor |
Cancel Order object containing order_id and product_ids that needs to be cancelled U-KOMI system
| access_token required | string |
required | Array of objects |
{- "access_token": "access_token",
- "orders": [
- {
- "order_id": "12345",
- "product_ids": [
- "product_id1",
- "product_id2"
]
}, - {
- "order_id": "12346"
}
]
}{- "status": "OK",
- "code": 200
}Retrieve a customer's orders along with their products and, where a review is still pending, a review token. Identify the customer by customer_id or email; if both are passed, customer_id is used.
Each product line also returns is_review_submitted, is_cancelled and reviewed_at.
Bulk mode: send customer_ids (up to 50) to get the orders of several customers in one call. The response then has customers instead of orders, limit applies per customer and page is not used.
Send order_ids (up to 100) to return only those orders of the customer; limit and page are then ignored.
| API_KEY required | string API KEY provided by Vendor |
Access token and the customer to look up
| access_token required | string |
| customer_id | string |
string | |
| page | integer |
| limit | integer |
| customer_ids | Array of strings Bulk mode: up to 50 customer ids (strings or integers). When sent, customer_id and email are ignored. |
| order_ids | Array of strings Return only these orders of the customer (up to 100 order ids). limit and page are then ignored. |
{- "access_token": "access_token",
- "customer_id": "Customer id. Provide customer_id or email; if both are passed, customer_id is used.",
- "email": "taro@example.com",
- "page": 1,
- "limit": "Records per page, or per customer in bulk mode. Default is 10, maximum is 100.",
- "customer_ids": [
- "C001",
- "C002"
], - "order_ids": [
- "1001",
- "1002"
]
}{- "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
}
}Product Grouping allows you to create groups of related products and share reviews between all the products in the same group.
Just call api with out passing any data and actions
| API_KEY required | string API KEY provided by Vendor |
Group object that needs to be added to the U-KOMI system
| access_token | string |
object Group search parameters |
{- "access_token": "access_token",
- "group": {
- "from_date": "2017-11-03",
- "updated_date": "2017-11-03"
}
}{- "status": "OK",
- "code": 200,
- "groups": [
- "group 3",
- "group 2",
- "group 1"
]
}Pass group data in given format to create group
| API_KEY required | string API KEY provided by Vendor |
Group name that needs to be added to the U-KOMI system
| access_token required | string |
| group_name required | string |
{- "access_token": "access_token",
- "group_name": "Group Name"
}{- "status": "OK",
- "code": 200
}Pass order data in given format to add/remove product
| API_KEY required | string API KEY provided by Vendor |
Product id that needs to be added/remove to groups base on action in the U-KOMI system
| access_token required | string |
| group_name required | string |
| product_action required | string Enum: "add" "remove" |
| product_id required | string |
{- "access_token": "access_token",
- "group_name": "Group Name",
- "product_action": "add",
- "product_id": "101,102,103"
}{- "status": "OK",
- "code": 200
}By passing group name you can retrieve product list to that group
| API_KEY required | string API KEY provided by Vendor |
By passing group name you can retrieve product list to that group
| access_token | string |
| group_name required | string |
{- "access_token": "access_token",
- "group_name": "Group Name"
}{- "status": "OK",
- "code": 200,
- "response": {
- "groups": {
- "name": "Group Name",
- "products": [
- {
- "sku": "12345",
- "name": "Product name",
- "url": "www.productwebsite.com/product-url"
}
]
}
}
}Pass group data in given format to delete group
| API_KEY required | string API KEY provided by Vendor |
Group name that needs to be deleted to the U-KOMI system
| access_token required | string |
| group_name required | string |
{- "access_token": "access_token",
- "group_name": "Group Name"
}{- "status": "OK",
- "code": 200
}Call api to get all question and answer
| API_KEY required | string API KEY provided by Vendor |
| access_token required | string ACCESS TOKEN provided by API |
| grab_all | string Get all questions. Options: 1/0. Include Bazora: 1, otherwise No. The default is 0. |
| from_date | string Get questions after selected date Eg.2017-11-03 |
| updated_date | string Get questions updated/created after selected date Eg.2017-11-03 |
| count | string Number of questions to return eg.10 |
| page | string Page number to return questions for eg.2 |
| label | string Label name. Default is blank. Comma seprated for multiple |
| published | string Get published/unpublished questions. eg.0 for unpublished, 1 for published, all. Default value is all |
{- "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",
- "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",
- "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",
- "time": "2020-06-12 15:31:34"
}, - "bazora": "1",
- "label": "label,label 1,label 2",
- "published": "1"
}
]
}
}Call api to get all question of selected product id
| API_KEY required | string API KEY provided by Vendor |
| product_id required | string ID of the product to retrieve reviews |
| access_token required | string ACCESS TOKEN provided by API |
{- "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",
- "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",
- "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",
- "time": "2020-06-12 15:31:34"
}, - "label": "label,label 1,label 2"
}
]
}
}
}Call api to get question count of selected product id
| API_KEY required | string API KEY provided by Vendor |
| product_id required | string ID of the product to retrieve reviews |
{- "status": "OK",
- "code": 200,
- "response": {
- "count": 450
}
}Retrieve all questions and answers. The basic response omits the questioner's email.
| API_KEY required | string API KEY provided by Vendor |
| grab_all | string Get all questions. Options: 1/0. Include community questions: 1, otherwise No. The default is 0. |
| from_date | string Get questions after selected date Eg.2017-11-03 |
| updated_date | string Get questions updated/created after selected date Eg.2017-11-03 |
| count | string Number of questions to return eg.10 |
| page | string Page number to return questions for eg.2 |
| label | string Label name. Default is blank. Comma seprated for multiple |
| published | string Get published/unpublished questions. eg.0 for unpublished, 1 for published, all. Default value is all |
{- "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"
}
]
}
}Retrieve the questions and answers of a product. The basic response omits the questioner's email.
| API_KEY required | string API KEY provided by Vendor |
| product_id required | string ID of the product to retrieve questions |
{- "status": "OK",
- "code": 200,
- "response": {
- "questions": [
- {
- "id": "string",
- "question": "string",
- "questioner": {
- "name": "string",
- "time": "string"
}, - "answer": "string",
- "answerer": {
- "avtar": "string",
- "time": "string"
}, - "label": "string"
}
]
}
}Record a like or a dislike for a question. Dislikes are only accepted when dislikes are enabled for your account.
| API_KEY required | string API KEY provided by Vendor |
| question_id required | string Question id |
Vote details
| user_identifier | string |
| vote | string |
{- "user_identifier": "cust_abc123",
- "vote": "up to like, down to dislike. Default is up."
}{- "status": "OK",
- "code": 200,
- "data": {
- "question_id": "qabc123",
- "liked": true,
- "like_count": 12,
- "disliked": false,
- "dislike_count": 2
}
}Retrieve the like (and dislike) count for a question. Pass user_identifier to also receive that user's current vote.
| API_KEY required | string API KEY provided by Vendor |
| question_id required | string Question id |
| user_identifier | string Optional identifier of the current user, to return that user's vote |
{- "status": "OK",
- "code": 200,
- "data": {
- "question_id": "qabc123",
- "liked": true,
- "like_count": 12,
- "disliked": false,
- "dislike_count": 2
}
}Retrieve the like (and dislike) counts for several questions at once. Pass question_ids as a comma separated list (up to 100).
| API_KEY required | string API KEY provided by Vendor |
| question_ids required | string Comma separated list of question ids (up to 100) eg.q1,q2,q3 |
| user_identifier | string Optional identifier of the current user, to return that user's vote |
{- "status": "OK",
- "code": 200,
- "data": [
- {
- "question_id": "string",
- "liked": true,
- "like_count": 0,
- "disliked": true,
- "dislike_count": 0
}
]
}Retrieve visual UGC (Instagram, X/Twitter, TikTok, YouTube, review photos and admin uploads) at album, album-media and gallery level.
Call api to retrieve all visual-curation albums for the account. Scoped to the authenticated account. The access token may also be sent as a Bearer token in the Authorization header.
| API_KEY required | string API KEY provided by Vendor |
Access token and optional filters / pagination
| access_token required | string Access token. May also be sent as an 'Authorization: Bearer |
| album_type | string Filter by album type: custom / product / official / user. Omit to return all. |
| count | integer Items per page. Default 10, max 100. |
| page | integer Page number. Default 1. |
| from_date | string Filter by created_at (>=). |
| updated_date | string Filter by updated_at (>=). |
{- "access_token": "YOUR_ACCESS_TOKEN",
- "album_type": "",
- "count": 10,
- "page": 1,
- "from_date": "",
- "updated_date": ""
}{- "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
}
}
}Call api to retrieve all media (Instagram, X/Twitter, TikTok, YouTube, review photos, admin uploads) inside an album, normalized into a single shape. Cursor-paginated and scoped to the authenticated account. The access token may also be sent as a Bearer token in the Authorization header.
| API_KEY required | string API KEY provided by Vendor |
| album_id required | string Encoded album id (the album_id returned by the albums endpoint) |
Access token and optional filters / sorting / pagination
| access_token required | string Access token. May also be sent as an 'Authorization: Bearer |
| source | string Filter by source: instagram / review_picture / upload / tiktok / twitter / youtube. Omit to return all. |
| rights_status | string Filter by rights status: approved / pending / rejected. Omit to return all. |
| sort | string Sort key: date / likes. Default is date. |
| sort_order | string Sort direction: asc / desc. Default is desc. |
| cursor | string Cursor for the next page (next_cursor from a previous response). Omit for the first page. |
| count | integer Items per page. Default 10, max 100. |
{- "access_token": "YOUR_ACCESS_TOKEN",
- "source": "",
- "rights_status": "",
- "sort": "date",
- "sort_order": "desc",
- "cursor": "",
- "count": 10
}{- "status": "success",
- "code": 200,
- "message": "OK",
- "data": {
- "media": [
- {
- "media_id": "knpAVlkUrIJ0ZRao",
- "source": "instagram",
- "video_url": null,
- "caption": "Post caption text",
- "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=="
}
}
}Call api to retrieve galleries and their linked album. Scoped to the authenticated account. The access token may also be sent as a Bearer token in the Authorization header.
| API_KEY required | string API KEY provided by Vendor |
Access token and optional pagination
| access_token required | string Access token. May also be sent as an 'Authorization: Bearer |
| count | integer Items per page. Default 10, max 100. |
| page | integer Page number. Default 1. |
{- "access_token": "YOUR_ACCESS_TOKEN",
- "count": 10,
- "page": 1
}{- "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
}
}
}By passing your API Key you can retrieve the badges the store publicly displays. Badge name and description are returned in the account's configured language and fall back to Japanese when no translation exists. Returns an empty data array when the store has no public badges.
| API_KEY required | string API KEY provided by Vendor |
{- "status": "OK",
- "code": "200",
- "data": [
- {
- "category": "Review Count",
- "name": "1000 Reviews Achieved",
- "description": "Awarded to stores with 1000+ total reviews.",
- "priority": 100,
- "earned_at": "2026-01-15 09:30:00"
}
]
}Returns the published FAQs (categories, questions, answers) for the account. If the FAQ feature is not available or nothing is published, the response is still 200 with data.enabled = false. When rich snippets are enabled, snippet contains a ready-to-use FAQPage JSON-LD script tag.
| API_KEY required | string API KEY provided by Vendor |
| lang | string Content language (e.g. ja, en). Translations are returned only when FAQ translation is enabled. Defaults to the account language. |
| category | string Limit the JSON-LD (snippet) to one category, by custom_id or title. Use uncategorized for FAQs without a category. |
{- "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": "Shipping",
- "custom_id": "shipping",
- "faqs": [
- {
- "question": "How long does delivery take?",
- "answer": "<p>Orders ship within 2 business days.</p>"
}
]
}
], - "lang": {
- "search_placeholder": "Search FAQs",
- "no_results": "No matching FAQs found.",
- "all_categories": "All",
- "uncategorized": "Other"
}
}, - "snippet": "<script type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"FAQPage\",\"mainEntity\":[...]}</script>"
}