CollectionsResource

collections.CollectionsResource

Methods

list

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

Parameters

queryStoreGetCollectionsParams

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

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCollectionsListRes>

ResponsePromiseResponsePromise<StoreCollectionsListRes>Required

Description

Retrieves a list of collections

---

retrieve

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

Parameters

idstringRequired

id of the collection

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<StoreCollectionsRes>

ResponsePromiseResponsePromise<StoreCollectionsRes>Required

Description

Retrieves a single collection