Shopify tips and examples

explore the following tips and examples to help you manage api limits, avoid errors, and correctly configure the watch events (advanced) module shopify api rate limits the shopify app in make follows shopify’s api credit system to manage how many operations you can perform over time shopify doesn’t limit the number of requests you send, but each request uses credits based on how much data you retrieve or how complex the request is if your available credits run out, shopify blocks new requests with a rate limit error this system helps prevent overload and ensures fair use for all shopify users api limits are set by shopify and depend on your shopify plan your make plan has no impact on these limits how it works? every request you send to shopify uses api credits different types of operations use different amounts of credits actions like creating , updating , or deleting use 10 credits per request for example, when you create an order, 10 credits are deducted from your available pool the same applies to webhooks creating a webhook costs 10 credits, but triggering it later doesn't consume any credits when you request information from shopify using queries, such as get , list , search , or watch , the number of credits depends on how much data you ask for the more complex the query, the higher the cost for more details on how shopify's credit system and graphql query complexity work, see shopify complexity guide for example, in the get an order module, you can control how much information is retrieved by adjusting the available settings you decide how many line items to include in the output (up to 250) and whether to include product variants for each line item, with a limit of up to 250 variants per item the more data you request, the higher the credit usage in this example we set a limit of 250 line items per order we also chose to include product variants, with a limit of 5 variants per line item as a result, if the order has 1 line item, shopify queries 5 variants if the order has 10 line items, then shopify queries 50 variants, which increases the overall credit cost shopify reserves api credits based on the limits you set in make, but only deducts credits for the actual amount of data retrieved for more information, see the quota details section below quota details after running a shopify module in your scenario, you can check the quota details in the output to see how your api credits were used for example, imagine you use the get an order module and set a high limit for line items or variants shopify needs to reserve enough credits to cover the maximum possible result — even if the actual data returned is smaller in the example output above the requested query cost shows 100 credits, meaning shopify reserves that amount based on the potential size of the response you must have at least 100 credits available to even run the request after the query requested, the actual query cost shows 20 credits, based on the real amount of data retrieved — so only 20 credits are deducted from the available limit you’ll also see your current credit status under throttle status in this example, the maximum available credits are set to 2000, which is the highest shopify plan allows after running the request, the currently available credits drop to 1980, reflecting how many credits left the restore rate shows how quickly your credit pool makes space for new requests — similar to how water drains from a bucket to make room for more it is recommended to run your module after setting it up and review the quota details in the output check the requested query cost shown in the output and compare it to your restore rate if your scenario is set to run frequently, or if you manage a large number of scenarios with shopify modules, refining your module mappings is an effective way to reduce your api credit consumption for more details, see shopify api usage limits shopify page size the page size controls how many orders are retrieved per page when using search modules in the shopify app this setting helps prevent issues with shopify's graphql complexity limits, especially when you need to retrieve large amounts of data shopify limits how many items you can request based on the complexity of the query if the request is too large or contains too many fields, it may fail by setting a page size, you can split your request into smaller parts that run one after another, helping you retrieve more orders without exceeding limits to use the page size field, switch on the show advanced settings option example usage let’s say you set the page size to 10 and the order limit to 100 this retrieves 10 pages with 10 orders each, for a total of 100 orders shopify processes these smaller pages one by one, reducing the chance of errors for comparison, if you leave the page size empty and set the order limit to 100, shopify tries to retrieve all 100 orders at once, which might exceed complexity limits and block your request limitations the maximum number of orders per page is 250, based on shopify’s api limits the page size defaults to the lowest value between your mapped order limit and 250 the maximum number of pages that can be retrieved is 31 watch events (advanced) module when using the watch events (advanced) module in the shopify app, you can monitor specific shopify events and include relevant metafields in the output here's how to configure these fields event topic in the event topic field, you need to map which event the module listens to, such as order updates or product changes to find the correct event value refer to the shopify webhook topic enum values documentation enter the copied event topic into the event topic field you successfully configured the event, so the module triggers when this event occurs in your shopify store if you receive a missing scope error while setting up the webhook, edit your connection and add the required scope shown in the shopify documentation metafield namespaces if you want to include metafields in the output, add one or more metafield namespaces to find the namespace log in to your shopify admin account in the left sidebar, click settings > metafields and metaobjects in the metafield definitions section, click on the part of the store you want to use click on the metafield definition you want to use in the namespace and key field, copy the namespace written before the period only for example, if the namespace and key shows custom datafield , you will need to enter custom in the metafield namespace field in the watch events (advanced) module, click +add namespace and enter the namespace copied from your shopify admin account you’ve added the namespace—metafields from this namespace will now be included in the module output if they have assigned values make a graphql api call module starting from october 1, 2024, shopify switched from the rest admin api to graphql admin api the rest admin api is a legacy api, and all apps and integrations should be built using graphql let’s suppose you want to retrieve a list of in stock products with their variants in your shopify store and add this data to google sheets here’s an example of how to use the make a graphql api call module in {{product name}} for that add 'make a graphql api call' module add the make a graphql api call module in {{product name}} in the ​ connection ​​ field, select a connection for your shopify account if you haven't created a shopify connection yet, refer to the connect shopify and make section to retrieve the inventory stock for multiple products, including their titles and prices, you can use the products query from shopify graphql api documentation , adding some relevant variables and pasting them into the query field query getproducts { products (first 10) { edges { node { id title variants (first 10) { edges { node { id title price inventoryquantity } } } } } } } query breakdown products (first 10) limits the response to the first 10 products in the store from shopify you can increase or decrease it edge in graphql represents the product, and node represents the actual product objects variants represent different categories (e g , sizes xs, s, m, l) and are also limited to the first 10 variants per product nodes inside variants provide the actual info title , price and inventoryquantity that you pull in from the store by default, all requests are treated as queries, so you don't need to specify them explicitly you can start directly with 'products' for mutations or other non query requests, be sure to define the request type in your call optional switch on the show advanced settings toggle for additional configurations api version specify the api version to use for the query this is useful if you need to target an older api version variables input format choose the format for your query variables array recommended for mapping json standard key value structure variables add your query variables based on the format selected above simplify response define response format by default, graphql responses include nested structures such as nodes and edges check yes to get a simplified response as a more structured, flattened object no to maintain the original response with all nested objects handle errors define how error handling will work by default, all graphql responses are returned with a 200 status code, but the body can contain errors check yes to enable module level error handling no if you're implementing some custom error handling logic click save this is the output you'll get add iterator 1 to get the title and variants array for each product add an iterator to your scenario map body data \[products] from the make a graphql api call module click save this is the output you will get add iterator 2 to iterate each variant directly (title, price, and quantity) add another iterator to your scenario map variants \[] from the iterator 1 click save this is the output you'll get add a google sheets add a row module to add data to google sheets create a sheet with the corresponding fields add a google sheets add a row module in {{product name}} configure the fields within your google sheets connection (drive, spreadsheet id, sheet name) and map the values for the product name field map title from the iterator 1 for the variant field map title from iterator 2 for the price field map price from the iterator 2 for the inventory quantity field map inventoryquantity from the iterator 2 click save click the run once button on the toolbar to test the scenario check your google sheets file you should get a table like this other examples of queries for the make a graphql api call module this is how a query for searching articles by title with metafields could look query { articles(first 10, query "title\ picture") { nodes { id title body summary handle ispublished publishedat tags createdat updatedat author { name } blog { id } image { alttext url } metafields(first 10) { nodes { id namespace legacyresourceid key value jsonvalue type } } } } } the output would look like this this is how a query for getting customer data could look query { customer(id "gid //shopify/customer/3057986535526") { id email phone taxexempt firstname lastname amountspent { amount currencycode } smsmarketingconsent { marketingstate marketingoptinlevel consentupdatedat } } } the output would look like this