When mapping an order, we must define the path to create the data object to send an order to a remote API. We use a method named Dot Notation. What is Dot Notation? Dot Notation is one way to
Getting Started
Response – Success
Define a successful response. Response Code The response code is a numeric value returned from the remote server to indicate how the server interpreted the request. Generally a 200 response code
Dynamic Key
A Dynamic Key is an array key used to obtain an array value based on a Dynamic Value. This is very useful when your items have multiple variations. Example Data To obtain the price for the
Request Type
Request, refers to any HTTP request made by the WP Data Sync API. Stage Data Stage Data request is any request made to obtain data from your remote API or file upload. Sync Data Sync Data
Dynamic String
Prerequisites: Source keys, Create Data Source, Data Source Mapping A Dynamic String is a string made up of multiple values and/or static values. Example Data Dynamic String
Unset Keys
Unset keys is a feature that allows you to unset certain data keys. This is only available when your Request Details > Source Type is set to WordPress. How does Unset Keys work? Unset keys
Sanitize Value
We are working on this page. Please check back.
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
Prerequisites: Source keys, Create Data Source, Data Source Mapping Creating a unique primary ID is an optional process. This is only used if the source of your data does not already provide a
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 Available ItemsAccelerated Sync for Available ItemsMerge with Available ItemsBypass
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 Conditions UI. 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