Products
Additional information about this section
Perform actions on an object
- addProductMedia( )
Adds media items to a specified product, either via URL or existing media ID.
- addProductMediaToChoices( )
Links media items that are already associated with a specific product to a choice within the same product.
- addProductsToCollection( )
Adds products to a specified collection.
- bulkAdjustProductProperty( )
Adjusts a specified numerical property for up to 100 products at a time. The property can be increased or decreased either by percentage or amount.
- bulkUpdateProductsProperty( )
Updates a specified property for up to 100 products at a time.
- createCollection( )
Creates a new collection.
- createProduct( )
Creates a new product.
- deleteCollection( )
Deletes a collection.
- deleteProduct( )
Deletes a product.
- deleteProductOptions( )
Delete all options from a specific product. Only available when variant management is disabled.
- getCollectionBySlug( )
Retrieves a collection with the provided slug.
- getProduct( )
Retrieves a product with the provided ID.
- getProductOptionsAvailability( )
Gets the availability of relevant product variants based on the product ID and selections provided. See Use Cases for an example.
- getStoreVariant( )
Retrieves a store variant with the provided ID.
- queryProductVariants( )
Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs. See Stores Pagination for more information.
- queryProducts( )
Returns a list of up to 100 products, given the provided paging, sorting and filtering.
- queryStoreVariants( )
Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
- removeBrand( )
Deletes a product's brand.
- removeProductMedia( )
Removes specified media items from a product. Pass an empty array to remove all media items.
- removeProductMediaFromChoices( )
Removes media items from all or some of a product's choices. (Media items can only be set for choices within one option at a time - e.g., if you set media ...
- removeProductsFromCollection( )
Deletes products from a specified collection.
- removeRibbon( )
Deletes a product's ribbon.
- resetAllProductVariantData( )
Resets the data (such as the price and the weight) of all variants for a given product to their default values.
- updateCollection( )
Updates specified properties of a collection. To add products to a collection, call the addProductsToCollection function.
- updateProduct( )
Updates specified fields in a product.
- updateProductVariants( )
Updates variants of a specified product.