Create Review Synchronous

Create review (synchronous)

POST/reviews/dynamic_create

Use it in a workflow

Add a step and choose the Yotpo connector.
Pick the Create Review Synchronous action (under Reviews & Ratings).
Fill in the fields below, then reference the result from later steps as {{createReviewSynchronous.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

appkeystringrequired

The store ID

domainstring

The account domain

skustringrequired

The ID of the product on your site. This parameter supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters.

product_titlestringrequired

The title of the product

product_descriptionstring

The description of the product

product_urlstring

The url of the product on your ecommerce site

product_image_urlstring

The url of the product image

display_namestringrequired

The name of the reviewer

emailstringrequired

The email of the reviewer

is_incentivizedboolean

Indicates if the review comes from an incentivized source (for example, a product sampling company)

review_contentstringrequired

The content of the review

review_titlestringrequired

The title of the review

review_scorestringrequired

The review score

signaturestring

Relevant only for customers using the Trusted Vendors feature. The signature is the hexadecimal representation of a computed Hash-based Message Authentication Code, using SHA256 as the cryptographic function (HMAC-SHA256). The secret for the function is the account secret.

time_stampstring

Required for customers using the Trusted Vendors feature. Unix timestamp.

submission_time_stampstring

Relevant only for customers using the Trusted Vendors feature. The date the review was created (if not today). Can be up to 7 days in the past. If you want to add a creation date that is more than 7 days in the past, please contact support

reviewer_typestring

Required for customers using the Trusted Vendors feature. Possible values: `verified_buyer` or `verified_reviewer`

delivery_typestring

The type of delivery designated for this purchase e.g. express, expedited, standard

user_referencestring

External user id, can be used later on to retrieve reviews associated with this user

image_urlsarray<string>

The URLs of images associated with the review. You can upload up to 5 images per review.

order_metadataobject

coupon_usedboolean

Part of `order_metadata`, indicates whether a coupon was used at purchase

namestring

The name of an order-related custom property e.g. order history

valuestring

The order-related `custom_properties` value

product_metadataobject

colorstring

The color of the item

sizestring

The size of the item

materialstring

The material the product is made of

modelstring

The model name of the product

vendorstring

The product vendor

coupon_usedstring

Whether a coupon was used for this product

custom_propertiesobject2 fields

customer_metadataobject

statestring

The state the customer is located in

countrystring

Two-letter uppercase country code indicating the customer country. To comply with Google Seller Ratings conventions, the country code value must be from [this list](https://datahub.io/core/country-list) of compatible codes. Default value: `US`.

addressstring

The customer's address

phone_numberstring

The customer's phone number

custom_propertiesobject2 fields

json

{
  "appkey": "string",
  "sku": "string",
  "product_title": "string",
  "display_name": "string",
  "email": "string",
  "review_content": "string",
  "review_title": "string",
  "review_score": "string",
  "domain": "string",
  "product_description": "string",
  "product_url": "string",
  "product_image_url": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{createReviewSynchronous.response.data.<field>}}.

statusobject

codeinteger

Default 0

messagestring

responseobject

reviewsarray<object>21 fields

json

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "response": {
    "reviews": [
      {
        "id": 2557878,
        "content": "It&#x27;s really good",
        "title": "Great Phone",
        "score": 5,
        "user": {
          "id": 1597310,
          "display_name": "John S.",
          "slug": "john-s--1103",
          "social_image": "https://ddcfq0gxiontw.cloudfront.net/images/anonymous_user.png",
          "is_social_connected": false,
          "bio": null,
          "score": 0,
          "badges": [
            null
          ]
        },
        "user_type": "User",
        "users": [
          null
        ],
        "products": [
          {
            "Location_idx": [
              null
            ],
            "Product": {
              "product_url": null,
              "id": null,
              "name": null,
              "slug": null,
              "shorten_url": null,
              "images": null,
              "social_network_links": null,
              "facebook_testemonials_page_product_url": null
            }
          }
        ],
        "votes_up": 0,
        "votes_down": 0,
        "user_vote": 0,
        "created_at": "2014-12-10T15:03:16Z"
      }
    ]
  }
}

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.

Was this page helpful?