If this content did not answer your questions, try searching or contacting our support team for further assistance.
acquia-dam-sdk / Components / ProductsApi
new ProductsApi(
client):ProductsApi
Create an instance of the ProductsApi class.
The Products API provides access to product information stored in Acquia Entries. The API allows you to create, retrieve, delete, and update products.
Provide an instance of ApiClient.
createProduct(
params):Promise<CreateProductResult>
Create a new product
Information about the request
Promise<CreateProductResult>
Promise containing the new Product ID
https://widenv2.docs.apiary.io/#reference/products/products/create-a-new-product
deleteProduct(
id):Promise<void>
Delete a product
string
Product ID
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/products/products/delete
getProduct(
id):Promise<GetProductResult>
Retrieve information about a product
string
Product ID
Promise<GetProductResult>
Promise containing information about a product
https://widenv2.docs.apiary.io/#reference/products/products/retrieve-by-id
listChannels(
params?):Promise<ListChannelsResult>
Retrieve a list of channels
Information about the request
Promise<ListChannelsResult>
Promise containing a list of channels
https://widenv2.docs.apiary.io/#reference/channels/channels/list-channels
listProductCategories(
params?):Promise<ListProductCategoriesResult>
Retrieve a list of product categories
Information about the request
Promise<ListProductCategoriesResult>
Promise containing a list of product categories
https://widenv2.docs.apiary.io/#reference/categories/product-categories/list-product-categories
listProductsByChannel(
params):Promise<ListProductsByChannelResult>
The Channel Products endpoint returns a list of products associated with a given channel in Entries. Only the products and attributes that are configured for the channel will be included in the response
Information about the request
Promise<ListProductsByChannelResult>
Promise containing a list of products in the channel
https://widenv2.docs.apiary.io/#reference/products/products-for-channel/list-products-for-channel
listProductTypes(
params?):Promise<ListProductTypesResult>
Retrieve a list of product types
Information about the request
Promise<ListProductTypesResult>
Promise containing a list of product types
https://widenv2.docs.apiary.io/#reference/product-types/product-types/list-product-types
renameProduct(
id,name):Promise<void>
Change a product's name
string
Product ID
string
New product name
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/products/products/rename
searchProducts(
params?):Promise<SearchProductsResult>
Search for products
Information about the request
Promise<SearchProductsResult>
Promise containing a list of products
https://widenv2.docs.apiary.io/#reference/products/products/list-products-by-search-query
updateAttributes(
params):Promise<void>
Update a product's attribute values
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/products/products/update-attribute-values
updateFeaturedImage(
params):Promise<void>
Update a product's featured image
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/products/products/update-featured-image
updateParentProduct(
params):Promise<void>
Update a product's parent product
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/products/products/update-parent-product
updateProductCategory(
params):Promise<void>
Update a product's categories
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/products/products/update-product-category
updateProductType(
params):Promise<void>
Update a product's type
Information about the request
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/products/products/update-product-type