• Skip to primary navigation
  • Skip to main content

WP Data Sync

The only data sync API for WordPress websites.

  • Products
  • Blog
    • Code Examples
  • Documentation
    • Getting Started
    • Actions
    • Filters
    • FAQ
    • Specifications
    • Change Log
  • Contact
  • Support
  • Checkout
  • Account

Developer Documentation

Order Mapping – Path

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

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

System Report

What is the system report? The system report is a list of system settings from your remote website. The details of the report are helpful for our support team to debug issues. Where is the

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

wp_data_sync_set_property_{$key}

This is a dynamic filter to allow manipulation of the data when DataSync properties are set.

General Keys

  • primary_id
  • is_accelerated
  • integrations

Post Type Keys

  • post_data
  • post_meta
  • taxonomies
  • featured_image
  • attachment

User Keys

  • user_data
  • user_meta

WooCommerce Keys

  • gallery_images
  • attributes
  • variations

wp_data_sync_term_taxonomy

Filter the taxonomy.

wp_data_sync_post_meta_{$meta_key}

Perform an action for a specific post meta key.

wp_data_sync_item_request_sql_limit

Filter the LIMIT statement for the item request SQL query.

wp_data_sync_item_request_sql_order_by

Filter the ORDER BY statement for the item request SQL query.

wp_data_sync_item_request_sql_where

Filter the WHERE statement for the item request SQL query.

wp_data_sync_item_request_sql_join

Filter the JOIN statement for the item request SQL query.

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.

wp_data_sync_can_sync_order

Determine if an order can be synced.

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

wp_data_sync_gallery_image

Filter the URL of a gallery image

wp_data_sync_{$meta_key}_value

Filter meta value for a specific meta key.

wp_data_sync_meta_value

Filter the value of a meta field.

  • Go to page 1
  • Go to page 2
  • Go to page 3
  • Interim pages omitted …
  • Go to page 5
  • Go to Next Page »

Are you ready for the Enterprise Plan?


Get exactly what you need. Find out how today!!


Schedule a Consultation

Follow Us

WP Dat Sync icon
Copyright © 2022 · WP Data Sync · Located in Scottsdale AZ

  • Developers
  • Affiliates
  • Data Access Request
  • Terms of Service
  • Privacy Policy
This website uses cookies to improve your experience. We'll assume you're ok with this, but you can opt-out if you wish. Cookie settingsACCEPT
Privacy & Cookies Policy

Privacy Overview

This website uses cookies to improve your experience while you navigate through the website. Out of these cookies, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This category only includes cookies that ensures basic functionalities and security features of the website. These cookies do not store any personal information.
Non-necessary
Any cookies that may not be particularly necessary for the website to function and is used specifically to collect user personal data via analytics, ads, other embedded contents are termed as non-necessary cookies. It is mandatory to procure user consent prior to running these cookies on your website.
SAVE & ACCEPT