_objects

_webhooks

The amount of discount. Should always be numeric, even if setting a percentage.

The date the coupon was created, in the site's timezone.

The date the coupon expires, in the site's timezone.

The date the coupon was last modified, in the site's timezone.

The date the coupon was last modified, as GMT.

Determines the type of discount that will be applied.

List of email addresses that can use this coupon.

If true, this coupon will not be applied to items that have sale prices.

List of category IDs the coupon does not apply to.

List of product IDs the coupon cannot be used on.

If true and if the free shipping method requires a coupon, this coupon will enable free shipping.

If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.

Max number of items in the cart the coupon can be applied to.

Maximum order amount allowed when using the coupon.

Minimum order amount that needs to be in the cart before coupon applies.

List of category IDs the coupon applies to.

List of product IDs the coupon can be used on.

Number of times the coupon has been used already.

How many times the coupon can be used in total.

How many times the coupon can be used per customer.

List of user IDs (or guest email addresses) that have used the coupon.

Coupons

Customers

Order Notes

The date the product was created, in the site's timezone.READ-ONLY

The date the product was created, as GMT.READ-ONLY

The date the product was last modified, in the site's timezone.READ-ONLY

The date the product was last modified, as GMT.READ-ONLY

Meta data. See Product - Meta data properties

Define if the order is paid. It will set the status to processing and reduce stock items. Default is false.

Orders

Payment Gateways

Product Attributes Terms

Product Attributes

Product Categories

Product Shipping Classes

Product Tags

Product Variations

If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no.

Product external button text. Only for external products.

Catalog visibility. Options: visible, catalog, search and hidden. Default is visible.

The date the product was created, in the site's timezone

The date the product was last modified, in the site's timezone

The date the product was last modified, as GMT

Start date of sale price, in the site's timezone.

End date of sale price, in the site's timezone.

Defaults variation attributes. See Product - Default attributes properties

Product dimensions. See Product - Dimensions properties

Number of days until access to downloadable files expires. Default is -1.

Number of times downloadable files can be downloaded after purchase. Default is -1.

If the product is downloadable. Default is false.

List of downloadable files. See Product - Downloads properties

Product external URL. Only for external products.

List of images. See Product - Images properties

Stock management at product level. Default is false.

Menu order, used to custom sort products.

Optional note to send the customer after purchase.

Shows whether or not the product shipping is taxable

Allow one item to be bought in a single order. Default is false.

Product status (post status). Options: draft, pending, private and publish. Default is publish.

Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock.

Tax status. Options: taxable, shipping and none. Default is taxable.

If the product is virtual. Default is false.

Products

City names. Introduced in WooCommerce 5.3.

City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, postcodes should be used instead.

Whether or not this is a compound rate. Compound tax rates are applied on top of other tax rates. Default is false.

Country ISO 3166 code. See ISO 3166 Codes (Countries) for more details

Unique identifier for the resource. READ-ONLY

Indicates the order that will appear in queries.

Postcodes/ZIPs. Introduced in WooCommerce 5.3.

Tax priority. Only 1 matching rate per priority will be used. To define multiple tax rates for a single area you need to specify a different priority per rate. Default is 1.

Whether or not this tax rate also gets applied to shipping. Default is true.

Tax Rates

Woocommerce

Salesforce

Zoho CRM

Pipedrive

Quickbooks

Xero

Sage Accounting

Shopify

Zoho Books

Stripe

Freshdesk

Exact Online

Chargebee

BigCommerce

PayPal

Ontraport

Lightspeed R-Series

# Continuous Import of Products to Your App

This scenario enables your application to continuously sync Products from any external application to your app's API. It handles the initial import of Products and keeps them synchronized when a Product is created, updated, or deleted in the external application.

When receiving Products data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Products to my App

Import Products and receive created/updated or deleted events

SAP S4 HANA

NetSuite

# Delete Order

This scenario allows your application to delete a Order from any external application. 
You will pass ID of the Order you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Order API call**:
   - Call Integration.app REST API or SDK with ID of the Order you want to delete and Integration.app will send the correct request to the external app.


Delete Order

Deletes Order in any external application

Freshbooks

# Delete Customer

