requestAmazonProductByURL
Used to request individual Amazon products. This operation returns a productId
field which should be stored on your end for the next step.
requestShopifyProductByURL
Used to request individual Shopify products. This operation returns both a canonicalDomain
and productId
field, both of which should be stored on your end for use in the next step.
requestStoreByURL
Used to request entire Shopify stores. This operation returns a canonicalDomain
value which you should keep track of for the next step.
canonicalDomain
and productId
. Both of these fields should be stored on your end, as they are useful for subsequent API operations. canonicalDomain
can be used with productsByDomainV2
, and productId
can be used with productByID
to retrieve information about this product at a later date.
These mutations will add your requested product or store to a queue, and it will eventually be processed by our system. This process can take up to 24 hours, but usually completes within a few minutes. You can verify that the data has pulled through to Rye’s systems by querying for the product.
productByID
Used to retrieve information about a specific product. This works for both Amazon and Shopify products. You will need a productId
value here, which you should have stored from Step 1.
productsByDomainV2
Used to retrieve all products from a specific store. This works for Shopify stores. You will need a canonicalDomain
value here, which you should have stored from Step 1.
productsByDomainV2
—unless you are selling Amazon products—as it allows you to query product data efficiently in bulk as opposed to fetching everything one-by-one. The following GraphQL documents will retrieve information about the Gymshark leggings we requested in Step 1:
productId
or canonicalDomain
values from Step 1?You can call the relevant request operation again; requesting the same product or store URL multiple times will only count once towards your API usage limits.id
and title
. Check out the following API reference pages for a complete listing of fields available to query:
PRODUCT_UPDATED
webhook event.