Yotpo

Yotpo is a cloud-based content marketing platform for e-commerce businesses. It lets users collect user-generated content and use the content to build a brand and manage the customer experience.

For more information about the API, see Yotpo Core API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling CDC for replication tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To obtain the API key and secret:

Make sure you are an Yotpo account administrator. The API secret is only visible to this role.
Log into your Yotpo account.
Click the Profile icon in the top-right corner.
Go to Account Settings > General Settings.
Locate the API Credentials section:
The App Key field contains your API Key, and the Secret Key is your API Secret.
Copy and paste these values into the corresponding fields.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
API Key	API key.
API Secret	API secret.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 2.

Depending on your destination, table and column names may not appear as they are outlined below.

collections

The collections table contains data about your store’s product groupings - collections - in your Yotpo account.

Replication Method	CDC
Primary Key	yotpo_id
Replication Key	updated_at
Useful links	Yotpo documentation Yotpo API method

created_at

DATE-TIME

external_id

STRING

name

STRING

updated_at

DATE-TIME

yotpo_id

INTEGER

emails

The emails table contains data about every email sent from Yotpo.

Attribution window

When data is replicated for this table, it will use an attribution window of 30 days to fetch updated email statistics such as opens, clicks, etc. This means that every time a replication job runs, the last 30 days’ worth of data will be replicated for this table.

Refer to the Replication section for more info and examples of how the attribution window is used to query for data.

Replication Method	CDC
Primary Keys	email_address email_sent_timestamp
Replication Key	email_sent_timestamp
Useful links	Yotpo documentation Yotpo API method

Join emails with	on
unsubscribers	emails.email_address = unsubscribers.user_email

arrived_early_timestamp

DATE-TIME

clicked_through_timestamp

DATE-TIME

content_creation_timestamp

DATE-TIME

coupon_code

STRING

email_address

STRING

email_sent_timestamp

DATE-TIME

email_type

STRING

failed_timestamp

DATE-TIME

invalid_address_timestamp

DATE-TIME

marked_spam_timestamp

DATE-TIME

opened_timestamp

DATE-TIME

order_id

STRING

order_timestamp

DATE-TIME

platform

STRING

product_id

STRING

reminder_num

NUMBER

review_form

STRING

review_type

STRING

sku

STRING

trr_bundle_id

STRING

trr_bundle_subject

STRING

unsubscribed_timestamp

DATE-TIME

order_fulfillments

The order_fulfillments table contains data about fulfilled store orders in your Yotpo account.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Yotpo documentation Yotpo API method

created_at

DATE-TIME

external_id

STRING

fulfilled_items

ARRAY

This is a nested data structure:

external_product_id: STRING
quantity: INTEGER
yotpo_product_id: INTEGER

fulfillment_date

DATE-TIME

INTEGER

order_id

STRING

shipment_info

OBJECT

This is a nested data structure:

shipment_status: STRING
tracking_company: STRING
tracking_number: STRING
tracking_url: STRING

status

STRING

updated_at

DATE-TIME

orders

The orders table contains data about orders in your Yotpo account.

Replication Method	CDC
Primary Key	yotpo_id
Replication Key	order_date
Useful links	Yotpo documentation Yotpo API method

billing_address

OBJECT

This is a nested data structure:

address1: STRING
address2: STRING
city: STRING
company: STRING
country_code: STRING
phone_number: STRING
province_code: STRING
state: STRING
zip: STRING

cancellation

OBJECT

This is a nested data structure: cancellation_date, DATE-TIME

checkout_token

STRING

created_at

DATE-TIME

currency

STRING

custom_properties

OBJECT

customer

OBJECT

This is a nested data structure:

accepts_email_marketing: STRING
accepts_sms_marketing: STRING
custom_properties: OBJECT
email: STRING
external_id: STRING
first_name: STRING
last_name: STRING
phone_number: STRING

external_id

STRING

fulfillments

ARRAY

This is a nested data structure:

external_id: STRING
fulfilled_items: ARRAY, which is also a nested data structure.
- external_product_id: STRING
- quantity: INTEGER
fulfillment_date: DATE-TIME
shipment_info: OBJECT, which is also a nested data structure.
- shipment_status: STRING
- tracking_company: STRING
- tracking_number: STRING
- tracking_url: STRING

landing_site_url

STRING

line_items

ARRAY

This is a nested data structure:

coupon_code: STRING
created_at: DATE-TIME
custom_properties: OBJECT, which is also a nested data structure.
- external_product_id: STRING
- product_id: STRING
- quantity: INTEGER
- subtotal_price: NUMBER
- total_price: NUMBER
- updated_at: DATE-TIME
- yotpo_id: INTEGER

order_date

DATE-TIME

order_name

STRING

payment_method

STRING

payment_status

STRING

shipping_address

