# Yotpo (v2) Information note **Yotpo extraction is supported by Stitch** This integration is powered by [Singer's](https://www.singer.io/) Yotpo tap and certified by Stitch. [Check out and contribute to the repo on GitHub](https://github.com/singer-io/tap-yotpo). For support, contact [Support](https://community.qlik.com/t5/Support/ct-p/qlikSupport). ## Yotpo integration summary Stitch’s Yotpo integration replicates data using the [Yotpo Core API](https://apidocs.yotpo.com/reference). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#schema) section for a list of objects available for replication. ## Yotpo feature snapshot A high-level look at Stitch's Yotpo (v2) integration, including release status, useful links, and the features supported in Stitch. | **STITCH** | | | | | --- | --- | --- | --- | | **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on September 20, 2019 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Stitch](https://community.qlik.com/t5/Support/ct-p/qlikSupport) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-yotpo](https://github.com/singer-io/tap-yotpo) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Remove icon

Column selection is not supported for this integration. All available columns in tables set to replicate will be selected.


Unsupported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported


Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | ## Connecting Yotpo ### Yotpo setup requirements To set up Yotpo in Stitch, you need: * **To be the Account Administrator in Yotpo.** [This is required](https://support.yotpo.com/en/article/finding-your-app-key-and-your-secret-key) to access your Yotpo API credentials. ### Step 1: Retrieve your Yotpo API credentials Information note **Note**: You must be the Yotpo Account Administrator to complete this step. 1. Sign into your [Yotpo account](https://yap.yotpo.com/#/login). 2. Click the user menu (person icon) in the top right corner. 3. Click **Account Settings**. 4. On the **Account Settings** page, click the **Store** tab. 5. Locate the **API Credentials** section: ![The API Credentials section in Yotpo, highlighted](https://help.qlik.com/en-US/stitch/images/integrations/yotpo-api-credentials.png)The API Credentials section in Yotpo, highlightedThe API Credentials section in Yotpo, highlighted 6. The **App Key** field contains your **API Key**, and the **Secret Key** is your **API Secret**. Leave this page open for now - you’ll need it to complete the next step. ### Step 2: Add Yotpo as a Stitch data source 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **Yotpo** icon. 4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination. For example, the name “Stitch Yotpo” would create a schema called `stitch_yotpo` in the destination. **Note**: Schema names cannot be changed after you save the integration. 5. In the **Yotpo API Key** field, paste the value from the **App Key** field in your Yotpo account. 6. In the **Yotpo API Secret** field, paste the value from the **Secret Key** field in your Yotpo account. ### Step 3: Define the historical replication start date The Sync Historical Data setting defines the starting date for your Yotpo integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse. Change this setting if you want to replicate data beyond Yotpo’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 4: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins. Yotpo integrations support the following replication scheduling methods: * [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only) To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage. ### Step 5: Set objects to replicate Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements). The last step is to select the tables you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#schema) **Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts. * Selection options * Individual tables * All tables For Yotpo integrations, you can select: 1. **Individual tables** 2. **All tables** Click the tabs to view instructions for each selection method. 1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate. 2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate. 3. Repeat this process for all the tables you want to replicate. 4. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections. Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature. 1. Click into the integration from the Stitch Dashboard page. 2. Click the **Tables to Replicate** tab. 3. In the list of tables, click the box next to the **Table Names** column. 4. In the menu that displays, click **Track all Tables and Fields**: ![The Track all Tables and Fields menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab 5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections. ### Initial and historical replication jobs After you finish setting up Yotpo, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page. For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.** Information note **Initial replication jobs with Anchor Scheduling** If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information. #### Free historical data loads The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## Yotpo replication Every time Stitch runs a replication job for Yotpo, the last 30 days’ worth of data will be replicated. This is applicable to all tables in the integration. Stitch replicates data in this way to account for updates made to existing records within the default attribution window of 30 days, thus ensuring you won’t make decisions based on stale (or false) data. **As a result, you may see a higher number of replicated rows than what’s being generated in Yotpo**. Setting the Replication Frequency to a higher frequency - like 30 minutes - can result in re-replicating recent data and contribute to greater row usage. Replicating fewer tables or selecting a lower frequency can help keep your row count low. Refer to the documentation for each of these tables in the next section for more info. ### Attribution window examples In the tabs below are examples of attribution windows behave during historical (initial) and ongoing replication jobs. * Historical and full re-replications * Ongoing replications For historical and full re-replications of Yotpo data, Stitch will query for and extract data newer than or equal to the date defined in the **Start Date** field in the Integration Settings page. The **Start Date**, in conjunction with the **Attribution Window**, defines the minimum date Stitch should query for when extracting historical data. This is calculated as: `Start Date - Attribution Window = Minimum Extraction Date` **Example** During the initial set up, the **Start Date** field is set to `06/03/2017`, or `June 3, 2017`. To account for the Attribution Window, Stitch would calculate the **Minimum Extraction Date** value as: `2017-07-03 00:00:00 - 30 days = 2017-06-03 00:00:00` If you were to write a SQL query using this date for the `reviews` table, it might look like this: ``` SELECT * FROM yotpo.reviews WHERE created_at >= '2017-06-03 00:00:00' /* Min. Extraction Date */ ORDER BY created_at ``` For ongoing replication jobs, Stitch will query for and extract data using the last saved maximum value in the table’s Replication Key column and the Attribution Window for the table. **Note:** This applies to every replication job that takes place after the historical replication job. **Example** The last maximum saved Replication Key value for the `reviews` table is `2017-10-01 00:00:00`. To account for the Attribution Window of 30 days, we’d subtract this from the last maximum saved Replication Key value: `2017-10-01 00:00:00 - 30 days = 2017-09-01 00:00:00` In this case, Stitch would query for and extract data that is newer than or equal to `2017-09-01 00:00:00` and older than or equal to `2017-10-01 00:00:00`. If this were a SQL query, it might look like this: ``` SELECT * FROM reviews WHERE created_at >= '2017-09-01 00:00:00' /* max Replication Key value - Attribution Window */ AND created_at <= '2017-10-01 00:00:00' /* max Replication Key value from previous job */ ORDER BY created_at ``` ## Yotpo table reference Information note **Schemas and versioning** Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing. The schema and info displayed below is for **version 2** of this integration. This is the latest version of the Yotpo integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### collections The `collections` table contains data about your store’s product groupings - collections - in your Yotpo account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | yotpo\_id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [Yotpo documentation](https://core-api.yotpo.com/reference/collections "Opens in new tab: Yotpo documentation")


