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 (referred to as Product ID in Lipscore backend) (the product will also get a Lipscore specific product ID, usually referred to as “id”).

It is strongly recommended to use a “Parent” Product ID that is identical for all variants of the same product. By using the same ID on all variants, the average rating and list of reviews will be the same for all variants.


Value:

Must be a String

url
required

The fully qualified URL (including https://) of the product details page in your webshop.

An accurate Product URL is a requirement for displaying ratings and reviews on Google Shopping.


Value:

Must be a String

name
required

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


Value:

Must be a String

brand
recommended

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

Brand is useful for reporting purposes.


Value:

Must be a String

sku_values
recommended

One or more Product SKU values of the product variant that has been purchased


Value:

Must be an array of String

gtin
recommended

One or more Product GTIN values.

GTIN is a requirement for displaying ratings and reviews on Google Shopping.


Value:

Must be one of: String, Array.

image_url
optional

The product image URL (full path)


Value:

Must be a String

price
recommended

The Product price without currency.

The price is used for reporting purposes and for displaying in Google organic search results


Value:

Must be a Numeric

currency
recommended

The price currency.

The currency is used for reporting purposes and for displaying in Google organic search results


Value:

Must be a String

category
recommended

The product category. Can be a single category name or a hierarchy structure separated by a delimiter such as – or /

Category is required for using the Product Attributes feature, and for blocking specific categories.


Value:

Must be a 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 a String

api_key
required

API key (a 24 character unique code)


Value:

Must be a String

Examples

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

Single Product
Request
{ "internal_id": "4716051", "url": "http://mysite.com/products/lipscore-ultra-i9/6268A", "name": "Lipscore Ultra i9 SmartPhone", "brand": "Lipscore", "sku_values": [ "Lipscore_4716051", "Lipscore_4716051_Black" ], "gtin": "3234567890126", "image_url": "http://mysite.com/images/lipscore-ultra-i9/6268A.png", "price": "200", "currency": "USD", "category": "smartphones" }
Response
{ "id": "1807875", "internal_id": "4716051", "sku": [ "Lipscore_4716051", "Lipscore_4716051_Black" ], "name": "Lipscore Ultra i9 SmartPhone", "brand": "Lipscore", "gtin": "3234567890126", "urls": [ "http://mysite.com/products/lipscore-ultra-i9/6268A", "http://mysite.com/products/lipscore-ultra-i9-black/6128B" ], "votes": 0, "rating": "4.4", "review_count": null, "reviews": [ { "id": 39216, "text": "This product is great! I will be back for more, thank you!", "created_at": "2022-12-24T14:50:56.410Z", "votes_up": 1, "votes_down": 0, "video": "", "purchase_date": "2022-11-27T11:14:59.230Z", "rating": 5, "user": { "id": 56634, "name": "John Doe", "avatar_thumb_url": "https://static.lipscore.com/avatars/000/000/000/thumb_000000005936.jpg", "short_name": "John" }, "images": [ { "id": 134, "thumb_url": "https://static.lipscore.com/uploads/000/000/000/thumb_000000000134.jpg", "image_url": "https://static.lipscore.com/uploads/000/000/000/000000000134.jpg" } ], "review_reply": { "text": "Thank you!", "created_at": "2022-12-25T07:06:34.362Z", "member_site": "Demo site" }, "internal_order_id": "778203", "internal_customer_id": "84021", "internal_attr_1": "Attribute 1", "internal_attr_2": "Attribute 2", "internal_attr_3": "Attribute 3", "internal_attr_4": "Attribute 4", "internal_attr_5": "Attribute 5", "testimonial": true, "displayed_name": "John Doe" } ], "ratings": "0.0" }
Multiple Products
Request
[ { "internal_id": "4716051", "url": "http://mysite.com/products/lipscore-ultra-i9/6268A", "name": "Lipscore Ultra i9 SmartPhone", "brand": "Lipscore", "sku_values": [ "Lipscore_4716051", "Lipscore_4716051_Black" ], "gtin": "3234567890126", "image_url": "http://mysite.com/images/lipscore-ultra-i9/6268A.png", "price": "200", "currency": "USD", "category": "smartphones" } ]
Response
[ { "id": "1807875", "internal_id": "4716051", "sku": [ "Lipscore_4716051", "Lipscore_4716051_Black" ], "name": "Lipscore Ultra i9 SmartPhone", "brand": "Lipscore", "gtin": "3234567890126", "urls": [ "http://mysite.com/products/lipscore-ultra-i9/6268A", "http://mysite.com/products/lipscore-ultra-i9-black/6128B" ], "votes": 0, "rating": "4.4", "review_count": null, "reviews": [ { "id": 39216, "text": "This product is great! I will be back for more, thank you!", "created_at": "2022-12-24T14:50:56.410Z", "votes_up": 1, "votes_down": 0, "video": "", "purchase_date": "2022-11-27T11:14:59.230Z", "rating": 5, "user": { "id": 56634, "name": "John Doe", "avatar_thumb_url": "https://static.lipscore.com/avatars/000/000/000/thumb_000000005936.jpg", "short_name": "John" }, "images": [ { "id": 134, "thumb_url": "https://static.lipscore.com/uploads/000/000/000/thumb_000000000134.jpg", "image_url": "https://static.lipscore.com/uploads/000/000/000/000000000134.jpg" } ], "review_reply": { "text": "Thank you!", "created_at": "2022-12-25T07:06:34.362Z", "member_site": "Demo site" }, "internal_order_id": "778203", "internal_customer_id": "84021", "internal_attr_1": "Attribute 1", "internal_attr_2": "Attribute 2", "internal_attr_3": "Attribute 3", "internal_attr_4": "Attribute 4", "internal_attr_5": "Attribute 5", "testimonial": true, "displayed_name": "John Doe" } ], "ratings": "0.0" } ]