ProductsResource

products.ProductsResource

Properties

variantsProductVariantsResourceRequired

Methods

list

list(query?, customHeaders?): ResponsePromise<StoreProductsListRes>

Parameters

queryStoreGetProductsParams

is optional. Can contain a limit and offset for the returned list

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreProductsListRes>

ResponsePromiseResponsePromise<StoreProductsListRes>Required

Description

Retrieves a list of products

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<StoreProductsRes>

Parameters

idstringRequired

is required

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreProductsRes>

ResponsePromiseResponsePromise<StoreProductsRes>Required

Description

Retrieves a single Product

---

search

search(searchOptions, customHeaders?): ResponsePromise<StorePostSearchRes>

Parameters

searchOptionsStorePostSearchReqRequired

is required

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StorePostSearchRes>

ResponsePromiseResponsePromise<StorePostSearchRes>Required

Description

Searches for products