Articles in this section

Available Yotpo APIs

When you configure an export, import, other type of flow step using the prebuilt Yotpo connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Yotpo API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Actions

Record a customer action

X

Adjust a customer's point balance

X

Remove a customer from an action based VIP tier

X

Aggregated order info

Send aggregated order info

X

Campaigns

Get active campaigns

X

Collections

Create collection

X

Update collection

X

Retrieve collections

X

Add product to collection

X

Retrieve products in collection

X

Remove product from collection

X

Retrieve list of collections for product

X

Customers

Create or update customer

X

Retrieve customers

X

Create or update custom customer event

X

Create/update customer records

X

Set customer birthday

X

Set/update customer anniversary

X

Get customer anniversary

X

Remove customer anniversary

X

Fetch customer details

X

Fetch all recently updated customers

X

Dynamic coupons

Delete a dynamic coupon action's codes

X

Retrieve all dynamic coupon codes

X

Retrieve dynamic coupon code statistics

X

Upload dynamic coupon codes

X

Email analytics

Email analytics

X

Overview

X

Raw data

X

Export email analytics

X

Insights

Topics

X

Reviews per topic

X

Products

X

Reviews per product

X

Product collections

X

Order fulfillments

Create order fulfillment

X

Update order fulfillment

X

Retrieve order fulfillments

X

Retrieve fulfillment by ID

X

Orders

Create order

X

Create mass orders

X

Retrieve orders

X

Invalidate order

X

Create order

X

Update order

X

Retrieve orders

X

Retrieve order by ID

X

Create order

X

Point redemptions

Create redemption

X

Approve redemption cancellation

X

Privacy

Data exists

X

User data

X

Data exists

X

User data

X

Anonymize user

X

Product grouping

Create product group

X

Retrieve product groups for account

X

Retrieve details for a specific product group

X

Add/remove products

X

Delete a product group

X

Product variants

Create product variant

X

Update product variant

X

Retrieve product variants

X

Retrieve product variant by ID

X

Products

Create mass products

X

Retrieve all products

X

Retrieve promoted products

X

Update mass products

X

Create product

X

Update product

X

Retrieve products

X

Retrieve product by ID

X

Questions and answers (Q&A)

Retrieve Q&A for a product

X

Retrieve the bottom line for Q&A

X

Retrieve all questions

X

Create an answer to a question

X

Create question (without confirmation email)

X

Create question (with confirmation email)

X

Vote on answers

X

Redemption options

Upload coupon codes

X

Get active redemption options

X

Get redemption code data

X

Referrals

Identify referrer

X

Send referral emails

X

Refunds

Create refund

X

Reviews: Merchant

Retrieve all reviews

X

Retrieve a review by review ID

X

Retrieve bottom line (total reviews and average score) for a specific product

X

Retrieve bottom line (total reviews and average score) for all products

X

Retrieve bottom line (total reviews and average score) for all site reviews

X

Create review

X

Create review (synchronous)

X

Upload images with reviews via API

X

Retrieve reviews for a user using external user reference ID

X

Update incentivized reviews by review ID

X

Reviews: Storefront

Retrieve reviews for a product

X

Retrieve widget site reviews

X

Upvote or downvote reviews

X

Top mentioned topics

X

Search reviews

X

Product level data

X

All bottom line

X

Reviews metadata

Add metadata to existing review

X

Get review metadata

X

Retrieve review filters and values

X

Update existing review metadata

X

Rich content

Top three 5-star reviews

X

SEO

Find if your yotpo.me subdomain is available

X

Retrieve your reviews.me URL

X

Unsubscribers

Remove a set of email addresses from email distribution lists

X

Re-add email addresses to email distribution lists

X

Retrieve a list of unsubscribers

X

VIP tiers

Fetch VIP tiers

X

Visual UGC

Import images

X

Import videos

X

Get media

X

Custom albums

X

Photos by album

X

Product images

X

Video upload errors

X

Webhooks

Create target

X

Retrieve targets

X

Retrieve target by ID

X

Update target

X

Delete target

X

Create filter

X

Retrieve filters

X

Retrieve filter by ID

X

Update filter

X

Delete filter

X

Create subscription

X

Retrieve subscriptions

X

Retrieve subscription by ID

X

Update subscription

X

Delete subscription

X