Getting Started

Subsequent Request

Subsequent Request is an API request made in addition to the initial request. A subsequent request uses a value from the initial response to request additional data. This additional request may use

Create Unique Primary ID

Creating a unique primary ID is an optional process. This is only used if the source of your data does not already provide a static unique ID. What is a Unique Primary ID? A unique primary ID is

Google Sheets

Connecting Google Sheets to your WP Data Sync API portal can be accomplished in a few easy steps. In this tutorial, we assume you have already created a Google Sheet and connected your website to the

Output Behavior

Output Behavior is how the API handles the output of your Data Source. Output Behavior Options Create ItemsAccelerated SyncMerge with Existing ItemsBypass Existing Items Create

Sync Status

Sync Status is a setting that allows you to choose which items you want to sync with your remote website. There are several options you can choose from to configure your API portal to manage sync

Conditional Logic

Conditional Logic enables the WP Data Sync API to manipulate your raw data based on a set of conditions. Conditions are defined in Global Settings. You can configure as many conditions as

Prefix URL

A prefix URL is used when only the name of an images is provided from your data source. This setting is optional and should only be used as needed. Example Array with Image Name How does

Child Key

A Child Key is the key for a field in a parent array. WP Data Sync API allows use of a child key only when iterating an array. Child key is optional and not used in all situations. Array with Child

Activate Data Source

Once you have configured your data source. You are ready to activate the data source. Activating the data source will schedule an event. The first event should run within 1 minute of setting the

Value Type

Most APIs return data in different formats. Our Value Type options allow you to access the data in many different ways. Please refer to the definitions and examples below. If the option you need is

Product Review Status

Setting the product review status active requires a few simple steps. Setting Product Review Status Navigate to your Data SourceOpen the WooCommerce Product Data tabClick Add Data FieldSelect

Parent Keys

Parent keys are the keys your item data is nested under. Parent keys are optional depending on the structure of you data. Parent Keys Items is the parents key in this example. No Parent

Request Details

Configuring request details is the process of connecting the WP Data Sync API to your data feed. Each connection is unique, but our system will accommodate almost any configuration. Request Details

Request Test

Once you have your Request Details configured, you are ready to test your Request Details to insure you have configured them correctly. Note: you must save all changes to your Request Details before

Data Source Mapping

Data source mapping is the process of relating the data fields from your data source with the data fields WordPress or WooCommerce use for your remote website. Note: We recommend obtaining your

Great Job!! You have successfully configured your data source. The WP Data Sync API has imported your items. You reviewed the items to insure the data is mapped to the correct fields. The users remote

Create a New Data Source

What is a Data Source? A Data Source in the WP Data Sync API is a collection of all the details required to connect WP Data Sync API to the source of your data. For example: You may have a

Remote Key

Remote key is the key you will use to name the data field on your remote website. New Development If you are developing new functionality. You can use any naming convention that works for your

Connect WP Data Sync API to Your Website

Connect a website to your WP Data Sync API in just a few easy steps. Login to your WP Data Sync APINavigate to your Users > Profile pageCreate new credentials using the UICopy the credentials

Accelerated Sync

Note: Admin permissions required to configure this feature. Accelerate Sync is a system to sync smaller bits of meta data much faster and more often. This feature is most valuable for syncing