new module:api/CatalogsApi(apiClient)
Constructs a new CatalogsApi.
Parameters:
| Name | Type | Description |
|---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, default to module:ApiClient#instance if unspecified. |
- Source:
Methods
catalogsByCatalogIdAndCatalogVersionIdWithHttpInfo(catalogId, catalogVersionId, opts) → {Promise}
CatalogsByCatalogIdAndCatalogVersionId Returns information about catalog version that exists for the current base store.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
catalogId |
String | Catalog identifier |
||||||
catalogVersionId |
String | Catalog version identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/CatalogVersion and HTTP response
- Type
- Promise
catalogsByCatalogIdWithHttpInfo(catalogId, opts) → {Promise}
getCatalog Returns a information about a catalog based on its ID, along with versions defined for the current base store.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
catalogId |
String | Catalog identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Catalog and HTTP response
- Type
- Promise
catalogsCategoriesCategoryIdByCatalogIdWithHttpInfo(catalogId, catalogVersionId, categoryId, opts) → {Promise}
getCategory Returns information about category that exists in a catalog version available for the current base store.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
catalogId |
String | Catalog identifier |
||||||||||||
catalogVersionId |
String | Catalog version identifier |
||||||||||||
categoryId |
String | Category identifier |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/CategoryHierarchy and HTTP response
- Type
- Promise
catalogsWithHttpInfo(opts) → {Promise}
Catalogs Returns all catalogs with versions defined for the base store.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/CatalogList and HTTP response
- Type
- Promise
getCatalog(catalogId, opts) → {Promise}
getCatalog Returns a information about a catalog based on its ID, along with versions defined for the current base store.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
catalogId |
String | Catalog identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/Catalog
- Type
- Promise
getCatalogs(opts) → {Promise}
Catalogs Returns all catalogs with versions defined for the base store.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/CatalogList
- Type
- Promise
getCatalogsByCatalogIdAndCatalogVersionId(catalogId, catalogVersionId, opts) → {Promise}
CatalogsByCatalogIdAndCatalogVersionId Returns information about catalog version that exists for the current base store.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
catalogId |
String | Catalog identifier |
||||||
catalogVersionId |
String | Catalog version identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/CatalogVersion
- Type
- Promise
getCategory(catalogId, catalogVersionId, categoryId, opts) → {Promise}
getCategory Returns information about category that exists in a catalog version available for the current base store.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
catalogId |
String | Catalog identifier |
||||||||||||
catalogVersionId |
String | Catalog version identifier |
||||||||||||
categoryId |
String | Category identifier |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/CategoryHierarchy
- Type
- Promise