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:
- From your Shopify admin, go to Apps.
- Scroll to the bottom gear icon - App and Sales Channel Settings
- Click Develop apps (top right of the page)
- Click Allow custom app development.
- Read the warning and information provided, and then click Allow custom app development
STEP 2 - Create the custom app
Steps:
- From your Shopify admin, go to Apps.
- Click Develop apps.
- Click Create a custom app.
- 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.
- Click Create app.
- Click Configure Admin API Scopes.
- In the Admin API access scopes section, select the API scopes from the below table as it applies to your integration.
- Typically, you would need:
read_inventory, write_inventory, read_products, read_product_listings, read_locations,read_customers,write_customers,read_orders, write_orders
- Typically, you would need:
- Click Save.
STEP 3 - Install the custom app and get the API access tokens
Steps:
- Under Apps > Develop Apps > "Syncware" app > API Credentials > Click Install app.
- In the modal window, click Install app.
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.
- Follow the steps in this article to add your Store Name and Admin API Access token to Syncware.
API Scopes
Scope | Authenticated access granted |
---|---|
|
FulfillmentOrder resources assigned to a location managed by your fulfillment service |
|
Customer and Saved Search permissions required |
|
GraphQL Admin API Discounts features |
|
Draft Order permissions required |
|
Fulfillment Service |
|
Inventory Level and Inventory Item |
read_locations |
Location |
|
FulfillmentOrder resources assigned to merchant-managed locations |
|
Abandoned checkouts, Customer, Fulfillment, Order, and Transaction resources permissions required |
|
GraphQL Admin API PaymentSchedule and PaymentTerms objects |
|
Price Rules |
|
Product, Product Variant, Product Image, Collect, Custom Collection, and Smart Collection |
read_product_listings |
Product Listing and Collection Listing |
|
Carrier Service, Country, and Province |
|
FulfillmentOrder resources assigned to a location managed by any fulfillment service |
|
GraphQL Admin API OrderStagedChange types and order editing features |