A Product is an instance of the item being sold to the end customer, and ratings and reviews are added to an instance of a Product. Lipscore does not support product variants (i.e. different colors of the same product) so all products whose ratings and reviews should be displayed together must have the same internal_id/sku.


GET /products
Receive a list of Products

Receive a list of Products

Supported Formats

json

Params

Param name Description
internal_id
optional

An array of internal Product IDs in your webshop


Value:

Must be an array of String

fields
optional

A comma-separated list of fields which should be returned with the product. Available: rating, votes, review_count, reviews. By default it’s empty


Value:

Must be String

page
optional

Page number. By default 1


Value:

Must be Integer

per_page
optional

Page size. By default 100. Maximum is 100


Value:

Must be Integer

api_key
required

API key (a 24 character unique code)


Value:

Must be String

Examples

GET /products?internal_id[]=4716051&fields=rating,votes&api_key=889c3f3e4b6ac67269261324

Response
[ { "id": "1807875", "internal_id": "4716051", "sku": [ "LipscoreDemo_4716051" ], "name": "LipscoreDemo HTC One M8 Gold", "brand": "HTC", "gtin": "3234567890126", "votes": 18, "rating": "4.4", "review_count": null, "reviews": [ ] } ]

GET /products/:id
Receive a single Product

Receive a single Product

Supported Formats

json

Params

Param name Description
id
required

Lipscore product ID (a product ID provided by Lipscore, not the same as internal_id)


Value:

Must be Integer

fields
optional

A comma-separated list of fields which should be returned with the product. Available: rating, votes, review_count, reviews. By default it’s empty


Value:

Must be String

api_key
required

API key (a 24 character unique code)


Value:

Must be String

Examples

GET /products/1807875&fields=rating,votes?api_key=889c3f3e4b6ac67269261324

Response
{ "id": "1807875", "internal_id": "4716051", "sku": [ "LipscoreDemo_4716051" ], "name": "LipscoreDemo HTC One M8 Gold", "brand": "HTC", "gtin": "3234567890126", "votes": 18, "rating": "4.4", "review_count": null, "reviews": [ ] }

POST /products
Create or find one or more Products

Create or find one or more Products. If you want to create multiple Products you need to use products param. This param is an Array of hashes which contain params described below (see examples).

Supported Formats

json

Params

Param name Description
internal_id
required

The products internal ID in your webshop (the product will also get a Lipscore product ID, usually referred to as “id”)


Value:

Must be String

url
required

The URL of the product details page in your webshop


Value:

Must be String

name
required

The full name of the product (not including brand name)


Value:

Must be String

brand
optional

The product brand (i.e. “Apple” for an iPhone)


Value:

Must be String

sku_values
optional

One or more Product SKU values


Value:

Must be an array of String

gtin
optional

The product GTIN.


Value:

Must be String

image_url
optional

The product image URL (full path)


Value:

Must be String

price
optional

The Product price without currency


Value:

Must be Numeric

currency
optional

The price currency


Value:

Must be String

category
optional

The product category


Value:

Must be String

fields
optional

A comma-separated list of fields which should be returned with the product. Available: rating, votes, review_count, reviews. By default it’s empty


Value:

Must be String

api_key
required

API key (a 24 character unique code)


Value:

Must be String

Examples

POST /products&fields=rating,votes?api_key=889c3f3e4b6ac67269261324

Single Product
Request
{ "internal_id": "4716051", "url": "http://mysite.com/products/htc-m8/6268A", "name": "LipscoreDemo HTC One M8 Gold", "brand": "HTC", "sku_values": [ "LipscoreDemo_4716051" ], "gtin": "3234567890126", "image_url": "http://mysite.com/images/htc-m8/6268A.png", "price": "200", "currency": "USD", "category": "smartphones" }
Response
{ "id": "1807875", "internal_id": "4716051", "sku": [ "LipscoreDemo_4716051" ], "name": "LipscoreDemo HTC One M8 Gold", "brand": "HTC", "gtin": "3234567890126", "votes": 0, "rating": "4.4", "review_count": null, "reviews": [ ], "ratings": "0.0" }
Multiple Products
Request
[ { "internal_id": "4716051", "url": "http://mysite.com/products/htc-m8/6268A", "name": "LipscoreDemo HTC One M8 Gold", "brand": "HTC", "sku_values": [ "LipscoreDemo_4716051" ], "gtin": "3234567890126", "image_url": "http://mysite.com/images/htc-m8/6268A.png", "price": "200", "currency": "USD", "category": "smartphones" } ]
Response
[ { "id": "1807875", "internal_id": "4716051", "sku": [ "LipscoreDemo_4716051" ], "name": "LipscoreDemo HTC One M8 Gold", "brand": "HTC", "gtin": "3234567890126", "votes": 0, "rating": "4.4", "review_count": null, "reviews": [ ], "ratings": "0.0" } ]