Access Token

Refresh Token

Shopify

A single-line, text-only description of the collection, stripped of any HTML tags and formatting

The description of the collection in HTML format

A human-friendly unique string for the collection

The count's precision, or the exactness of the value

The order in which the products in the collection are displayed

The suffix of the template used for the collection page

The date and time when the collection was last modified

Collections

A list of addresses associated with the customer

The total amount that the customer has spent on orders in their lifetime

Whether the merchant can delete the customer from their store

A list of the customer's company contact profiles

The date and time when the customer was added to the store

Whether the customer has opted out of having their data sold

The default address associated with the customer

The full name of the customer, based on firstName and lastName

The customer's consent to receiving marketing material by email

The date and time when consent was updated

The current marketing state for the customer

Whether the merchant has added timeline comments about the customer

The ID of the corresponding resource in the REST Admin API

The amount of time since the customer was first added to the store

A unique identifier for the customer used with Multipass login

The number of orders that the customer has made at the store

Possible subscriber states of a customer defined by their subscription contracts

The customer's consent to receiving marketing material by SMS

The state of the customer's account with the shop

Whether the customer is exempt from being charged taxes on their orders

The list of tax exemptions applied to the customer

The URL to unsubscribe the customer from the mailing list

The date and time when the customer was last updated

Whether the email address is formatted correctly

Whether the customer has verified their email address

Customers

The ISO 3166-1 alpha-2 country code of where the item originated from

The date and time when the inventory item was created

The number of inventory items that share the same SKU with this item

A list of the inventory item's quantities for each location

The number of locations where this inventory item is stocked

The packaging dimensions of the inventory item

The ISO 3166-2 alpha-2 province code of where the item originated from

Whether the inventory item requires shipping

Inventory item SKU. Case-sensitive string

Whether inventory levels are tracked for the item

Unit cost associated with the inventory item

The date and time when the inventory item was updated

The variant that owns this inventory item

InventoryItems

The first line of the address for the location

The second line of the address for the location

A formatted version of the address for the location

The approximate latitude coordinates of the location

The approximate longitude coordinates of the location

The code for the province, state, or district of the address of the location

The date and time that the location was added to a shop

The date and time that the location was deactivated

Whether this location can fulfill online orders

Whether this location has active inventory

Whether this location has orders that need to be fulfilled

Whether this location is used for calculating shipping rates

The date and time when the location was last updated

Locations

The email address associated with the customer

Orders

The date and time when the product was created

A human-friendly unique string for the product. Auto-generated from title if not provided.

The customization options for the product

The date and time when the product was published

The suffix of the template used for the product page

The date and time when the product was last modified

The vendor or manufacturer of the product

Products

The date and time when the refund was created

A list of the refunded duties as part of this refund

The optional note associated with the refund

The order adjustments associated with the refund

The total amount across all transactions for the refund

The total amount across all transactions for the refund, in shop and presentment currencies

The transactions associated with the refund

The date and time when the refund was updated

Refunds

Customer Update Default Address

Salesforce

Zoho CRM

Pipedrive

Quickbooks

Xero

Sage Accounting

Zoho Books

Stripe

Freshdesk

Woocommerce

Exact Online

# 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

HubSpot

NetSuite

SAP S4 HANA

# 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

# 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.

# 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 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.


Shopify API Integration Profile

Getting Started

Data Collections

Operations

Integration Scenarios