ShopifyApp.installationLink
field is what you are interested in querying:
storeCanonicalDomain
input argument.
The returned url
field contains the installation link. You should share this with your merchant, and ask them to open it in their browser.
SHOPIFY_APP_CONNECTED
webhook. Receipt of this event is enough to confirm that the merchant has successfully installed the app and that you can now access their products via the Sync API. If the merchant ever uninstalls the app or revokes your access to their store then a corresponding SHOPIFY_APP_DISCONNECTED
webhook will be fired.
If you have not configured webhooks then you can also poll the installation status via the integratedShopifyStore
query. This query will return null
if you do not have access to the store through the Sync API, and this can be used to determine whether the merchant has installed the app.
productByID
Used to retrieve information about a specific product.
productsByDomainV2
Used to retrieve all products from the specified store domain.
productsByDomainV2
will be the most appropriate API operation to use as you likely won’t know any product IDs upfront. The following query would return product catalog data from Gymshark’s USA store, assuming you have access to it:
productsByDomainV2
to return product data that you do not have access to through the Sync API. This happens in cases where another developer has added the products to our Sell Anything API, but you do not have access to the Sync API for that store. This is why it is important to verify installation status before attempting to access product data.