How to Setup Syncware App in Shopify store

Syncware supports all Shopify plans. However, due to the nature of some APIs requiring access to Personally Identifiable Information (PII), full functionality is only available on Shopify Advanced and Shopify Plus plans. If your integration requires handling PII, upgrading to one of these plans may be necessary.

To change your authentication (connection) type please watch this video. Then, skip to STEP 3 for an image on where the API Admin Access token is located.

STEP 1 - Enable custom app development from the Shopify admin

Steps:

  1. From your Shopify admin, go to Apps.
  2. Scroll to the bottom gear icon - App and Sales Channel Settings
  3. Click  Develop apps (top right of the page)
  4. Click  Allow custom app development.
  5. Read the warning and information provided, and then click  Allow custom app development

STEP 2 - Create the custom app

Steps:

  1. From your Shopify admin, go to Apps.
  2. Click  Develop apps.
  3. Click  Build apps in Dev Dashboard.
  4. Click  Create app.
  5. Start from Dev Dashboard, enter the App Name - Syncware.
  6. Click Create
  7. In the URL section for the App URL add www.syncware.com
    1. Uncheck the box "Embed app in Shopify Admin"
  8. Scroll down to the Access area, click Select Scopes
  9. The following scopes should be selected.  You can click them individually OR you can copy and paste the following scopes into the text box:
    1. read_assigned_fulfillment_orders,write_assigned_fulfillment_orders,read_customers,write_customers,read_price_rules,write_price_rules,read_discounts,write_discounts,write_draft_orders,read_draft_orders,read_fulfillments,write_fulfillments,write_inventory,read_inventory,read_locales,read_locations,read_orders,write_orders,read_payment_terms,write_payment_terms,read_product_listings,read_products,write_products,read_shipping,write_shipping,read_third_party_fulfillment_orders,write_third_party_fulfillment_orders,write_order_edits,read_order_edits
  10. Click Release. You can choose to name the version or not, its optional.

STEP 3 - Install the custom app and get the API access tokens

Steps:

  1. The newly created Syncware app will now appear on the Apps page on the Dev Dashboard
  2. From the Home Page of the newly created App you will be able to install the app to your Shopify store.
  3. Click Install app.
  4. Review the data that Syncware will be accessing, and click Install App.
  5. Once installed, you will need to go back to the Dev Dashboard to get your API Key and API Secret Key
    1. In the Dev Dashboard, click the app
    2. Click Settings
    3. Copy your Client ID (API Key) and Secret (API Secret) and enter them into Syncware.  
  6. Follow the steps in this article to add your API Key and API Secret to Syncware.

API Scopes

Scope Authenticated access granted

read_assigned_fulfillment_orders     ,

write_assigned_fulfillment_orders     

 FulfillmentOrder resources assigned to a location managed by your fulfillment service

read_customers     ,

write_customers     

 Customer and Saved Search permissions required

read_discounts     ,

write_discounts     

 GraphQL Admin API Discounts features

read_draft_orders     ,

write_draft_orders     

 Draft Order permissions required

read_fulfillments     ,

write_fulfillments     

 Fulfillment Service

read_inventory     ,

write_inventory     

 Inventory Level and Inventory Item
read_locations      Location

read_merchant_managed_fulfillment_orders     ,

write_merchant_managed_fulfillment_orders     

 FulfillmentOrder resources assigned to merchant-managed locations

read_orders     ,

write_orders     

 Abandoned checkouts, Customer, Fulfillment, Order, and Transaction resources permissions required

read_payment_terms     ,

write_payment_terms     

 GraphQL Admin API PaymentSchedule and PaymentTerms objects

read_price_rules     ,

write_price_rules     

 Price Rules

read_products     ,

write_products     

 Product, Product Variant, Product Image, Collect, Custom Collection, and Smart Collection
read_product_listings      Product Listing and Collection Listing

read_shipping     ,

write_shipping     

 Carrier Service, Country, and Province

read_third_party_fulfillment_orders     ,

write_third_party_fulfillment_orders     

 FulfillmentOrder resources assigned to a location managed by any fulfillment service

read_order_edits     ,

write_order_edits     

 GraphQL Admin API OrderStagedChange types and order editing features

Still need help? Contact Us Contact Us