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.