This scenario allows your application to delete a Customer from any external application. 
You will pass ID of the Customer you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Customer API call**:
   - Call Integration.app REST API or SDK with ID of the Customer you want to delete and Integration.app will send the correct request to the external app.


Delete Customer

Deletes Customer in any external application

# Realtime Full two-way Sync of Tax Rates

This scenario enables your application to fully sync Tax Rates between your app and any external application in both directions. It handles the initial import/export of Tax Rates and then sends events when a Tax Rate is created, updated, or deleted on any side, as close to real-time as possible.

Tax Rate fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Tax Rates in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Tax Rates to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Tax Rates

Bi-directional realtime sync of Tax Rates with records deduplication

# Update Tax Rate

This scenario allows your application to update a Tax Rate in any external application in the same way. 
You will pass  ID of the Tax Rate you want to update and Tax Rate fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Tax Rate with and configure mapping to our default model

2. **Create Tax Rate API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Tax Rate data into a format compatible with the selected external application.
   - It then makes an API call to update the Tax Rate in that specific application.


Update Tax Rate

Updates Tax Rate in any external application

# Delete Tax Rate

This scenario allows your application to delete a Tax Rate from any external application. 
You will pass ID of the Tax Rate you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Tax Rate API call**:
   - Call Integration.app REST API or SDK with ID of the Tax Rate you want to delete and Integration.app will send the correct request to the external app.


Delete Tax Rate

Deletes Tax Rate in any external application

Isolved

# Enrich newly created Customers

This scenario enables your application to enrich with the new data any newly createad Customers in external application. 

It handles subscription to the created events and Customer fields mapping from your application's schema to the application-specific schema.

## How It Works
1. **Configuration**:
   - You will setup the schema of fields that you wish to enrich Customer with and configure mapping to our default model.
   - If needed - your customer can customize this mapping based on their specific setup or even custom fields

2. **Enable receiving of Customer created events**:
   - Enable subscription via a single API or SDK call to continuously receive created events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

2. **React to created Customers**:
   - Integration.app flow will be launched when new Customer is created
   - It will send existing data to your app API, so you can decide how to enrich. Your API will return enriched data.
   - Integration.app will send enriched data to the external application mapped to the supported format based on the configuration above


Continuously Enrich Customers

Receive all newly created customers, send it to your app API to enrich with the new data and update customer back

# Get all Customers

This scenario enables your application to get a complete list of Customers from any external application to your app's API in the same way. 

When receiving Customers data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Customers along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Customers page by page.


Get all Customers

Imports all Customers from any external application to your App.

# Continuous Import of Tax Rates to Your App

This scenario enables your application to continuously sync Tax Rates from any external application to your app's API. It handles the initial import of Tax Rates and keeps them synchronized when a Tax Rate is created, updated, or deleted in the external application.

When receiving Tax Rates data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Tax Rates to my App

Import Tax Rates and receive created/updated or deleted events

# Create Order

This scenario allows your application to create a Order in any external application in the same way. 
You will pass Order fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Order with and configure mapping to our default model

2. **Create Order API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Order data into a format compatible with the selected external application.
   - It then makes an API call to create the Order in that specific application.


Create Order

Creates Order in any external application

# Create Product

This scenario allows your application to create a Product in any external application in the same way. 
You will pass Product fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Product with and configure mapping to our default model

2. **Create Product API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Product data into a format compatible with the selected external application.
   - It then makes an API call to create the Product in that specific application.


Create Product

Creates Product in any external application

# Continuous Import of Orders to Your App

This scenario enables your application to continuously sync Orders from any external application to your app's API. It handles the initial import of Orders and keeps them synchronized when a Order is created, updated, or deleted in the external application.

When receiving Orders data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Orders to my App

Import Orders and receive created/updated or deleted events

# Delete Product

This scenario allows your application to delete a Product from any external application. 
You will pass ID of the Product you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Product API call**:
   - Call Integration.app REST API or SDK with ID of the Product you want to delete and Integration.app will send the correct request to the external app.


Delete Product

Deletes Product in any external application

# Realtime Full two-way Sync of Products

This scenario enables your application to fully sync Products between your app and any external application in both directions. It handles the initial import/export of Products and then sends events when a Product is created, updated, or deleted on any side, as close to real-time as possible.

Product fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Products in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Products to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Products

Bi-directional realtime sync of Products with records deduplication

