Articles in this section

Migrate your Shopify REST APIs to GraphQL using the tool

Naga Sri Hari Gonaboyina
Updated

Shopify is deprecating some REST APIs and recommends migrating to respective supported GraphQL APIs. Hence, to make the migration process easy, Celigo has developed a migration tool where you can see the list of Shopify Exports and/or Imports and can clone them to GraphQL. 

Important information

  • Shopify’s GraphQL endpoint differs from the REST endpoint. Hence, ensure you update the connection settings accordingly. For detailed information on how to set up a connection, see Connect to Shopify.

  • Shopify GraphQL doesn't return data in the same structure for all endpoints, so you must validate to check whether the GraphQL meets your use case requirements.

  • Additional validation is required for the cloned flows, as this migration tool leverages Shopify's AI Assistant Beta. 

  • For migrations, the best practice is to clone your original flows so that you can compare the results between the REST and GraphQL versions.

  • If no Shopify exports or imports require migration, the Exports/Imports dropdown list will not appear under the migration tool.

  • Once you clone the original flow, you will need to replace the original REST-based Shopify import/export with the newly generated GraphQL version, as shown below:

    1. Navigate to your original flow.

    2. In Source, click Remove resource from flow.

    3. Click Add source.

    4. From Your existing flow steps, choose the cloned flow.

    5. Click Save. The Create export page appears.

    6. In Connection, select Shopify connection.

    7. Click Save and close.

    8. Click Run test.

Limitations

  • Occasionally, you might encounter these issues:

    • Incorrect/incomplete mappings results in throwing an error while you invoke a cloned import. Hence, users have to manually add the mappings in the input.

      Query.png

  • For the configured transformations, filter rules, or hooks on the REST API based exports, lookups, and imports, ensure to update the cloned GraphQL exports/imports according to the GraphQL response.

How to use the tool

  1. Sign in to your Celigo integrator.io account.

  2. Navigate to Tools > Playground > Shopify REST-to-GraphQL clone tool.

  3. Expand Exports to see the list of all Shopify exports.

  4. Choose the required export and click Clone.

    Note

    You can also View/Edit the export and see the flows where that export has been Used by.

  5. Once cloning is complete, you can see the cloned GraphQL export under Exports. For example, if you clone an export named Test, it will appear as Test_GraphQL.

    Clone_tool.png

  6. The cloned export gets the GraphQL URL in the Relative URI and GraphQL query in the HTTP request body.

  7. Similarly, you can clone the imports also.

    Note

    You can see all the cloned exports and/or imports on the Export and Import pages, respectively.

Sample video