Vault
Max value reached
Adding this item would put you over your total vault limit of $250. please review your cart to stay under the limit.
API Documentation
Welcome to the Beauty Review API.
Get a list of all products and their IDs
URL: https://www.beautyreview.co.nz/api/products
Request Parameters
| API Key | Your API Key provided by Beauty Review (Required) |
|---|---|
| GTIN | Product GTIN (optional) |
Example Request
https://www.beautyreview.co.nz/api/products?key={YOUR_API_KEY}>in={GTIN}
Response Parameters
| status | success or error |
|---|---|
| result | products object with all product information |
| id | Product ID |
| name | Product Name |
Example Response
All responses are returned as JSON data.
{"status":"success","result":{"products":[{"id":"1234","name":"Product Name"}]}}
Get a list of all top rated products
URL: https://www.beautyreview.co.nz/api/products/top_rated
Request Parameters
| API Key | Your API Key provided by Beauty Review (Required) |
|---|
Example Request
https://www.beautyreview.co.nz/api/products/top_rated?key={YOUR_API_KEY}
Response Parameters
| status | success or error |
|---|---|
| result | products object with all product information |
| badge | https:\/\/www.beautyreview.co.nz\/layout\/default\/page-elements\/top-rated.png |
| id | Product ID |
| gtin | Product GTIN |
| name | Product Name |
| brand | Brand Name |
Example Response
All responses are returned as JSON data.
Get the overall rating for a product
URL: https://www.beautyreview.co.nz/api/products/rating
Request Parameters
| API Key | Your API Key provided by Beauty Review (Required) |
|---|---|
| Product ID | Product ID retrieved from the products endpoint (Optional) |
| GTIN | Product GTIN (Optional) |
Example Request
https://www.beautyreview.co.nz/api/products/rating/{PRODUCT_ID}?key={YOUR_API_KEY}>in={GTIN}
Response Parameters
| status | success or error |
|---|---|
| result | product ratings |
| rating_count | Total number of ratings for this product |
| rating | Average overall rating out of 5 for this product |
| use_again | Rating out of 5 for the question 'Would use it again?' |
| do_what_it_said | Rating out of 5 for the question 'Did it do what it said it would?' |
| recommend | Rating out of 5 for the question 'Would recommend it to a friend?' |
Example Response
All responses are returned as JSON data.
{"status":"success","result":{"rating_count":"23","rating":"5.0","use_again":"4.8","do_what_it_said":"5.0","recommend":"5.0"}}
Get the product reviews
URL: https://www.beautyreview.co.nz/api/products/reviews
Request Parameters
| API Key | Your API Key provided by Beauty Review (Required) |
|---|---|
| Product ID | Product ID retrieved from the products endpoint (Optional) |
| GTIN | Product GTIN (Optional) |
| Lower Limit | Lower limit used to paginate results, passed as $_GET data 'll', defaults to 0 (Optional) |
| Upper Limit | Upper limit used to paginate results, passed as $_GET data 'ul', defaults to 100 (Optional) |
Example Request
https://www.beautyreview.co.nz/api/products/reviews/{PRODUCT_ID}?key={YOUR_API_KEY}>in={GTIN}&ll=0&ul=100
Response Parameters
| status | success or error |
|---|---|
| result | reviews object |
| user | Beauty Review username for user that placed review |
| profile_link | Link to Beauty Review users profile if they have a public profile, if their profile is not public this will be blank |
| avatar | Link to the users Beauty Review avatar if they have uploaded one |
| title | Title of the review |
| review | The content of the review |
| tips | Optional field the user can fill in when replacing their review with tips on using the product, can be blank |
| use_again | Rating out of 5 for the question 'Would use it again?' |
| do_what_it_said | Rating out of 5 for the question 'Did it do what it said it would?' |
| recommend | Rating out of 5 for the question 'Would recommend it to a friend?' |
Example Response
All responses are returned as JSON data.
{"status":"success","result":{"reviews":[{"user":"username","profile_link":"https:\/\/www.beautyreview.co.nz\/profile\/page\/view\/username","avatar":"https:\/\/www.beautyreview.co.nz\/avatar.jpg","title":"Review Title","review":"Review Content","tips":"Review Tips","use_again":"5","do_what_it_said":"5","recommend":"5"}]}}
