Requires
product
orcollection
orcomments
access scope. For more access scope
The Product APIs allow developers to manage all aspects of products and collections within a store, including product details, variants, images, collections, and reviews. These APIs provide comprehensive tools for organizing and enhancing the shopping experience for both merchants and customers.s.
Product Domain Model Diagram
Available APIs:
-
Product:
APIs under this category help manage individual products in the store, including creation, retrieval, updates, and deletion. -
Product Variant:
A product variant represents a specific combination of options (e.g., size, color) for a single product.
Example: A T-shirt may have options likesize
andcolor
, resulting in variants such asL size and blue color T-shirt
. -
Product Image:
Manage images associated with a single product, including uploading, updating, and deleting images. -
Collection:
Collections group similar products, enabling merchants to create logical groupings for easier customer navigation. -
Collect:
The collect resource connects a product to a collection. For every single product in a collection, there's a collect record that tracks the IDs of both the product and the collection. -
Comment:
Manage product reviews, feedback, or internal notes to enhance customer engagement and product quality.
Noted:
ISO-8601 format with UTC timezone is required for date time related parameter.