How to setup Syncware Custom 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.

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  Create a custom app.
  4. In the modal window, enter Syncware as App Name and select an App developer. The app developer can be the store owner, or any staff or collaborator account with the Develop apps permission.
  5. Click  Create app.
  6. Click Configure Admin API Scopes.
  7. In the Admin API access scopes section, select the API scopes from the below table as it applies to your integration.
    1. Typically, you would need: read_inventory, write_inventory, read_products, read_product_listings, read_locations,read_customers,write_customers,read_orders, write_orders
  8. Click  Save.

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

Steps:

  1. Under Apps > Develop Apps > "Syncware" app > API Credentials > Click Install app.
  2. In the modal window, click  Install app.
  3. To get the access token to go to the Admin API access token section and click Reveal token once.

    You can see the Admin API access token on this page only one time. After revealing the access token, write down or record the token somewhere secure so that you can refer to it again.

  4. Follow the steps in this article to add your Store Name and Admin API Access token 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