Method | Description | |
---|---|---|
CatalogModuleApi ( |
Initializes a new instance of the CatalogModuleApi class.
|
|
CatalogModuleApi ( String basePath ) : System |
Initializes a new instance of the CatalogModuleApi class.
|
|
CatalogModuleCatalogsCreate ( |
Creates the specified catalog. Creates the specified catalog
|
|
CatalogModuleCatalogsCreateAsync ( |
Creates the specified catalog. Creates the specified catalog
|
|
CatalogModuleCatalogsDelete ( string id ) : void |
Deletes catalog by id. Deletes catalog by id
|
|
CatalogModuleCatalogsDeleteAsync ( string id ) : System.Threading.Tasks.Task |
Deletes catalog by id. Deletes catalog by id
|
|
CatalogModuleCatalogsGet ( string id ) : |
Gets Catalog by id. Gets Catalog by id with full information loaded
|
|
CatalogModuleCatalogsGetAsync ( string id ) : System.Threading.Tasks.Task |
Gets Catalog by id. Gets Catalog by id with full information loaded
|
|
CatalogModuleCatalogsGetCatalogs ( ) : List |
Get Catalogs list Get common and virtual Catalogs list with minimal information included. Returns array of Catalog
|
|
CatalogModuleCatalogsGetCatalogsAsync ( ) : System.Threading.Tasks.Task
|
Get Catalogs list Get common and virtual Catalogs list with minimal information included. Returns array of Catalog
|
|
CatalogModuleCatalogsGetNewCatalog ( ) : |
Gets the template for a new catalog. Gets the template for a new common catalog
|
|
CatalogModuleCatalogsGetNewCatalogAsync ( ) : System.Threading.Tasks.Task |
Gets the template for a new catalog. Gets the template for a new common catalog
|
|
CatalogModuleCatalogsGetNewVirtualCatalog ( ) : |
Gets the template for a new virtual catalog.
|
|
CatalogModuleCatalogsGetNewVirtualCatalogAsync ( ) : System.Threading.Tasks.Task |
Gets the template for a new virtual catalog.
|
|
CatalogModuleCatalogsUpdate ( |
Updates the specified catalog. Updates the specified catalog.
|
|
CatalogModuleCatalogsUpdateAsync ( |
Updates the specified catalog. Updates the specified catalog.
|
|
CatalogModuleCategoriesCreateOrUpdateCategory ( |
Creates or updates the specified category. If category.id is null, a new category is created. It's updated otherwise
|
|
CatalogModuleCategoriesCreateOrUpdateCategoryAsync ( |
Creates or updates the specified category. If category.id is null, a new category is created. It's updated otherwise
|
|
CatalogModuleCategoriesDelete ( List |
Deletes the specified categories by id.
|
|
CatalogModuleCategoriesDeleteAsync ( List |
Deletes the specified categories by id.
|
|
CatalogModuleCategoriesGet ( string id ) : |
Gets category by id.
|
|
CatalogModuleCategoriesGetAsync ( string id ) : System.Threading.Tasks.Task |
Gets category by id.
|
|
CatalogModuleCategoriesGetNewCategory ( string catalogId, string parentCategoryId ) : |
Gets the template for a new category.
|
|
CatalogModuleCategoriesGetNewCategoryAsync ( string catalogId, string parentCategoryId ) : System.Threading.Tasks.Task |
Gets the template for a new category.
|
|
CatalogModuleExportImportDoExport ( |
Start catalog data export process. Data export is an async process. An ExportNotification is returned for progress reporting.
|
|
CatalogModuleExportImportDoExportAsync ( |
Start catalog data export process. Data export is an async process. An ExportNotification is returned for progress reporting.
|
|
CatalogModuleExportImportDoImport ( |
Start catalog data import process. Data import is an async process. An ImportNotification is returned for progress reporting.
|
|
CatalogModuleExportImportDoImportAsync ( |
Start catalog data import process. Data import is an async process. An ImportNotification is returned for progress reporting.
|
|
CatalogModuleExportImportGetMappingConfiguration ( string fileUrl, string delimiter ) : |
Gets the CSV mapping configuration. Analyses the supplied file's structure and returns automatic column mapping.
|
|
CatalogModuleExportImportGetMappingConfigurationAsync ( string fileUrl, string delimiter ) : System.Threading.Tasks.Task |
Gets the CSV mapping configuration. Analyses the supplied file's structure and returns automatic column mapping.
|
|
CatalogModuleListEntryCreateLinks ( List |
Creates links for categories or items to parent categories and catalogs.
|
|
CatalogModuleListEntryCreateLinksAsync ( List |
Creates links for categories or items to parent categories and catalogs.
|
|
CatalogModuleListEntryDeleteLinks ( List |
Unlinks the linked categories or items from parent categories and catalogs.
|
|
CatalogModuleListEntryDeleteLinksAsync ( List |
Unlinks the linked categories or items from parent categories and catalogs.
|
|
CatalogModuleListEntryListItemsSearch ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCategoryId, string criteriaCatalogId, int criteriaStart, int criteriaCount ) : |
Searches for the items by complex criteria.
|
|
CatalogModuleListEntryListItemsSearchAsync ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCategoryId, string criteriaCatalogId, int criteriaStart, int criteriaCount ) : System.Threading.Tasks.Task |
Searches for the items by complex criteria.
|
|
CatalogModuleListEntryMove ( |
Move categories or products to another location.
|
|
CatalogModuleListEntryMoveAsync ( |
Move categories or products to another location.
|
|
CatalogModuleProductsDelete ( List |
Deletes the specified items by id.
|
|
CatalogModuleProductsDeleteAsync ( List |
Deletes the specified items by id.
|
|
CatalogModuleProductsGet ( string id ) : |
Gets item by id.
|
|
CatalogModuleProductsGetAsync ( string id ) : System.Threading.Tasks.Task |
Gets item by id.
|
|
CatalogModuleProductsGetNewProductByCatalog ( string catalogId ) : |
Gets the template for a new product (outside of category). Use when need to create item belonging to catalog directly.
|
|
CatalogModuleProductsGetNewProductByCatalogAndCategory ( string catalogId, string categoryId ) : |
Gets the template for a new product (inside category). Use when need to create item belonging to catalog category.
|
|
CatalogModuleProductsGetNewProductByCatalogAndCategoryAsync ( string catalogId, string categoryId ) : System.Threading.Tasks.Task |
Gets the template for a new product (inside category). Use when need to create item belonging to catalog category.
|
|
CatalogModuleProductsGetNewProductByCatalogAsync ( string catalogId ) : System.Threading.Tasks.Task |
Gets the template for a new product (outside of category). Use when need to create item belonging to catalog directly.
|
|
CatalogModuleProductsGetNewVariation ( string productId ) : |
Gets the template for a new variation.
|
|
CatalogModuleProductsGetNewVariationAsync ( string productId ) : System.Threading.Tasks.Task |
Gets the template for a new variation.
|
|
CatalogModuleProductsUpdate ( |
Updates the specified product.
|
|
CatalogModuleProductsUpdateAsync ( |
Updates the specified product.
|
|
CatalogModulePropertiesCreateOrUpdateProperty ( |
Creates or updates the specified property. If property.IsNew == True, a new property is created. It's updated otherwise
|
|
CatalogModulePropertiesCreateOrUpdatePropertyAsync ( |
Creates or updates the specified property. If property.IsNew == True, a new property is created. It's updated otherwise
|
|
CatalogModulePropertiesDelete ( string id ) : void |
Deletes property by id.
|
|
CatalogModulePropertiesDeleteAsync ( string id ) : System.Threading.Tasks.Task |
Deletes property by id.
|
|
CatalogModulePropertiesGet ( string propertyId ) : |
Gets property metainformation by id.
|
|
CatalogModulePropertiesGetAsync ( string propertyId ) : System.Threading.Tasks.Task |
Gets property metainformation by id.
|
|
CatalogModulePropertiesGetNewCatalogProperty ( string catalogId ) : |
Gets the template for a new catalog property.
|
|
CatalogModulePropertiesGetNewCatalogPropertyAsync ( string catalogId ) : System.Threading.Tasks.Task |
Gets the template for a new catalog property.
|
|
CatalogModulePropertiesGetNewCategoryProperty ( string categoryId ) : |
Gets the template for a new category property.
|
|
CatalogModulePropertiesGetNewCategoryPropertyAsync ( string categoryId ) : System.Threading.Tasks.Task |
Gets the template for a new category property.
|
|
CatalogModulePropertiesGetPropertyValues ( string propertyId, string keyword ) : List |
Gets all dictionary values that specified property can have.
|
|
CatalogModulePropertiesGetPropertyValuesAsync ( string propertyId, string keyword ) : System.Threading.Tasks.Task
|
Gets all dictionary values that specified property can have.
|
|
GetBasePath ( ) : String |
Gets the base path of the API client.
|
|
SetBasePath ( String basePath ) : void |
Sets the base path of the API client.
|
public CatalogModuleApi ( |
||
apiClient | an instance of ApiClient (optional) | |
return | System |
public CatalogModuleApi ( String basePath ) : System | ||
basePath | String | |
return | System |
public CatalogModuleCatalogsCreate ( |
||
catalog | The catalog to create | |
return |
public CatalogModuleCatalogsCreateAsync ( |
||
catalog | The catalog to create | |
return | System.Threading.Tasks.Task |
public CatalogModuleCatalogsDelete ( string id ) : void | ||
id | string | Catalog id. |
return | void |
public CatalogModuleCatalogsDeleteAsync ( string id ) : System.Threading.Tasks.Task | ||
id | string | Catalog id. |
return | System.Threading.Tasks.Task |
public CatalogModuleCatalogsGet ( string id ) : |
||
id | string | The Catalog id. |
return |
public CatalogModuleCatalogsGetAsync ( string id ) : System.Threading.Tasks.Task |
||
id | string | The Catalog id. |
return | System.Threading.Tasks.Task |
public CatalogModuleCatalogsGetCatalogs ( ) : List |
||
return | List |
public CatalogModuleCatalogsGetCatalogsAsync ( ) : System.Threading.Tasks.Task
|
||
return | System.Threading.Tasks.Task
|
public CatalogModuleCatalogsGetNewCatalog ( ) : |
||
return |
public CatalogModuleCatalogsGetNewCatalogAsync ( ) : System.Threading.Tasks.Task |
||
return | System.Threading.Tasks.Task |
public CatalogModuleCatalogsGetNewVirtualCatalog ( ) : |
||
return |
public CatalogModuleCatalogsGetNewVirtualCatalogAsync ( ) : System.Threading.Tasks.Task |
||
return | System.Threading.Tasks.Task |
public CatalogModuleCatalogsUpdate ( |
||
catalog | The catalog. | |
return | void |
public CatalogModuleCatalogsUpdateAsync ( |
||
catalog | The catalog. | |
return | System.Threading.Tasks.Task |
public CatalogModuleCategoriesCreateOrUpdateCategory ( |
||
category | The category. | |
return | void |
public CatalogModuleCategoriesCreateOrUpdateCategoryAsync ( |
||
category | The category. | |
return | System.Threading.Tasks.Task |
public CatalogModuleCategoriesDelete ( List |
||
ids | List |
The categories ids. |
return | void |
public CatalogModuleCategoriesDeleteAsync ( List |
||
ids | List |
The categories ids. |
return | System.Threading.Tasks.Task |
public CatalogModuleCategoriesGet ( string id ) : |
||
id | string | Category id. |
return |
public CatalogModuleCategoriesGetAsync ( string id ) : System.Threading.Tasks.Task |
||
id | string | Category id. |
return | System.Threading.Tasks.Task |
public CatalogModuleCategoriesGetNewCategory ( string catalogId, string parentCategoryId ) : |
||
catalogId | string | The catalog id. |
parentCategoryId | string | The parent category id. (Optional) |
return |
public CatalogModuleCategoriesGetNewCategoryAsync ( string catalogId, string parentCategoryId ) : System.Threading.Tasks.Task |
||
catalogId | string | The catalog id. |
parentCategoryId | string | The parent category id. (Optional) |
return | System.Threading.Tasks.Task |
public CatalogModuleExportImportDoExport ( |
||
exportInfo | The export configuration. | |
return | VirtoCommerceCatalogModuleWebModelEventNotificationsExportNotification |
public CatalogModuleExportImportDoExportAsync ( |
||
exportInfo | The export configuration. | |
return | System.Threading.Tasks.Task |
public CatalogModuleExportImportDoImport ( |
||
importInfo | The import data configuration. | |
return |
public CatalogModuleExportImportDoImportAsync ( |
||
importInfo | The import data configuration. | |
return | System.Threading.Tasks.Task |
public CatalogModuleExportImportGetMappingConfiguration ( string fileUrl, string delimiter ) : |
||
fileUrl | string | The file URL. |
delimiter | string | The CSV delimiter. |
return |
public CatalogModuleExportImportGetMappingConfigurationAsync ( string fileUrl, string delimiter ) : System.Threading.Tasks.Task |
||
fileUrl | string | The file URL. |
delimiter | string | The CSV delimiter. |
return | System.Threading.Tasks.Task |
public CatalogModuleListEntryCreateLinks ( List |
||
links | List |
The links. |
return | void |
public CatalogModuleListEntryCreateLinksAsync ( List |
||
links | List |
The links. |
return | System.Threading.Tasks.Task |
public CatalogModuleListEntryDeleteLinks ( List |
||
links | List |
The links. |
return | void |
public CatalogModuleListEntryDeleteLinksAsync ( List |
||
links | List |
The links. |
return | System.Threading.Tasks.Task |
public CatalogModuleListEntryListItemsSearch ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCategoryId, string criteriaCatalogId, int criteriaStart, int criteriaCount ) : |
||
criteriaResponseGroup | string | Gets or sets the response group to define which types of entries to search for. |
criteriaKeyword | string | Gets or sets the keyword to search for. |
criteriaCategoryId | string | Gets or sets the category identifier. |
criteriaCatalogId | string | Gets or sets the catalog identifier. |
criteriaStart | int | Gets or sets the start index of total results from which entries should be returned. |
criteriaCount | int | Gets or sets the maximum count of results to return. |
return |
public CatalogModuleListEntryListItemsSearchAsync ( string criteriaResponseGroup, string criteriaKeyword, string criteriaCategoryId, string criteriaCatalogId, int criteriaStart, int criteriaCount ) : System.Threading.Tasks.Task |
||
criteriaResponseGroup | string | Gets or sets the response group to define which types of entries to search for. |
criteriaKeyword | string | Gets or sets the keyword to search for. |
criteriaCategoryId | string | Gets or sets the category identifier. |
criteriaCatalogId | string | Gets or sets the catalog identifier. |
criteriaStart | int | Gets or sets the start index of total results from which entries should be returned. |
criteriaCount | int | Gets or sets the maximum count of results to return. |
return | System.Threading.Tasks.Task |
public CatalogModuleListEntryMove ( |
||
moveInfo | Move operation details | |
return | void |
public CatalogModuleListEntryMoveAsync ( |
||
moveInfo | Move operation details | |
return | System.Threading.Tasks.Task |
public CatalogModuleProductsDelete ( List |
||
ids | List |
The items ids. |
return | void |
public CatalogModuleProductsDeleteAsync ( List |
||
ids | List |
The items ids. |
return | System.Threading.Tasks.Task |
public CatalogModuleProductsGet ( string id ) : |
||
id | string | Item id. |
return |
public CatalogModuleProductsGetAsync ( string id ) : System.Threading.Tasks.Task |
||
id | string | Item id. |
return | System.Threading.Tasks.Task |
public CatalogModuleProductsGetNewProductByCatalog ( string catalogId ) : |
||
catalogId | string | The catalog id. |
return |
public CatalogModuleProductsGetNewProductByCatalogAndCategory ( string catalogId, string categoryId ) : |
||
catalogId | string | The catalog id. |
categoryId | string | The category id. |
return |
public CatalogModuleProductsGetNewProductByCatalogAndCategoryAsync ( string catalogId, string categoryId ) : System.Threading.Tasks.Task |
||
catalogId | string | The catalog id. |
categoryId | string | The category id. |
return | System.Threading.Tasks.Task |
public CatalogModuleProductsGetNewProductByCatalogAsync ( string catalogId ) : System.Threading.Tasks.Task |
||
catalogId | string | The catalog id. |
return | System.Threading.Tasks.Task |
public CatalogModuleProductsGetNewVariation ( string productId ) : |
||
productId | string | The parent product id. |
return |
public CatalogModuleProductsGetNewVariationAsync ( string productId ) : System.Threading.Tasks.Task |
||
productId | string | The parent product id. |
return | System.Threading.Tasks.Task |
public CatalogModuleProductsUpdate ( |
||
product | The product. | |
return | void |
public CatalogModuleProductsUpdateAsync ( |
||
product | The product. | |
return | System.Threading.Tasks.Task |
public CatalogModulePropertiesCreateOrUpdateProperty ( |
||
property | The property. | |
return | void |
public CatalogModulePropertiesCreateOrUpdatePropertyAsync ( |
||
property | The property. | |
return | System.Threading.Tasks.Task |
public CatalogModulePropertiesDelete ( string id ) : void | ||
id | string | The property id. |
return | void |
public CatalogModulePropertiesDeleteAsync ( string id ) : System.Threading.Tasks.Task | ||
id | string | The property id. |
return | System.Threading.Tasks.Task |
public CatalogModulePropertiesGet ( string propertyId ) : |
||
propertyId | string | The property id. |
return |
public CatalogModulePropertiesGetAsync ( string propertyId ) : System.Threading.Tasks.Task |
||
propertyId | string | The property id. |
return | System.Threading.Tasks.Task |
public CatalogModulePropertiesGetNewCatalogProperty ( string catalogId ) : |
||
catalogId | string | The catalog id. |
return |
public CatalogModulePropertiesGetNewCatalogPropertyAsync ( string catalogId ) : System.Threading.Tasks.Task |
||
catalogId | string | The catalog id. |
return | System.Threading.Tasks.Task |
public CatalogModulePropertiesGetNewCategoryProperty ( string categoryId ) : |
||
categoryId | string | The category id. |
return |
public CatalogModulePropertiesGetNewCategoryPropertyAsync ( string categoryId ) : System.Threading.Tasks.Task |
||
categoryId | string | The category id. |
return | System.Threading.Tasks.Task |
public CatalogModulePropertiesGetPropertyValues ( string propertyId, string keyword ) : List |
||
propertyId | string | The property id. |
keyword | string | The keyword. (Optional) |
return | List |
public CatalogModulePropertiesGetPropertyValuesAsync ( string propertyId, string keyword ) : System.Threading.Tasks.Task
|
||
propertyId | string | The property id. |
keyword | string | The keyword. (Optional) |
return | System.Threading.Tasks.Task
|
public SetBasePath ( String basePath ) : void | ||
basePath | String | The base path |
return | void |