Skip to content

Files

Latest commit

 

History

History
1389 lines (1146 loc) · 60.3 KB

CategoryApi.md

File metadata and controls

1389 lines (1146 loc) · 60.3 KB

Org.OpenAPITools.Api.CategoryApi

All URIs are relative to https://api.api2cart.com/v1.1

Method HTTP request Description
CategoryAdd POST /category.add.json category.add
CategoryAddBatch POST /category.add.batch.json category.add.batch
CategoryAssign POST /category.assign.json category.assign
CategoryCount GET /category.count.json category.count
CategoryDelete DELETE /category.delete.json category.delete
CategoryFind GET /category.find.json category.find
CategoryImageAdd POST /category.image.add.json category.image.add
CategoryImageDelete DELETE /category.image.delete.json category.image.delete
CategoryInfo GET /category.info.json category.info
CategoryList GET /category.list.json category.list
CategoryUnassign POST /category.unassign.json category.unassign
CategoryUpdate PUT /category.update.json category.update

CategoryAdd

CategoryAdd200Response CategoryAdd (string name, string? description = null, string? shortDescription = null, string? parentId = null, bool? avail = null, string? createdTime = null, string? modifiedTime = null, int? sortOrder = null, string? metaTitle = null, string? metaDescription = null, string? metaKeywords = null, string? seoUrl = null, string? storeId = null, string? storesIds = null, string? langId = null)

category.add

