younifyd
Menu

Get Review Metadata By Review Id

Get review metadata

GET/v1/apps/{app_key}/reviews/{review_id}/metadata?utoken=utoken

Use it in a workflow

  1. Add a step and choose the Yotpo connector.
  2. Pick the Get Review Metadata By Review Id action (under Reviews & Ratings).
  3. Fill in the fields below, then reference the result from later steps as {{getReviewMetadataByReviewId.response.data}}.

Request

Path parameters

app_keystringrequired

The store ID

review_idstringrequired

The unique review identifier

Query parameters

utokenstringrequired

Your Yotpo account access token. See [Yotpo Authentication](https://apidocs.yotpo.com/reference#yotpo-authentication) to learn how to generate your utoken.

Response

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

orderobject
datestring
external_order_idstring
delivery_typestring
customerobject
emailstring
addressstring
phone_numberstring
statestring
countrystring
productobject
urlstring
namestring
descriptionstring
sizestring
json
{
  "order": {
    "date": "2018-11-14 00:00:00",
    "external_order_id": "1",
    "delivery_type": "express"
  },
  "customer": {
    "email": "laura-nolan@staging.yotpo.com",
    "address": "15th av.",
    "phone_number": "+01 56784392",
    "state": "New York",
    "country": "US"
  },
  "product": {
    "url": "http://oga.name/product",
    "name": "Power Bracket",
    "description": "Labore aut quia facilis enim.",
    "size": "large"
  }
}

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