OBJECT

This is a nested data structure:

address1: STRING
address2: STRING
city: STRING
company: STRING
country_code: STRING
phone_number: STRING
province_code: STRING
state: STRING
zip: STRING

source

STRING

subtotal_price

NUMBER

total_price

NUMBER

updated_at

DATE-TIME

yotpo_id

INTEGER

product_reviews

The product_reviews table contains data about reviews for a certain product.

Note: This table is similar to the reviews table, but also contains custom fields. If you don’t have or need custom product fields, you may only want to replicate the reviews table to prevent redundant data.

Replication Method	CDC
Primary Key	id
Replication Key	created_at
Useful links	Yotpo documentation Yotpo API method

Join product_reviews with	on
products	product_reviews.product_id = products.yotpo_id
reviews	product_reviews.source_review_id = reviews.id

comment

OBJECT

This is a nested data structure:

comments_avatar: STRING
content: STRING
created_at: DATE-TIME
display_name: STRING
id: INTEGER

content

STRING

created_at

DATE-TIME

custom_fields

OBJECT

deleted

BOOLEAN

domain_key

STRING

INTEGER

images_data

ARRAY

This is a nested data structure:

id: INTEGER
original_url: STRING
thumb_url: STRING

name

STRING

product_id

INTEGER

product_yotpo_id

STRING

score

NUMBER

sentiment

NUMBER

source_review_id

NUMBER

title

STRING

user

OBJECT

This is a nested data structure:

display_name: STRING
is_social_connected: NUMBER
social_image: STRING
user_id: INTEGER
user_type: STRING

verified_buyer

BOOLEAN

votes_down

INTEGER

votes_up

INTEGER

product_variants

The product_variants table contains data about product variations in your Yotpo account.

Replication Method	CDC
Primary Key	yotpo_id
Replication Key	updated_at
Useful links	Yotpo documentation Yotpo API method

compare_at_price

NUMBER

created_at

DATE-TIME

currency

STRING

description

STRING

external_id

STRING

gtins

ARRAY

This is a nested data structure:

declared_type: STRING
value: STRING

image_url

STRING

inventory_quantity

INTEGER

is_discontinued

BOOLEAN

is_valid_url_format

BOOLEAN

name

STRING

options

ARRAY

This is a nested data structure:

name: STRING
value: STRING

price

NUMBER

sku

STRING

updated_at

DATE-TIME

url

STRING

yotpo_id

INTEGER

yotpo_product_id

INTEGER

products

The products table contains data about products in your Yotpo account.

Replication Method

Full Table

Primary Key

yotpo_id

Useful links

Yotpo documentation

Yotpo API method

Join products with	on
product_reviews	products.yotpo_id = product_reviews.product_id

brand

STRING

compare_at_price

NUMBER

created_at

DATE-TIME

currency

STRING

custom_properties

OBJECT

description

STRING

external_created_at

DATE-TIME

external_id

STRING

external_updated_at

DATE-TIME

group_name

STRING

gtins

ARRAY

This is a nested data structure:

declared_type: STRING
detected_type: STRING
value: STRING

handle

STRING

image_url

STRING

inventory_quantity

INTEGER

is_discontinued

BOOLEAN

is_valid_url_format

BOOLEAN

mpn

STRING

name

STRING

price

NUMBER

sku

STRING

status

STRING

updated_at

DATE-TIME

url

STRING

yotpo_id

INTEGER

reviews

The reviews table contains data about reviews.

Note: This table is similar to the product_reviews table, but doesn’t contain custom fields. If you have or need custom fields, you may want to only replicate the product_reviews table to prevent redundant data.

Attribution window

When data is replicated for this table, it will use an attribution window of 30 days to fetch updated (or deleted) reviews. This means that every time a replication job runs, the last 30 days’ worth of data will be replicated for this table.

Refer to the Replication section for more info and examples of how the attribution window is used to query for data.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Yotpo documentation Yotpo API method

Join reviews with	on
product_reviews	reviews.id = product_reviews.source_review_id

archived

BOOLEAN

content

STRING

created_at

DATE-TIME

deleted

BOOLEAN

email

STRING

escalated

BOOLEAN

INTEGER

name

STRING

reviewer_type

STRING

score

NUMBER

sentiment

NUMBER

sku

STRING

title

STRING

updated_at

DATE-TIME

user_reference

STRING

votes_down

NUMBER

votes_up

NUMBER

unsubscribers

The unsubscribers table contains data about customers who unsubscribed from one of Yotpo’s emails.

Replication Method

Full Table

Primary Key

Useful links

Yotpo documentation

Yotpo API method

Join unsubscribers with	on
emails	unsubscribers.user_email = emails.email_address

email_type_id

NUMBER

INTEGER

unsubscirbed_by_name

STRING

user_email

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here