Skip to main content

Yotpo Component

You can integrate Commerce with Yotpo enabling your customers to provide ratings and reviews in the storefront for the products they purchased. You can also sync the customer feedback with any search provider that you use; this displays the average customer ratings and reviews received for a product in the storefront.

Connections

You need the following to interact with Yotpo.

  • Token URL: The API token URL of your Yotpo account. By default, the value is https://api.yotpo.com/oauth/token.
  • Client ID: Your Yotpo Client ID. In Yotpo, it might be mentioned as Store ID or App ID.
  • Client Secret: Your Yotpo Client Secret.

Actions

The component has the following actions.

Get review by ID

InputTypeDescription
ConnectionconnectionYotpo connection.
Review IDstringA unique identifier of a review.
Log LevelstringThe level of logging.

Get product by externl ID

InputTypeDescription
ConnectionconnectionYotpo connection.
External IDsstringA unique external ID.
Log LevelstringThe level of logging.

Create product

InputTypeDescription
ConnectionconnectionYotpo connection.
Product RequestdynamicfieldselectionThe products to create.
Log LevelstringThe level of logging.

Update a Product

InputTypeDescription
ConnectionconnectionYotpo connection.
Product RequestdynamicfieldselectionThe products to update.
Log LevelstringThe level of logging.

Get a variant by external ID

InputTypeDescription
ConnectionconnectionYotpo connection.
Product IdstringThe unique identifier of the product.
External IdsstringThe external IDs whose vairants you want retrieve.
Log LevelstringThe level of logging.

Create a variant

InputTypeDescription
ConnectionconnectionYotpo connection.
Product IdstringThe unique identifier of the product.
Variant RequestdynamicfieldselectionThe variants you want to create.
Log LevelstringThe level of logging.

Update a variant

InputTypeDescription
ConnectionconnectionYotpo connection.
Product IdstringThe unique identifier of the product.
Variant IdstringThe unique identifier of the variant.
Variant RequestdynamicfieldselectionThe variants you want to update.
Log LevelstringThe level of logging.

Get product review summary by external ID

InputTypeDescription
ConnectionconnectionYotpo Connection.
Product IdstringThe unique identifier of the product.
Log LevelstringThe level of logging.

Get webhook

InputTypeDescription
ConnectionconnectionYotpo connection.
Log LevelstringThe level of logging.

Create webhook

InputTypeDescription
ConnectionconnectionYotpo connection.
Event NamestringThe event name.
Webhook URLstringThe URL of the webhook to be displayed in Integrations Hub when an integration is active.
Log LevelstringThe level of logging.

Update webhook

InputTypeDescription
ConnectionconnectionYotpo connection.
Event NamestringThe event name.
Webhook URLstringThe URL of the webhook to be displayed in Integrations Hub when an integration is active.
Webhook IDstringThe ID of the webhook to be displayed in Integrations Hub when an integration is active.
Log LevelstringThe level of logging.

Get order by external ID

InputTypeDescription
ConnectionconnectionYotpo connection.
External IDsstringThe external Ids of the orders you want to retrieve.
Log LevelstringThe level of logging.

Create order

InputTypeDescription
ConnectionconnectionYotpo connection.
Order RequestdynamicfieldselectionThe order that you want to create.
Log LevelstringThe level of logging.

Update order

InputTypeDescription
ConnectionconnectionYotpo connection.
Order RequestdynamicfieldselectionThe order that you want to update.
Order IdstringThe unique identifier of the order.
Log LevelstringThe level of logging.

Upsert customer

InputTypeDescription
ConnectionconnectionYotpo connection.
Customer RequestdynamicfieldselectionThe customer you want to upsert.
Log LevelstringThe level of logging.