Sdílet prostřednictvím

Dynamics 365 Commerce - Ratings and Reviews

  • Reference

Utilize Dynamics 365 Commerce Ratings and Reviews APIs to import new reviews, export existing reviews, and more!

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Dynamics 365 Commerce-Ratings and Reviews
URL https://dynamics.microsoft.com/en-us/support/
Email d365ratingreviewconn@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://dynamics.microsoft.com/en-us/commerce/overview/
Privacy policy https://privacy.microsoft.com/privacystatement
Categories Commerce;Business Management

The Dynamics 365 Commerce - Ratings and Reviews connector provides a set of actions to interact with the Dynamics 365 Ratings and Review Service APIs. These actions facilitate importing and exporting of reviews data. Two actions are available: Export All Reviews and Submit a Review.

Prerequisites

You will need the following to proceed:

  • Microsoft Dynamics 365 Commerce subscription
  • Enabled Ratings and Reviews solution Details

Contact a Dynamics 365 Commerce partner here for details on how to get started with Microsoft Dynamics 365.

How to get credentials

The first step is to register the connector as an application in Microsoft Entra ID. This allows the connector to identify itself to Microsoft Entra ID and ask for permissions to access Ratings and Reviews data on behalf of the end user. Read more about this here and follow the steps below:

1. Create an Microsoft Entra ID application:

This Microsoft Entra ID application will be used to identify the connector connection to Ratings and Reviews. This can be done using Azure Portal, by following the steps here to register an app on Microsoft Entra ID and enable authentication.

During registration, capture the following information, as it will be used to establish an authenticated connection with the connector using service principal:

  • Client Application ID
  • Client Secret (remember to note this down, as it is only shown once).
  • Client directory (tenant) ID.

With the Microsoft Entra ID application created, it can now be used to get permissions from end users. Use the fields you have saved to establish an authenticated connection via service principal using the Dynamics 365 Commerce - Ratings and Reviews Connector.

The next step is to register this app in the Ratings and Reviews moderation tool settings page.

2. Register the Microsoft Entra ID Application in the Ratings and Reviews Moderation Tool

In order for the Ratings and Reviews service to authenticate operations coming from the connector, clients must register their Microsoft Entra ID app within the Ratings and Review moderation tool settings page. Use the Client application ID and the Client directory ID from the previous step to add a Service to Service (S2S) application entry. For more details on how to manage Ratings and Reviews settings from the Moderation Tool, refer here.

Get started with your connector

To get started with the Dynamics 365 Commerce - Ratings and Reviews Connector, simply add it an existing flow, or start with searching up our sample template flows for import and export of reviews.

Note: The Dynamics 365 Commerce - Ratings and Reviews Connector will be available in all Power Automate regions, but Ratings and Reviews will only process calls in regions supported for your tenant. Be sure to review compliance requirements for your organization and create the Power Automate environment in a region that fits compliance needs.

FAQ

  • What is the maximum length of a review text body and review title?

    The maximum length of a review title is 55 characters. The maximum length of the review text body is 1,000 characters.

  • What is the structure of the encodedUser parameter in the Submit Review action?

    The encodedUser adds additional security in order to pass user information. It encodes a user identity schema to base64. Refer to the schema structure below to compose the object in your flow, and then use the built in toBase64() function to encode it before passing it in the SubmitReview action.

    {
    "p" : {
            "t" : "Unix epoch in seconds (should be within an hour of current time)",
            "email" : "Reviewer User Email Here",
            "name" : "Reviewer User Name Here",
            "id" : "Reviewer User Id Here"
        }
}

    For more details, check out an example of this in our import reviews template flow.

  • I need more support. Who can I reach out to?

    Contact Dynamics 365 Commerce support for general support or email d365ratingreviewconn@microsoft.com.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Export All Reviews

Export all reviews as a downloadable SAS URL.
Submit User Review

Submits a user review to your RnR tenant.

Export All Reviews

Operation ID:
ExportReviews

Export all reviews as a downloadable SAS URL.

Parameters

Name Key Required Type Description
RnR Tenant ID
 tenantId True string

Specify the ID of your RnR tenant.

Returns

Body
ExportSuccessfulResponse

Submit User Review

Operation ID:
SubmitReview

Submits a user review to your RnR tenant.

Parameters

Name Key Required Type Description
Product ID
 productId True string

Specify the ID of product being reviewed.
RnR Tenant ID
 tenantId True string

Specify the ID of your RnR tenant.
Channel ID
 channelId string

Specify the ID of the channel for this review.
Market
 market string

Specify the market associated with this review.
Locale
 locale True string

Specify the Locale associated with this review.
encodedUser
 encodedUser True string

Specify base64 encoded user info string associated with this review. See documentation for JSON block format containing the user name, email, and Id.
Rating
 Rating True string

Specify the rating of the review as an integer.
Title
 Title True string

Specify the title of the review.
ReviewText
 ReviewText True string

Specify the text body of the review.
Sku
 Sku string

Specify the SKU number of the reviewed product.
ProductName
 ProductName True string

Specify the name of the reviewed product
LegalEntity
 LegalEntity string

Specify the legal entity.
ExtendedProperties
 ExtendedProperties object

Specify any additional review properties as key-value pairs. See documentation for JSON format.
submittedDateTime
 submittedDateTime string

Specify the submitted datetime of your review in UTC format (default is current UTC time).

Returns

The Review ID of the submitted review.

response
SubmitReviewResponse

Definitions

SubmitReviewResponse

The Review ID of the submitted review.

The Review ID of the submitted review.

ReviewID
string

ExportSuccessfulResponse

Name Path Type Description
Blob SAS Url
 blobSasUrl string

The SAS URL generated from blob storage.
Date Expires
 expires string

Date when SAS URL expires.
Date Created
 created string

Date when SAS URL was created.