Shopify

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 Omnata plugin supports the GraphQL Admin API 2025-04 version.

Authentication methods

API Access Token

This authentication method requires 4 parameters:

  1. Your shop name

  2. An API Access Token

  3. User Tier

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. For ease of configuration, we recommend enabling read and write access for all Shopify objects. However, if you prefer to enable minimum scopes only, the below shows scope requirements down to the field level. A missing scope for a field will cause the whole stream to fail inside a sync.

Scopes for inbound syncs

customers

  • read_customers (mandatory)

products

  • read_products (mandatory)

  • read_publications (for availablePublicationsCount field)

orders

  • read_orders (mandatory)

  • read_customer (for customer field)

  • read_products (for line_items -> variant field)

  • read_payment_terms (for paymentTerms field)

returns (dep. orders)

  • all scopes from orders

  • read_returns (mandatory)

fulfillments (dep. orders)

  • all scopes from orders

  • read_fulfillments (mandatory)

  • read_locations (for location field)

shippingLine (dep. orders)

  • all scopes from orders

product_variants

  • read_products (mandatory)

  • read_inventory (for duplicateSkuCount field)

  • read_shipping (for duplicateSkuCount field)

locations

  • read_locations (mandatory)

shopifyPaymentsAccount

  • read_shopify_payments_accounts (mandatory)

balanceTransactions

  • read_shopify_payments_accounts (mandatory)

payouts

  • read_shopify_payments_accounts (mandatory)

shop

  • read_products (for allProductCategoriesList field)

  • read_locations (for location field)

  • read_markets (for marketWebPresence field)

  • read_legal_policies (for shopPolicies field)

  • read_locales (for alternateLocales field)

inventory_items

  • read_inventory (mandatory)

inventory_levels (dep. inventory_items)

  • read_inventory (mandatory)

  • read_locations (for locations field)

Scopes for outbound syncs

  • Customers

    • write_customers

  • Products

    • write_products

  • Orders

    • write_orders

  • Fulfillment

    • write_fulfilments

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

You should structure your source data as described in Outbound sync data structures.

The following streams for these objects are supported:

  • customer

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

  • products

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

  • orders

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

  • fulfillments

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

  • product variants

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

  • inventory item levels

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

PreviousRelease HistoryNextInbound sync data structures

Last updated