Overview
Before you start integrating Rye's Product API, it’s important to understand what features the Product API has to offer.
Features
1. Request a product or merchant via the console
The Rye console API has a tab to request products manually. Check out https://console.rye.com/requests
2. Request product programmatically
The URL of the product must be a Shopify or Amazon product URL, depending on the marketplace.
Check out the documentation for this feature here!
3. Request store programmatically
Currently requesting a store is only available for Shopify. Note: In order to request all products from an Amazon merchant, you must issue individual requests for each product.
Check out the documentation for this feature here!
Once a product or vendor is requested by any developer, it becomes part of Rye's API and can be requested by any developer on the platform. Products can be requested by ID, vendor name or by domain. For shopify products you can also fetch reviews using reviewsConnection. It was built according to connections spec.
Note: we don't provide reviews for all products right now, it depends on a store itself. If the store does not have shopify reviews app installed then we don't have reviews for the store.
4. Querying Amazon/Shopify Products by ID
The product queries provide a Product which are shared traits across different products. This includes some basic fields like title and description. This is useful for displaying products on screens where you need to display products across marketplaces together. But, each product marketplace offers extra metadata and in order to expose that to developers, Rye uses GraphQL inline fragments to expose high-fidelity information about each item.
Check out the documentation for this feature here!
5. Querying Products by Vendor Name
This query is useful for paging through a set of products from a vendor from Amazon or Shopify. The example below only selects product IDs, but more fields can be requested as well. As the number of products may be significantly large, it's recommended to paginate through the results.
Check out the documentation for this feature here!
6. Querying Products by Domain
This query is useful for paging through a set of products from a domain from Shopify. For example, if the store's canonical URL is https://abc.myshopify.com, then the domain is abc.myshopify.com, all lowercased.
Check out the documentation for this feature here!
Next Steps
- Check out the tutorial to understand how to use the Product API
- Check out the documentation to start using the Product API
- Run queries on the GraphQL on either of the following playgrounds:
- https://docs.rye.com/graphql
Ensure you have the HTTP headers set
Before testing on https://docs.rye.com/graphql, you will need the correct HTTP headers. Check this guide here on how to get them.
- https://console.rye.com/graphql
- https://docs.rye.com/graphql
Updated 3 months ago