Add new category in store

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var name = Shoes;  // string | Defines category's name that has to be added
            var description = Test category;  // string? | Defines category's description (optional) 
            var shortDescription = Short description. This is very short description;  // string? | Defines short description (optional) 
            var parentId = 6;  // string? | Adds categories specified by parent id (optional) 
            var avail = false;  // bool? | Defines category's visibility status (optional)  (default to true)
            var createdTime = 2014-01-30 15:58:41;  // string? | Entity's date creation (optional) 
            var modifiedTime = 2014-07-30 15:58:41;  // string? | Entity's date modification (optional) 
            var sortOrder = 2;  // int? | Sort number in the list (optional)  (default to 0)
            var metaTitle = category,test;  // string? | Defines unique meta title for each entity (optional) 
            var metaDescription = category,test;  // string? | Defines unique meta description of a entity (optional) 
            var metaKeywords = category,test;  // string? | Defines unique meta keywords for each entity (optional) 
            var seoUrl = category,test;  // string? | Defines unique category's URL for SEO (optional) 
            var storeId = 1;  // string? | Store Id (optional) 
            var storesIds = 1,2;  // string? | Create category in the stores that is specified by comma-separated stores' id (optional) 
            var langId = 3;  // string? | Language id (optional) 

            try
            {
                // category.add
                CategoryAdd200Response result = apiInstance.CategoryAdd(name, description, shortDescription, parentId, avail, createdTime, modifiedTime, sortOrder, metaTitle, metaDescription, metaKeywords, seoUrl, storeId, storesIds, langId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryAdd: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryAddWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.add
    ApiResponse<CategoryAdd200Response> response = apiInstance.CategoryAddWithHttpInfo(name, description, shortDescription, parentId, avail, createdTime, modifiedTime, sortOrder, metaTitle, metaDescription, metaKeywords, seoUrl, storeId, storesIds, langId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryAddWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
name string Defines category's name that has to be added
description string? Defines category's description [optional]
shortDescription string? Defines short description [optional]
parentId string? Adds categories specified by parent id [optional]
avail bool? Defines category's visibility status [optional] [default to true]
createdTime string? Entity's date creation [optional]
modifiedTime string? Entity's date modification [optional]
sortOrder int? Sort number in the list [optional] [default to 0]
metaTitle string? Defines unique meta title for each entity [optional]
metaDescription string? Defines unique meta description of a entity [optional]
metaKeywords string? Defines unique meta keywords for each entity [optional]
seoUrl string? Defines unique category's URL for SEO [optional]
storeId string? Store Id [optional]
storesIds string? Create category in the stores that is specified by comma-separated stores' id [optional]
langId string? Language id [optional]

Return type

CategoryAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryAddBatch

CategoryAddBatch200Response CategoryAddBatch (CategoryAddBatch categoryAddBatch)

category.add.batch

Add new categories to the store.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryAddBatchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var categoryAddBatch = new CategoryAddBatch(); // CategoryAddBatch | 

            try
            {
                // category.add.batch
                CategoryAddBatch200Response result = apiInstance.CategoryAddBatch(categoryAddBatch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryAddBatch: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryAddBatchWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.add.batch
    ApiResponse<CategoryAddBatch200Response> response = apiInstance.CategoryAddBatchWithHttpInfo(categoryAddBatch);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryAddBatchWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
categoryAddBatch CategoryAddBatch

Return type

CategoryAddBatch200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryAssign

CartConfigUpdate200Response CategoryAssign (string categoryId, string productId, string? storeId = null)

category.assign

Assign category to product

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryAssignExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var categoryId = 6;  // string | Defines category assign, specified by category id
            var productId = 10;  // string | Defines category assign to the product, specified by product id
            var storeId = 1;  // string? | Store Id (optional) 

            try
            {
                // category.assign
                CartConfigUpdate200Response result = apiInstance.CategoryAssign(categoryId, productId, storeId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryAssign: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryAssignWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.assign
    ApiResponse<CartConfigUpdate200Response> response = apiInstance.CategoryAssignWithHttpInfo(categoryId, productId, storeId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryAssignWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
categoryId string Defines category assign, specified by category id
productId string Defines category assign to the product, specified by product id
storeId string? Store Id [optional]

Return type

CartConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryCount

CategoryCount200Response CategoryCount (string? parentId = null, string? storeId = null, string? langId = null, bool? avail = null, string? createdFrom = null, string? createdTo = null, string? modifiedFrom = null, string? modifiedTo = null, string? productType = null, string? findValue = null, string? findWhere = null, string? reportRequestId = null, bool? disableReportCache = null)

category.count

Count categories in store.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryCountExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var parentId = 6;  // string? | Counts categories specified by parent id (optional) 
            var storeId = 1;  // string? | Counts category specified by store id (optional) 
            var langId = 3;  // string? | Counts category specified by language id (optional) 
            var avail = false;  // bool? | Defines category's visibility status (optional)  (default to true)
            var createdFrom = 2010-07-29 13:45:52;  // string? | Retrieve entities from their creation date (optional) 
            var createdTo = 2100-08-29 13:45:52;  // string? | Retrieve entities to their creation date (optional) 
            var modifiedFrom = 2010-07-29 13:45:52;  // string? | Retrieve entities from their modification date (optional) 
            var modifiedTo = 2100-08-29 13:45:52;  // string? | Retrieve entities to their modification date (optional) 
            var productType = BICYCLE;  // string? | A categorization for the product (optional) 
            var findValue = Demo category 1;  // string? | Entity search that is specified by some value (optional) 
            var findWhere = email;  // string? | Counts categories that are searched specified by field (optional) 
            var reportRequestId = 105245017661;  // string? | Report request id (optional) 
            var disableReportCache = false;  // bool? | Disable report cache for current request (optional)  (default to false)

            try
            {
                // category.count
                CategoryCount200Response result = apiInstance.CategoryCount(parentId, storeId, langId, avail, createdFrom, createdTo, modifiedFrom, modifiedTo, productType, findValue, findWhere, reportRequestId, disableReportCache);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryCount: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryCountWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.count
    ApiResponse<CategoryCount200Response> response = apiInstance.CategoryCountWithHttpInfo(parentId, storeId, langId, avail, createdFrom, createdTo, modifiedFrom, modifiedTo, productType, findValue, findWhere, reportRequestId, disableReportCache);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryCountWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
parentId string? Counts categories specified by parent id [optional]
storeId string? Counts category specified by store id [optional]
langId string? Counts category specified by language id [optional]
avail bool? Defines category's visibility status [optional] [default to true]
createdFrom string? Retrieve entities from their creation date [optional]
createdTo string? Retrieve entities to their creation date [optional]
modifiedFrom string? Retrieve entities from their modification date [optional]
modifiedTo string? Retrieve entities to their modification date [optional]
productType string? A categorization for the product [optional]
findValue string? Entity search that is specified by some value [optional]
findWhere string? Counts categories that are searched specified by field [optional]
reportRequestId string? Report request id [optional]
disableReportCache bool? Disable report cache for current request [optional] [default to false]

Return type

CategoryCount200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryDelete

CategoryDelete200Response CategoryDelete (string id, string? storeId = null)

category.delete

Delete category in store

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var id = 10;  // string | Defines category removal, specified by category id
            var storeId = 1;  // string? | Store Id (optional) 

            try
            {
                // category.delete
                CategoryDelete200Response result = apiInstance.CategoryDelete(id, storeId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryDelete: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryDeleteWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.delete
    ApiResponse<CategoryDelete200Response> response = apiInstance.CategoryDeleteWithHttpInfo(id, storeId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
id string Defines category removal, specified by category id
storeId string? Store Id [optional]

Return type

CategoryDelete200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryFind

CategoryFind200Response CategoryFind (string findValue, string? findWhere = null, string? findParams = null, string? storeId = null, string? langId = null)

category.find

Search category in store. "Laptop" is specified here by default.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryFindExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var findValue = Demo category 1;  // string | Entity search that is specified by some value
            var findWhere = name;  // string? | Entity search that is specified by the comma-separated unique fields (optional)  (default to "name")
            var findParams = regex;  // string? | Entity search that is specified by comma-separated parameters (optional)  (default to "whole_words")
            var storeId = 1;  // string? | Store Id (optional) 
            var langId = 3;  // string? | Language id (optional) 

            try
            {
                // category.find
                CategoryFind200Response result = apiInstance.CategoryFind(findValue, findWhere, findParams, storeId, langId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryFind: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryFindWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.find
    ApiResponse<CategoryFind200Response> response = apiInstance.CategoryFindWithHttpInfo(findValue, findWhere, findParams, storeId, langId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryFindWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
findValue string Entity search that is specified by some value
findWhere string? Entity search that is specified by the comma-separated unique fields [optional] [default to "name"]
findParams string? Entity search that is specified by comma-separated parameters [optional] [default to "whole_words"]
storeId string? Store Id [optional]
langId string? Language id [optional]

Return type

CategoryFind200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryImageAdd

CategoryImageAdd200Response CategoryImageAdd (string categoryId, string imageName, string url, string type, string? storeId = null, string? label = null, string? mime = null, int? position = null)

category.image.add

Add image to category

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryImageAddExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var categoryId = 6;  // string | Defines category id where the image should be added
            var imageName = bag-gray.png;  // string | Defines image's name
            var url = http://docs.api2cart.com/img/logo.png;  // string | Defines URL of the image that has to be added
            var type = base;  // string | Defines image's types that are specified by comma-separated list
            var storeId = 1;  // string? | Store Id (optional) 
            var label = This cool image;  // string? | Defines alternative text that has to be attached to the picture (optional) 
            var mime = image/jpeg;  // string? | Mime type of image http://en.wikipedia.org/wiki/Internet_media_type. (optional) 
            var position = 5;  // int? | Defines image’s position in the list (optional)  (default to 0)

            try
            {
                // category.image.add
                CategoryImageAdd200Response result = apiInstance.CategoryImageAdd(categoryId, imageName, url, type, storeId, label, mime, position);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryImageAdd: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryImageAddWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.image.add
    ApiResponse<CategoryImageAdd200Response> response = apiInstance.CategoryImageAddWithHttpInfo(categoryId, imageName, url, type, storeId, label, mime, position);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryImageAddWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
categoryId string Defines category id where the image should be added
imageName string Defines image's name
url string Defines URL of the image that has to be added
type string Defines image's types that are specified by comma-separated list
storeId string? Store Id [optional]
label string? Defines alternative text that has to be attached to the picture [optional]
mime string? Mime type of image http://en.wikipedia.org/wiki/Internet_media_type. [optional]
position int? Defines image’s position in the list [optional] [default to 0]

Return type

CategoryImageAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryImageDelete

AttributeDelete200Response CategoryImageDelete (string categoryId, string imageId, string? storeId = null)

category.image.delete

Delete image

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryImageDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var categoryId = 6;  // string | Defines category id where the image should be deleted
            var imageId = 82950b84f468edff480680f99cedbe0d;  // string | Define image id
            var storeId = 1;  // string? | Store Id (optional) 

            try
            {
                // category.image.delete
                AttributeDelete200Response result = apiInstance.CategoryImageDelete(categoryId, imageId, storeId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryImageDelete: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryImageDeleteWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.image.delete
    ApiResponse<AttributeDelete200Response> response = apiInstance.CategoryImageDeleteWithHttpInfo(categoryId, imageId, storeId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryImageDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
categoryId string Defines category id where the image should be deleted
imageId string Define image id
storeId string? Store Id [optional]

Return type

AttributeDelete200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryInfo

CategoryInfo200Response CategoryInfo (string id, string? storeId = null, string? langId = null, string? schemaType = null, string? responseFields = null, string? varParams = null, string? exclude = null, string? reportRequestId = null, bool? disableReportCache = null)

category.info

Get category info about category ID*** or specify other category ID.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryInfoExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var id = 10;  // string | Retrieves category's info specified by category id
            var storeId = 1;  // string? | Retrieves category info  specified by store id (optional) 
            var langId = 3;  // string? | Retrieves category info  specified by language id (optional) 
            var schemaType = LISTING;  // string? | The name of the requirements set for the provided schema. (optional) 
            var responseFields = {result{id,name,parent_id,modified_at{value},images}};  // string? | Set this parameter in order to choose which entity fields you want to retrieve (optional) 
            var varParams = id,parent_id,name;  // string? | Set this parameter in order to choose which entity fields you want to retrieve (optional)  (default to "id,parent_id,name,description")
            var exclude = id,parent_id,name;  // string? | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional) 
            var reportRequestId = 105245017661;  // string? | Report request id (optional) 
            var disableReportCache = false;  // bool? | Disable report cache for current request (optional)  (default to false)

            try
            {
                // category.info
                CategoryInfo200Response result = apiInstance.CategoryInfo(id, storeId, langId, schemaType, responseFields, varParams, exclude, reportRequestId, disableReportCache);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryInfo: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryInfoWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.info
    ApiResponse<CategoryInfo200Response> response = apiInstance.CategoryInfoWithHttpInfo(id, storeId, langId, schemaType, responseFields, varParams, exclude, reportRequestId, disableReportCache);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryInfoWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
id string Retrieves category's info specified by category id
storeId string? Retrieves category info specified by store id [optional]
langId string? Retrieves category info specified by language id [optional]
schemaType string? The name of the requirements set for the provided schema. [optional]
responseFields string? Set this parameter in order to choose which entity fields you want to retrieve [optional]
varParams string? Set this parameter in order to choose which entity fields you want to retrieve [optional] [default to "id,parent_id,name,description"]
exclude string? Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all [optional]
reportRequestId string? Report request id [optional]
disableReportCache bool? Disable report cache for current request [optional] [default to false]

Return type

CategoryInfo200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryList

ModelResponseCategoryList CategoryList (int? start = null, int? count = null, string? pageCursor = null, string? storeId = null, string? langId = null, string? parentId = null, bool? avail = null, string? productType = null, string? createdFrom = null, string? createdTo = null, string? modifiedFrom = null, string? modifiedTo = null, string? findValue = null, string? findWhere = null, string? responseFields = null, string? varParams = null, string? exclude = null, string? reportRequestId = null, bool? disableReportCache = null, bool? disableCache = null)

category.list

Get list of categories from store.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryListExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var start = 0;  // int? | This parameter sets the number from which you want to get entities (optional)  (default to 0)
            var count = 20;  // int? | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional)  (default to 10)
            var pageCursor = ;  // string? | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) (optional) 
            var storeId = 1;  // string? | Retrieves categories specified by store id (optional) 
            var langId = 3;  // string? | Retrieves categorys specified by language id (optional) 
            var parentId = 6;  // string? | Retrieves categories specified by parent id (optional) 
            var avail = false;  // bool? | Defines category's visibility status (optional)  (default to true)
            var productType = BICYCLE;  // string? | A categorization for the product (optional) 
            var createdFrom = 2010-07-29 13:45:52;  // string? | Retrieve entities from their creation date (optional) 
            var createdTo = 2100-08-29 13:45:52;  // string? | Retrieve entities to their creation date (optional) 
            var modifiedFrom = 2010-07-29 13:45:52;  // string? | Retrieve entities from their modification date (optional) 
            var modifiedTo = 2100-08-29 13:45:52;  // string? | Retrieve entities to their modification date (optional) 
            var findValue = Demo category 1;  // string? | Entity search that is specified by some value (optional) 
            var findWhere = name;  // string? | Category search that is specified by field (optional) 
            var responseFields = {result{categories_count,category{id,parent_id,modified_at{value},images}}};  // string? | Set this parameter in order to choose which entity fields you want to retrieve (optional) 
            var varParams = id,parent_id,name;  // string? | Set this parameter in order to choose which entity fields you want to retrieve (optional)  (default to "id,parent_id,name,description")
            var exclude = id,parent_id,name;  // string? | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional) 
            var reportRequestId = 105245017661;  // string? | Report request id (optional) 
            var disableReportCache = false;  // bool? | Disable report cache for current request (optional)  (default to false)
            var disableCache = false;  // bool? | Disable cache for current request (optional)  (default to false)

            try
            {
                // category.list
                ModelResponseCategoryList result = apiInstance.CategoryList(start, count, pageCursor, storeId, langId, parentId, avail, productType, createdFrom, createdTo, modifiedFrom, modifiedTo, findValue, findWhere, responseFields, varParams, exclude, reportRequestId, disableReportCache, disableCache);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryList: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryListWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.list
    ApiResponse<ModelResponseCategoryList> response = apiInstance.CategoryListWithHttpInfo(start, count, pageCursor, storeId, langId, parentId, avail, productType, createdFrom, createdTo, modifiedFrom, modifiedTo, findValue, findWhere, responseFields, varParams, exclude, reportRequestId, disableReportCache, disableCache);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryListWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
start int? This parameter sets the number from which you want to get entities [optional] [default to 0]
count int? This parameter sets the entity amount that has to be retrieved. Max allowed count=250 [optional] [default to 10]
pageCursor string? Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) [optional]
storeId string? Retrieves categories specified by store id [optional]
langId string? Retrieves categorys specified by language id [optional]
parentId string? Retrieves categories specified by parent id [optional]
avail bool? Defines category's visibility status [optional] [default to true]
productType string? A categorization for the product [optional]
createdFrom string? Retrieve entities from their creation date [optional]
createdTo string? Retrieve entities to their creation date [optional]
modifiedFrom string? Retrieve entities from their modification date [optional]
modifiedTo string? Retrieve entities to their modification date [optional]
findValue string? Entity search that is specified by some value [optional]
findWhere string? Category search that is specified by field [optional]
responseFields string? Set this parameter in order to choose which entity fields you want to retrieve [optional]
varParams string? Set this parameter in order to choose which entity fields you want to retrieve [optional] [default to "id,parent_id,name,description"]
exclude string? Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all [optional]
reportRequestId string? Report request id [optional]
disableReportCache bool? Disable report cache for current request [optional] [default to false]
disableCache bool? Disable cache for current request [optional] [default to false]

Return type

ModelResponseCategoryList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryUnassign

CartConfigUpdate200Response CategoryUnassign (string categoryId, string productId, string? storeId = null)

category.unassign

Unassign category to product

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryUnassignExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var categoryId = 6;  // string | Defines category unassign, specified by category id
            var productId = 10;  // string | Defines category unassign to the product, specified by product id
            var storeId = 1;  // string? | Store Id (optional) 

            try
            {
                // category.unassign
                CartConfigUpdate200Response result = apiInstance.CategoryUnassign(categoryId, productId, storeId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryUnassign: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryUnassignWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.unassign
    ApiResponse<CartConfigUpdate200Response> response = apiInstance.CategoryUnassignWithHttpInfo(categoryId, productId, storeId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryUnassignWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
categoryId string Defines category unassign, specified by category id
productId string Defines category unassign to the product, specified by product id
storeId string? Store Id [optional]

Return type

CartConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CategoryUpdate

AccountConfigUpdate200Response CategoryUpdate (string id, string? name = null, string? description = null, string? shortDescription = null, string? parentId = null, bool? avail = null, int? sortOrder = null, string? modifiedTime = null, string? metaTitle = null, string? metaDescription = null, string? metaKeywords = null, string? seoUrl = null, string? storeId = null, string? storesIds = null, string? langId = null)

category.update

Update category in store

Example

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class CategoryUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.api2cart.com/v1.1";
            // Configure API key authorization: StoreKeyAuth
            config.AddApiKey("x-store-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-store-key", "Bearer");
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new CategoryApi(config);
            var id = 10;  // string | Defines category update specified by category id
            var name = NEW Shoes;  // string? | Defines new category’s name (optional) 
            var description = New test category;  // string? | Defines new category's description (optional) 
            var shortDescription = Short description. This is very short description;  // string? | Defines short description (optional) 
            var parentId = 6;  // string? | Defines new parent category id (optional) 
            var avail = false;  // bool? | Defines category's visibility status (optional) 
            var sortOrder = 2;  // int? | Sort number in the list (optional) 
            var modifiedTime = 2014-07-30 15:58:41;  // string? | Entity's date modification (optional) 
            var metaTitle = category,test;  // string? | Defines unique meta title for each entity (optional) 
            var metaDescription = category,test;  // string? | Defines unique meta description of a entity (optional) 
            var metaKeywords = category,test;  // string? | Defines unique meta keywords for each entity (optional) 
            var seoUrl = category,test;  // string? | Defines unique category's URL for SEO (optional) 
            var storeId = 1;  // string? | Store Id (optional) 
            var storesIds = 1,2;  // string? | Update category in the stores that is specified by comma-separated stores' id (optional) 
            var langId = 3;  // string? | Language id (optional) 

            try
            {
                // category.update
                AccountConfigUpdate200Response result = apiInstance.CategoryUpdate(id, name, description, shortDescription, parentId, avail, sortOrder, modifiedTime, metaTitle, metaDescription, metaKeywords, seoUrl, storeId, storesIds, langId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling CategoryApi.CategoryUpdate: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CategoryUpdateWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // category.update
    ApiResponse<AccountConfigUpdate200Response> response = apiInstance.CategoryUpdateWithHttpInfo(id, name, description, shortDescription, parentId, avail, sortOrder, modifiedTime, metaTitle, metaDescription, metaKeywords, seoUrl, storeId, storesIds, langId);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling CategoryApi.CategoryUpdateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
id string Defines category update specified by category id
name string? Defines new category’s name [optional]
description string? Defines new category's description [optional]
shortDescription string? Defines short description [optional]
parentId string? Defines new parent category id [optional]
avail bool? Defines category's visibility status [optional]
sortOrder int? Sort number in the list [optional]
modifiedTime string? Entity's date modification [optional]
metaTitle string? Defines unique meta title for each entity [optional]
metaDescription string? Defines unique meta description of a entity [optional]
metaKeywords string? Defines unique meta keywords for each entity [optional]
seoUrl string? Defines unique category's URL for SEO [optional]
storeId string? Store Id [optional]
storesIds string? Update category in the stores that is specified by comma-separated stores' id [optional]
langId string? Language id [optional]

Return type

AccountConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]