Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Question] Will this library be affected by Shopify REST API deprecation in 2024? #751

Closed
nasudadada opened this issue Jan 3, 2025 · 4 comments

Comments

@nasudadada
Copy link
Contributor

Thank you for maintaining this great library.

Question: Impact of Shopify REST API Deprecation

Context

According to Shopify's announcement, the REST Admin API became legacy as of October 1, 2024.

  • Public apps must migrate by February 2025
  • Custom apps must migrate by April 2025

Current Understanding

This library appears to primarily use REST API for its core functionality. For example:

shop = shopify.Shop.current()  # Uses REST API
product = shopify.Product.find(179761209)  # Uses REST API

Question

Is my understanding correct that this library will need to migrate from REST API to GraphQL API due to the REST API deprecation?

@sillycube
Copy link

sillycube commented Jan 3, 2025

Yes, this library is only a wrapper to the REST admin API. If you ever make product API calls, you have to change it to use the graphql. I use this library to call the graphql API like this:
result = shopify.GraphQL().execute(query=mutation, variables=variables)

You can refer the doc for the mutation and variables.

I have the same question. If Shopify deprecates this library, I can no longer call the graphql API and other features. It will be a huge headache. Is Shopify going to keep this library as it is?

@nasudadada
Copy link
Contributor Author

@sillycube
Thank you for your response!

I agree with your concern. If this library is deprecated or no longer maintained, it would have a significant impact. This would certainly be a major challenge for developers.

As for my approach, I plan to replace all REST API calls with GraphQL. However, I also feel that clear communication from Shopify about the future of this library is essential.

Once again, thank you for sharing such useful information!

@ryantang30
Copy link

Was digging into this as well, unfortunately is seems like Shopify has communicated in another closed issue that they will not be updating this library to use GraphQL under the hood:

Response from Shopify Developer Support:

James here from the Developer Support team at Shopify. John has caught me up to speed on your issue with your questions about the Python pyactiveresource library.
My team does not support our public libraries, but I notice that the last commit was over 2 years ago, and their philosophy statement outlines how it aims to provide a "wrapper object-relational mapping for REST web services", but our REST Admin API's as a legacy API in our latest quarterly release.
I reached out to our developers who work on the Python API library to see if I could get some clarification, and they confirmed that they we do not currently plan to map the existing GraphQL Admin client to use that resource based syntax. Their recommendation is to migrate to using GraphQL queries and mutations in order to move off of the REST Admin API for all of the current users of the client libraries in all languages.
Our dev docs also have some resources on how to migrate from REST to GraphQL, but please let me know if you have any specific issues with how to implement a request in GraphQL and we can take another look.

#745 (comment)

For me, I will be building custom library for my use case instead of relying on this on which seems to be abandoned by Shopify team.

@nasudadada
Copy link
Contributor Author

nasudadada commented Jan 8, 2025

@ryantang30
Thank you for sharing the detailed information from Shopify Developer Support. It's really helpful to understand the current status and future of this library.

It's a bit sad to hear that there are no plans to update the library for GraphQL support, as this library has been very useful for many developers including myself.

I've created a PR (#752) to update the README with REST API deprecation notices. While I'm not sure if it will be merged, I hope it helps other developers understand the upcoming changes and plan their migration accordingly.

Since I got all the information I needed about the library's future status and REST API deprecation timeline, I'll close this issue. Thank you everyone for your help!

@nasudadada nasudadada closed this as not planned Won't fix, can't repro, duplicate, stale Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants