Omnata Product Documentation
  • Omnata Sync for Snowflake
    • What is Omnata Sync for Snowflake?
    • How it works
      • Terminology
      • Branching Mode
      • Sync Directions and Strategies
        • Outbound
        • Inbound
      • Rate Limiting
      • Access Control
      • Notifications
      • Security and Privacy
      • Internal tables
      • Internal Stored Procedures
      • FAQ
    • Step-by-step guides
      • 1. Install the Omnata Sync Engine
      • 2. Install the Omnata Plugin
      • 3. Configure the Plugin
      • 4. Create a connection
      • 5. Create a sync
    • Apps
      • Aerobotics
        • 📘Release History
      • Airtable
        • 📘Release History
      • Amazon Ads
        • Privacy Notice
      • ApprovalMax
        • 📘Release History
      • Bamboo HR
        • 📘Release History
      • Clockify
        • 📘Release History
      • Contentful
        • 📘Release History
      • GitHub
        • 📘Release History
      • Github
      • Google Ads
        • 📘Release History
      • Google Sheets
        • 📘Release History
      • HubSpot
        • 📘Release History
      • Hubspot
      • Infor Data Lake
        • 📘Release History
      • Jira
        • 📘Release History
      • LinkedIn Ads
        • 📘Release History
      • Mailgun
        • 📘Release History
      • Marketo
        • 📘Release History
      • Meta Marketing
        • 📘Release History
      • Microsoft Ads
        • 📘Release History
      • Microsoft Dynamics 365 Business Central
        • 📘Release History
        • 📘Release History
        • 📘Release History
        • 📘Release History
        • 📘Release History
      • Microsoft Entra ID
        • 📘Release History
        • 📘Release History
        • 📘Release History
        • 📘Release History
      • Microsoft Excel
      • Microsoft SQL Server
        • 📘Release History
      • Monday.com
        • 📘Release History
      • MRPeasy
        • 📘Release History
      • PayHero
        • 📘Release History
      • Pinterest Ads
        • Privacy Policy
      • PostgreSQL
        • 📘Release History
      • Salesforce
        • Salesforce Permissions needed
        • Formula Fields
        • How we use the Salesforce APIs
        • 📘Release History
      • Salesforce Marketing Cloud
        • OAuth for APIs, SFTP for file transfer with GPG on outbound
        • OAuth for APIs, SFTP for file transfer
        • OAuth for APIs, Cloud Storage for file transfer
        • 📘Release History
      • Shopify
        • Outbound sync data structures
        • 📘Release History
      • Slack
        • 📘Release History
      • Tiktok Ads
        • Privacy Policy
      • Typeform
        • 📘Release History
      • Wise
        • 📘Release History
      • Xero
        • 📘Release History
      • Zendesk Support
        • 📘Release History
        • 📘Release History
    • Plugins
      • Anatomy of a Plugin
      • Example Plugins
        • Example Plugin: Slack
        • Example Plugin: Zoho CRM
      • Creating Plugins
      • Advanced Plugin topics
        • Advanced rate limiting / concurrency
        • Custom Jinja filters
        • Custom Record Transformers
        • Dynamic Configuration Forms
        • Test case generation
    • Branching
      • Inbound Sync branching
      • Outbound Sync branching
    • Integrations
      • dbt
        • Validation Tests (coming soon)
    • 📘Release History
  • Omnata Connect for Salesforce
    • Overview
    • Getting Started
      • Install the Salesforce App
      • Connect to your data warehouse
        • Snowflake
        • BigQuery
        • Rockset
        • Firebolt
        • SingleStore (previously MemSQL)
      • Deciding which mode to use
    • Omnata with Salesforce Connect (External Objects)
      • Object Configuration
      • View your data in a list
      • Link to other objects
      • Use in a Report
      • Database schema changes
      • Writing to External Objects
    • Omnata with Salesforce Lightning Components
      • Object Configuration
      • View your data in a list
      • Link to other objects
      • Using the Lightning Component on a page
      • Assigning Permissions
    • Advanced Features
      • Row Level Filtering
      • Multi-Currency handling
        • About Multi-Currency
        • Support in Omnata Connect
        • Apex Features
    • Integrations
      • Datadog
    • Omnata with Salesforce Apex
    • Security
    • Use cases
      • Linked object drill-downs
      • Global Search
      • ERP and historical data
      • Embedded product metrics
    • Best Practices
      • Global Search
      • Change Management
      • Snowflake table design
      • Salesforce page layout
      • Salesforce Caching
Powered by GitBook
On this page
  • Authentication methods
  • API Access Token
  • Inbound Syncs
  • Outbound Syncs
  1. Omnata Sync for Snowflake
  2. Apps

Shopify

PreviousRelease HistoryNextOutbound sync data structures