[collections schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/collections.json "Opens in new tab: collections schema on GitHub")


[Yotpo API method](https://core-api.yotpo.com/reference/retrieve-collections "Opens in new tab: Yotpo API method") | collections table schema | **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 Stitch replicates data 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](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#replication) section for more info and examples of how the attribution window is used to query for data. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | email\_address

email\_sent\_timestamp | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | email\_sent\_timestamp | | **Useful links** | [Yotpo documentation](https://apidocs.yotpo.com/v1.0/reference#email-analytics-intro "Opens in new tab: Yotpo documentation")


[emails schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/emails.json "Opens in new tab: emails schema on GitHub")


[Yotpo API method](https://apidocs.yotpo.com/v1.0/reference#raw-data "Opens in new tab: Yotpo API method") | emails table foreign keys | Join emails with | on | | --- | --- | | [unsubscribers](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#unsubscribers) | ```
emails.email_address = unsubscribers.user_email
``` | emails table schema | **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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [Yotpo documentation](https://core-api.yotpo.com/reference/order-fulfillments "Opens in new tab: Yotpo documentation")


[order_fulfillments schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/order_fulfillments.json "Opens in new tab: order_fulfillments schema on GitHub")


[Yotpo API method](https://core-api.yotpo.com/reference/retrieve-order-fulfillments "Opens in new tab: Yotpo API method") | order\_fulfillments table schema | **created\_at**


DATE-TIME | | --- | | **external\_id**


STRING | | **fulfilled\_items**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand fulfilled\_items

external_product_id

STRING

quantity

INTEGER

yotpo_product_id

INTEGER

| | **fulfillment\_date**


DATE-TIME | | **id**


INTEGER | | **order\_id**


STRING | | **shipment\_info**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand shipment\_info

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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | yotpo\_id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | order\_date | | **Useful links** | [Yotpo documentation](https://core-api.yotpo.com/reference/orders "Opens in new tab: Yotpo documentation")


[orders schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/orders.json "Opens in new tab: orders schema on GitHub")


[Yotpo API method](https://core-api.yotpo.com/reference/retrieve-orders "Opens in new tab: Yotpo API method") | orders table schema | **billing\_address**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand billing\_address

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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand cancellation

cancellation_date

DATE-TIME

| | **checkout\_token**


STRING | | **created\_at**


DATE-TIME | | **currency**


STRING | | **custom\_properties**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **customer**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand customer

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. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand fulfillments

external_id

STRING

fulfilled_items

ARRAY

external_product_id

STRING

quantity

INTEGER

fulfillment_date

DATE-TIME

shipment_info

OBJECT

shipment_status

STRING

tracking_company

STRING

tracking_number

STRING

tracking_url

STRING

status

STRING

| | **landing\_site\_url**


STRING | | **line\_items**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand line\_items

coupon_code

STRING

created_at

DATE-TIME

custom_properties

OBJECT

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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand shipping\_address

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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | created\_at | | **Useful links** | [Yotpo documentation](https://apidocs.yotpo.com/reference/about-storefront-reviews "Opens in new tab: Yotpo documentation")


[product_reviews schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/product_reviews.json "Opens in new tab: product_reviews schema on GitHub")


[Yotpo API method](https://apidocs.yotpo.com/reference/retrieve-reviews-for-a-product "Opens in new tab: Yotpo API method") | product\_reviews table foreign keys | Join product\_reviews with | on | | --- | --- | | [products](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#products) | ```
product_reviews.product_id = products.yotpo_id
``` | | [reviews](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#reviews) | ```
product_reviews.source_review_id = reviews.id
``` | product\_reviews table schema | **comment**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand comment

comments_avatar

STRING

content

STRING

created_at

DATE-TIME

display_name

STRING

id

INTEGER

| | --- | | **content**


STRING | | **created\_at**


DATE-TIME | | **custom\_fields**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **deleted**


BOOLEAN | | **domain\_key**


STRING | | **id**


INTEGER | | **images\_data**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand images\_data

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. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand user

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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | yotpo\_id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [Yotpo documentation](https://core-api.yotpo.com/reference/product-variants "Opens in new tab: Yotpo documentation")


[product_variants schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/product_variants.json "Opens in new tab: product_variants schema on GitHub")


[Yotpo API method](https://core-api.yotpo.com/reference/retrieve-product-variants "Opens in new tab: Yotpo API method") | product\_variants table schema | **compare\_at\_price**


NUMBER | | --- | | **created\_at**


DATE-TIME | | **currency**


STRING | | **description**


STRING | | **external\_id**


STRING | | **gtins**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand gtins

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. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand options

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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | yotpo\_id | | **Useful links** | [Yotpo documentation](https://apidocs.yotpo.com/reference#introduction-to-products "Opens in new tab: Yotpo documentation")


[products schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/products.json "Opens in new tab: products schema on GitHub")


[Yotpo API method](https://apidocs.yotpo.com/reference#retrieve-all-products "Opens in new tab: Yotpo API method") | products table foreign keys | Join products with | on | | --- | --- | | [product_reviews](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#product-reviews) | ```
products.yotpo_id = product_reviews.product_id
``` | products table schema | **brand**


STRING | | --- | | **compare\_at\_price**


NUMBER | | **created\_at**


DATE-TIME | | **currency**


STRING | | **custom\_properties**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **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. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand gtins

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 Stitch replicates data 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](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#replication) section for more info and examples of how the attribution window is used to query for data. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [Yotpo documentation](https://apidocs.yotpo.com/reference#section-what-are-reviews "Opens in new tab: Yotpo documentation")


[reviews schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/reviews.json "Opens in new tab: reviews schema on GitHub")


[Yotpo API method](https://apidocs.yotpo.com/reference#retrieve-all-reviews "Opens in new tab: Yotpo API method") | reviews table foreign keys | Join reviews with | on | | --- | --- | | [product_reviews](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#product-reviews) | ```
reviews.id = product_reviews.source_review_id
``` | reviews table schema | **archived**


BOOLEAN | | --- | | **content**


STRING | | **created\_at**


DATE-TIME | | **deleted**


BOOLEAN | | **email**


STRING | | **escalated**


BOOLEAN | | **id**


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 [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [Yotpo documentation](https://apidocs.yotpo.com/reference#introduction-to-unsubscribers "Opens in new tab: Yotpo documentation")


[unsubscribers schema on GitHub](https://github.com/singer-io/tap-yotpo/tree/master/tap_yotpo/schemas/unsubscribers.json "Opens in new tab: unsubscribers schema on GitHub")


[Yotpo API method](https://apidocs.yotpo.com/reference#retrieve-a-list-of-unsubscribers "Opens in new tab: Yotpo API method") | unsubscribers table foreign keys | Join unsubscribers with | on | | --- | --- | | [emails](https://help.qlik.com/en-US/stitch/integrations/saas/yotpo#emails) | ```
unsubscribers.user_email = emails.email_address
``` | unsubscribers table schema | **email\_type\_id**


NUMBER | | --- | | **id**


INTEGER | | **unsubscirbed\_by\_name**


STRING | | **user\_email**


STRING |