Skip to content

CatalogProductsApi.md

Latest commit

 

History

History
415 lines (315 loc) · 12 KB

CatalogProductsApi.md

File metadata and controls

415 lines (315 loc) · 12 KB

Flipdish.Api.CatalogProductsApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
ArchiveProduct POST /api/v1.0/{appId}/catalog/products/{catalogItemId}/archive Archive Product
CreateProduct POST /api/v1.0/{appId}/catalog/products Create a Product
DuplicateProduct POST /api/v1.0/{appId}/catalog/products/{catalogItemId}/duplicate Duplicate Product
GetProductById GET /api/v1.0/{appId}/catalog/products/{catalogItemId} Get Product by Id
GetProducts GET /api/v1.0/{appId}/catalog/products Get paginated products by app name id filtered by types
UpdateProduct POST /api/v1.0/{appId}/catalog/products/{catalogItemId} Update Product

ArchiveProduct

void ArchiveProduct (string appId, string catalogItemId)

Archive Product

[BETA - this endpoint is under development, do not use it in your production system]

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class ArchiveProductExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogProductsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 

            try
            {
                // Archive Product
                apiInstance.ArchiveProduct(appId, catalogItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogProductsApi.ArchiveProduct: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

CreateProduct

RestApiResultProduct CreateProduct (string appId, CreateProduct createProduct)

Create a Product

[BETA - this endpoint is under development, do not use it in your production system]

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class CreateProductExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogProductsApi();
            var appId = appId_example;  // string | 
            var createProduct = new CreateProduct(); // CreateProduct | 

            try
            {
                // Create a Product
                RestApiResultProduct result = apiInstance.CreateProduct(appId, createProduct);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogProductsApi.CreateProduct: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
createProduct CreateProduct

Return type

RestApiResultProduct

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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

DuplicateProduct

void DuplicateProduct (string appId, string catalogItemId)

Duplicate Product

[BETA - this endpoint is under development, do not use it in your production system]

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class DuplicateProductExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogProductsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 

            try
            {
                // Duplicate Product
                apiInstance.DuplicateProduct(appId, catalogItemId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogProductsApi.DuplicateProduct: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

GetProductById

Product GetProductById (string appId, string catalogItemId)

Get Product by Id

[BETA - this endpoint is under development, do not use it in your production system]

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetProductByIdExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogProductsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 

            try
            {
                // Get Product by Id
                Product result = apiInstance.GetProductById(appId, catalogItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogProductsApi.GetProductById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string

Return type

Product

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

GetProducts

RestApiPaginationResultProduct GetProducts (string appId, List productTypes, string searchTerm = null, int? page = null, int? limit = null)

Get paginated products by app name id filtered by types

[BETA - this endpoint is under development, do not use it in your production system]

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetProductsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogProductsApi();
            var appId = appId_example;  // string | 
            var productTypes = productTypes_example;  // List<string> | 
            var searchTerm = searchTerm_example;  // string |  (optional) 
            var page = 56;  // int? |  (optional) 
            var limit = 56;  // int? |  (optional) 

            try
            {
                // Get paginated products by app name id filtered by types
                RestApiPaginationResultProduct result = apiInstance.GetProducts(appId, productTypes, searchTerm, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogProductsApi.GetProducts: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
productTypes List<string>
searchTerm string [optional]
page int? [optional]
limit int? [optional]

Return type

RestApiPaginationResultProduct

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

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

UpdateProduct

void UpdateProduct (string appId, string catalogItemId, UpdateProduct updateProduct)

Update Product

[BETA - this endpoint is under development, do not use it in your production system]

Example

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class UpdateProductExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new CatalogProductsApi();
            var appId = appId_example;  // string | 
            var catalogItemId = catalogItemId_example;  // string | 
            var updateProduct = new UpdateProduct(); // UpdateProduct | 

            try
            {
                // Update Product
                apiInstance.UpdateProduct(appId, catalogItemId, updateProduct);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CatalogProductsApi.UpdateProduct: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
appId string
catalogItemId string
updateProduct UpdateProduct

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

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