# Continuous Import of Customers to Your App

This scenario enables your application to continuously sync Customers from any external application to your app's API. It handles the initial import of Customers and keeps them synchronized when a Customer is created, updated, or deleted in the external application.

When receiving Customers data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Customers to my App

Import Customers and receive created/updated or deleted events

# Get all Products

This scenario enables your application to get a complete list of Products from any external application to your app's API in the same way. 

When receiving Products data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Products along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Products page by page.


Get all Products

Imports all Products from any external application to your App.

# Update Order

This scenario allows your application to update a Order in any external application in the same way. 
You will pass  ID of the Order you want to update and Order fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Order with and configure mapping to our default model

2. **Create Order API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Order data into a format compatible with the selected external application.
   - It then makes an API call to update the Order in that specific application.


Update Order

Updates Order in any external application

# Update Customer

This scenario allows your application to update a Customer in any external application in the same way. 
You will pass  ID of the Customer you want to update and Customer fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Customer with and configure mapping to our default model

2. **Create Customer API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Customer data into a format compatible with the selected external application.
   - It then makes an API call to update the Customer in that specific application.


Update Customer

Updates Customer in any external application

# Create Tax Rate

This scenario allows your application to create a Tax Rate in any external application in the same way. 
You will pass Tax Rate fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Tax Rate with and configure mapping to our default model

2. **Create Tax Rate API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Tax Rate data into a format compatible with the selected external application.
   - It then makes an API call to create the Tax Rate in that specific application.


Create Tax Rate

Creates Tax Rate in any external application

# Get all Tax Rates

This scenario enables your application to get a complete list of Tax Rates from any external application to your app's API in the same way. 

When receiving Tax Rates data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Tax Rates along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Tax Rates page by page.


Get all Tax Rates

Imports all Tax Rates from any external application to your App.

# Create Customer

This scenario allows your application to create a Customer in any external application in the same way. 
You will pass Customer fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Customer with and configure mapping to our default model

2. **Create Customer API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Customer data into a format compatible with the selected external application.
   - It then makes an API call to create the Customer in that specific application.


Create Customer

Creates Customer in any external application

# Get all Orders

This scenario enables your application to get a complete list of Orders from any external application to your app's API in the same way. 

When receiving Orders data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Orders along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Orders page by page.


Get all Orders

Imports all Orders from any external application to your App.

# Realtime Full two-way Sync of Orders

This scenario enables your application to fully sync Orders between your app and any external application in both directions. It handles the initial import/export of Orders and then sends events when a Order is created, updated, or deleted on any side, as close to real-time as possible.

Order fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Orders in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Orders to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Orders

Bi-directional realtime sync of Orders with records deduplication

# Realtime Full two-way Sync of Customers

This scenario enables your application to fully sync Customers between your app and any external application in both directions. It handles the initial import/export of Customers and then sends events when a Customer is created, updated, or deleted on any side, as close to real-time as possible.

Customer fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Customers in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Customers to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Customers

Bi-directional realtime sync of Customers with records deduplication

# Update Product

This scenario allows your application to update a Product in any external application in the same way. 
You will pass  ID of the Product you want to update and Product fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Product with and configure mapping to our default model

2. **Create Product API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Product data into a format compatible with the selected external application.
   - It then makes an API call to update the Product in that specific application.


Update Product

Updates Product in any external application

# Product Unified API

This scenario contains the complete Products Unified API into your workspace. You will be able to seamlessly create, update, delete, and search Products while also receiving notifications on creation, updates, and deletions of Products in external applications. 

Integration.app will automatically manage the mapping of data to the unified schema, eliminating any concerns about differences across external applications. Additionally, you’ll have the flexibility to customize mappings for specific applications or customers, ensuring compatibility with their unique configurations when needed.


Products Unified API

# Order Unified API

This scenario contains the complete Orders Unified API into your workspace. You will be able to seamlessly create, update, delete, and search Orders while also receiving notifications on creation, updates, and deletions of Orders in external applications. 

Integration.app will automatically manage the mapping of data to the unified schema, eliminating any concerns about differences across external applications. Additionally, you’ll have the flexibility to customize mappings for specific applications or customers, ensuring compatibility with their unique configurations when needed.


Woocommerce API Integration Profile

Build every single integration your customers need with AI