COMMERCE SERVICES
/
Product Service
/
Reviews
/
Insert product review

Norce Commerce Product v1.1 service (1.1)

The Product namespace has Entities and Operations used for Products and other related Entities such as Prices, Filters, Categories etc. The main use of the Product service is to retrieve product data, variants, prices, and its availability to be used in a webshop or other sales channels. The Product service is read only and does not support creating or updating data in Norce. For this, use the Connect API.

Download OpenAPI description
openapi-v1.json
openapi-v1.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Assortments

Contains endpoints for viewing metadata about assortment types, not commonly used anymore, still in use by legacy systems.

Operations

Categories

Contains endpoints for looking up category metadata.

Operations

Configurations

Contains endpoints for working with configuration products, not currently in use.

Operations

Families

Contains endpoints for viewing product family metadata, not commonly used anymore, but still needed in legacy systems.

Operations

Files

Contains endpoints for viewing file and image metadata.

Operations

Filters

Contains endpoints for working with ProductFilter navigations. Read more about it here.

Operations

Flags

Contains endpoints for viewing product flag metadata.

Operations

InfoTypes

Contains endpoints for viewing product related extended fields, info types.

Operations

Manufacturers

Contains endpoints for viewing manufacturer information.

Operations

Navigation

Contains endpoints for viewing navigation nodes, not commonly used anymore, still in use by legacy systems.

Operations

OnHand

Contains endpoints for looking up detailed availability information.

Operations

Parametric

Contains endpoints for viewing parametric meta data and parametric data used in comparison views.

Operations

PriceLists

Contains endpoints for viewing price list data and metadata.

Operations

Products

Contains endpoints for listing, finding and viewing products, variants and its content. Read more about this here and here

Operations

Promotions

Contains endpoints for listing products based on promotion associations.

Operations

Relations

Contains endpoints for listing products based on their relations and relation metadata.

Operations

Reviews

Contains endpoints for managing product reviews, not commonly used anymore, still in use by legacy systems.

Operations

Insert product review

Request

Inserts a product review and returns the new list. Likes and Dislikes will be set to zero.

Query
cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Bodyapplication/json

The actual Review to insert. Likes and Dislikes will be ignored and set to zero.

Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger or null(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring or null

The name of the reviewer.

Emailstring or null

The email address of the reviewer.

Textstring or null

The review text.

Urlstring or null

A Url to some external source referenced by the reviewer.

ImagePathstring or null

A Url to some external image uploaded by the reviewer.

Scorenumber or null(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring or null(date-time)

The date of the review.

Likesinteger or null(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger or null(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/InsertProductReview \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger or null(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring or null

The name of the reviewer.

Emailstring or null

The email address of the reviewer.

Textstring or null

The review text.

Urlstring or null

A Url to some external source referenced by the reviewer.

ImagePathstring or null

A Url to some external image uploaded by the reviewer.

Scorenumber or null(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring or null(date-time)

The date of the review.

Likesinteger or null(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger or null(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
application/json
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

Update product review likes

Request

Updates likes/dislikes on review.

Query
productIdinteger(int32)

Product internal id of the review.

reviewIdinteger(int32)

The internal id of the review to like/dislike.

doLikeboolean

True or false depending on like or dislike.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/UpdateProductReviewLikes \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger or null(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring or null

The name of the reviewer.

Emailstring or null

The email address of the reviewer.

Textstring or null

The review text.

Urlstring or null

A Url to some external source referenced by the reviewer.

ImagePathstring or null

A Url to some external image uploaded by the reviewer.

Scorenumber or null(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring or null(date-time)

The date of the review.

Likesinteger or null(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger or null(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
application/json
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

List product reviews

Request

Lists reviews for a product. Only published Reviews will be listed.

Query
productIdinteger(int32)

The internal id of the product for which reviews are listed.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/ListProductReviews \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger or null(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring or null

The name of the reviewer.

Emailstring or null

The email address of the reviewer.

Textstring or null

The review text.

Urlstring or null

A Url to some external source referenced by the reviewer.

ImagePathstring or null

A Url to some external image uploaded by the reviewer.

Scorenumber or null(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring or null(date-time)

The date of the review.

Likesinteger or null(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger or null(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
application/json
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

List all product reviews

Request

Lists all reviews for all products. Only published Reviews will be listed.

Query
cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/product/1.1/ListProductReviewsAll \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger or null(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring or null

The name of the reviewer.

Emailstring or null

The email address of the reviewer.

Textstring or null

The review text.

Urlstring or null

A Url to some external source referenced by the reviewer.

ImagePathstring or null

A Url to some external image uploaded by the reviewer.

Scorenumber or null(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring or null(date-time)

The date of the review.

Likesinteger or null(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger or null(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
application/json
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

SkuTypes

Contains endpoints for looking up product type metadata.

Operations

Status

Contains endpoints for looking up product status metadata.

Operations

Variants

Contains endpoints for listing variants.

Operations

Warehouses

Contains endpoints for viewing warehouse and location information.

Operations

Schemas