productByID
Retrieve a Product by its ID. 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.
AmazonProduct and ShopifyProduct returned by this query have similarities and differences that are compared in detail here
Arguments
An object containing the product ID.
Set to false by default. If set to true, the query will return additional fields specific to the marketplace the product is from.
For example, if the product is from Amazon, the query will return fields specific to Amazon products.
Returns
Any requested field from an object which implements the Product interface.
The query returns null if the product is not found in the inventory
Usage
import { RyeClient, Marketplace } from "@rye-api/rye-sdk";
const ryeClient = new RyeClient("<AUTH_HEADER>", "<SHOPPER_IP>");
const result = await ryeClient.getProductById({
input: {
id: "B007W3DDUW",
marketplace: "AMAZON",
},
});
Was this page helpful?