Last updated 20 days ago

Shopify plugin is able to seamlessly perform inbound and outbound synchronization operations for your Shopify store, ensuring your products, orders, and customer data are always up-to-date across all platforms. Simplify your e-commerce management with real-time data syncing and reduce manual tasks.

In this page, you'll find:

The Shopify connector is in public preview as of Nov-2024

Authentication methods

API Access Token

This authentication method requires 4 parameters:

Obtain your shop name

  1. Visit your store page.

  2. Click on Settings on the bottom left of your main store page.

  3. Copy down your shop name as shown in the screenshot below. Note: Each domain will end with myshopify.com, including custom domains.


Generate your API Access Token

  1. Visit your store page.

  2. Click on Settings on the bottom left of your main store page.

  3. In Settings, click on Apps and sales channels.

  4. Click on Develop apps.

  1. Click on Allow Custom App Development for both this page and the next.

  1. After activating custom app development, click on Create an app.

  1. In the popup window, fill in the App name to your desired name to identify this app and click Create App.

  2. Select the Configuration tab.

  3. Under Admin API Integration, select Configure.

  4. The access scopes below are required for the Shopify Plugin to function. However, some other scopes might be required for particular data.

    1. Customers (write_customers, read_customers)

    2. Products (write_products, read_products)

    3. Orders (write_orders, read_orders)

    4. Fulfillment (write_fulfilments, read_fulfillments)

  1. Click Save.

  2. On the top right of the page, click Install app and proceed with the installation.

  3. This should generate an API Access Token. Copy it down as you will need it later. Note: this token is only viewable once.

You may come across an API key and API secret key field under API Credentials. This is not your API Access Token that will be used to create a connection. The API Access Token is no longer viewable after it is first generated, so be sure to save it somewhere where you can refer to it later if you ever need to reset the connection.


Obtain your API version

  1. Visit your store page

  2. Click on Settings on the bottom left of your main store page.

  3. In Settings, click on Apps and sales channels.

  4. Click on Develop apps.

  5. Click on the app you have developed.

  6. Click on the Configuration tab.

  7. Under Webhook Version, refer to the API version.


Obtain your User Tier

  1. Visit your store page

  2. Click on Settings on the bottom left of your main store page.

  3. In Settings, click on Plan.

  4. In this page, you may view what plan you are using.

    1. For Basic and Shopify plans, you are to select Standard when creating the connection between Omnata and Shopify.

    2. For Advanced plans, you are to select Advanced when creating the connection between Omnata and Shopify.

    3. For Plus plans, you are to select Shopify Plus when creating the connection between Omnata and Shopify.

    4. For Enterprise plans, you are to select Enterprise when creating the connection between Omnata and Shopify.


Inbound Syncs

The following streams for these objects are supported:


Outbound Syncs

Supported Outbound sync strategies: Create, Update, Upsert, Delete.

The following streams for these objects are supported:

    • Create - Creates a new customer.

    • Update - Updates an existing customer's information.

    • Upsert - Creates a new customer or updates an existing customer's information.

    • Delete - Deletes an existing customer.

Existing customers cannot be deleted if they have a pending order.

    • Create - Creates a new product.

    • Update - Updates an existing product's information.

    • Upsert - Creates a new product or updates an existing product's information.

    • Delete - Deletes an existing product.

    • Create - Creates an order.

    • Update - Updates an existing order's information.

    • Upsert - Creates an order or updates an existing order's information.

    • Delete - Deletes an existing order.

    • Create - Fulfills an existing unfulfilled order.

    • Update - Updates an existing fulfillment's information.

    • Upsert - Fulfills an existing unfulfilled order or updates an existing fulfillment's information.

    • Delete - Cancels an already fulfilled order.

    • Create - Creates a product variant from on a product.

    • Update - Updates the product variant information.

    • Upsert - Creates a product variant if it does not exist or updates an existing's product variant's information.

    • Delete - Deletes a product variant from a product.

    • Create - Creates an inventory level at a specified location with the location id.

    • Update - Updates the inventory level stock amount.

    • Upsert - Creates an inventory level at a specified location with the location id or update the inventory level stock amount if the inventory level does not exist.

    • Delete - Deletes the entire inventory level.

Inventory levels cannot be deleted if this is the last remaining inventory level of the product variant.

Under Webhook Subscription, note down your Event version. You do not need to change this value. This will be your .

This requires you to have .

(dependent on orders)

(dependent on products)

i

(dependent on inventory items)

You should structure your source data as described in .

customers
products
orders
fulfillments
product variants
nventory items
inventory levels
locations
Outbound sync data structures
customer
products
orders
fulfillments
product variants
inventory item levels
Shopify's data structures
Creating a connection
Your shop name
An API Access Token
Selected API Version
User Tier
API Version
created and installed your app