Last update: April 22, 2024

REST API¶

Access the REST API endpoint and select VirtoCommerce.CustomerReviews from the dropdown list.

Select Customer Reviews

Below are some examples of using REST API functionality to:

Submit Reviews¶

Select POST /api/customer reviews from the menu.

Fill in the request body as follows:

[
  {
    "storeId": "Electronics",
    "userId": "test_user_id",
    "userName": "Alex B.",
    "EntityId": "baa4931161214690ad51c50787b1ed94",
    "EntityType": "Product",
    "EntityName": "Aunkler's Favorite Product",
    "title": "Demo Product Review",
    "review": "Nice Product. I liked it",
    "rating": 5
  }
]

Click Execute.
In the platform, select Rating and Reviews from the main menu.
In the next blade, click on the newly created review:

View Reviews¶

Select POST /api/customer reviews/reviewList from the menu.

Fill in the request body as follows:

{
    "reviewStatus":null,
    "sort":"",
    "take":20,
    "skip":0
}

Click Execute to receive the following response:

{
    "totalCount":7,
    "results":[
        {
            "id":"fc9a07db-f09f-4a85-bafc-f5e9299d3301",
            "entityId":"8c01bcf0-4bab-4675-97b9-ea6cc41912e5",
            "entityName":"Aunkler's Favorite Product",
            "entityType":"Product",
            "reviewStatus":"Approved",
            "reviewStatusId":1,
            "title": "Demo Product Review",
            "review": "Nice Product. I liked it",
            "rating":5,
            "userName":"Alex B.",
            "storeName":"Electronics",
            "createdDate":"2022-10-04T03:46:43.433Z"
        },
        {...}
    ]
}

Request Rating¶

Select POST /api/rating/entityRating from the menu.

Fill in the request body as follows:

{
    "entityIds": [
        "8c01bcf0-4bab-4675-97b9-ea6cc41912e5"
    ],
    "entityType":"Product"
}

Click Execute to receive the following response:

[
    {
        "storeName":"Electronics",
        "storeId":"Electronics",
        "entityId":"8c01bcf0-4bab-4675-97b9-ea6cc41912e5",
        "entityType":"Product",
        "value":3.50,
        "reviewCount":2
    }
]

Moderate Reviews¶

ApproveRejectResetDelete

Select POST /api/customerReviews/approve from the menu.

Fill in the request body as follows:

[
    "fc9a07db-f09f-4a85-bafc-f5e9299d3301"
]

Click Execute.

Select POST /api/customerReviews/reject from the menu.

Fill in the request body as follows:

[
    "fc9a07db-f09f-4a85-bafc-f5e9299d3301"
]

Click Execute.

Select POST /api/customerReviews/reset from the menu.

Fill in the request body as follows:

[
    "fc9a07db-f09f-4a85-bafc-f5e9299d3301"
]

Click Execute.

Select DELETE /api/customerReviews from the menu.

Fill in the request body as follows:

{
    "ids":
    [
        "fc9a07db-f09f-4a85-bafc-f5e9299d3301"
    ]
}

Click Execute.