Skip to content

Latest commit

 

History

History
400 lines (310 loc) · 14.7 KB

BrandApi.md

File metadata and controls

400 lines (310 loc) · 14.7 KB

CIN7.DearInventory.Api.BrandApi

All URIs are relative to https://inventory.dearsystems.com/ExternalApi/v2

Method HTTP request Description
RefBrandIdDelete DELETE /ref/brand?ID={ID} DELETE
RefBrandPgLmtNameGet GET /ref/brand?Page={Page}&Limit={Limit}&Name={Name} GET
RefBrandPost POST /ref/brand POST
RefBrandPut PUT /ref/brand PUT

RefBrandIdDelete

MeAddressesIdDelete200Response RefBrandIdDelete (string ID, string? apiAuthAccountid = null, string? apiAuthApplicationkey = null)

DELETE

Example

using System.Collections.Generic;
using System.Diagnostics;
using CIN7.DearInventory.Api;
using CIN7.DearInventory.Client;
using CIN7.DearInventory.Model;

namespace Example
{
    public class RefBrandIdDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new BrandApi(config);
            var ID = "ID_example";  // string | ID of Brand to Delete
            var apiAuthAccountid = 704ef231-cd93-49c9-a201-26b4b5d0d35b;  // string? | e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b (optional)
            var apiAuthApplicationkey = 0342a546-e0c2-0dff-f0be-6a5e17154033;  // string? | e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 (optional)

            try
            {
                // DELETE
                MeAddressesIdDelete200Response result = apiInstance.RefBrandIdDelete(ID, apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandApi.RefBrandIdDelete: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RefBrandIdDeleteWithHttpInfo variant

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

try
{
    // DELETE
    ApiResponse<MeAddressesIdDelete200Response> response = apiInstance.RefBrandIdDeleteWithHttpInfo(ID, apiAuthAccountid, apiAuthApplicationkey);
    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 BrandApi.RefBrandIdDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
ID string ID of Brand to Delete
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

MeAddressesIdDelete200Response

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

RefBrandPgLmtNameGet

RefBrandPgLmtNameGet200Response RefBrandPgLmtNameGet (decimal page, decimal limit, string name, string? apiAuthAccountid = null, string? apiAuthApplicationkey = null)

GET

Example

using System.Collections.Generic;
using System.Diagnostics;
using CIN7.DearInventory.Api;
using CIN7.DearInventory.Client;
using CIN7.DearInventory.Model;

namespace Example
{
    public class RefBrandPgLmtNameGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new BrandApi(config);
            var page = 1MD;  // decimal |  (default to 1M)
            var limit = 100MD;  // decimal |  (default to 100M)
            var name = "name_example";  // string | Only return brands that start with the specific name
            var apiAuthAccountid = 704ef231-cd93-49c9-a201-26b4b5d0d35b;  // string? | e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b (optional)
            var apiAuthApplicationkey = 0342a546-e0c2-0dff-f0be-6a5e17154033;  // string? | e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 (optional)

            try
            {
                // GET
                RefBrandPgLmtNameGet200Response result = apiInstance.RefBrandPgLmtNameGet(page, limit, name, apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandApi.RefBrandPgLmtNameGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RefBrandPgLmtNameGetWithHttpInfo variant

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

try
{
    // GET
    ApiResponse<RefBrandPgLmtNameGet200Response> response = apiInstance.RefBrandPgLmtNameGetWithHttpInfo(page, limit, name, apiAuthAccountid, apiAuthApplicationkey);
    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 BrandApi.RefBrandPgLmtNameGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
page decimal [default to 1M]
limit decimal [default to 100M]
name string Only return brands that start with the specific name
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

RefBrandPgLmtNameGet200Response

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

RefBrandPost

RefBrandPost200Response RefBrandPost (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null)

POST

Example

using System.Collections.Generic;
using System.Diagnostics;
using CIN7.DearInventory.Api;
using CIN7.DearInventory.Client;
using CIN7.DearInventory.Model;

namespace Example
{
    public class RefBrandPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new BrandApi(config);
            var apiAuthAccountid = 704ef231-cd93-49c9-a201-26b4b5d0d35b;  // string? | e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b (optional)
            var apiAuthApplicationkey = 0342a546-e0c2-0dff-f0be-6a5e17154033;  // string? | e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 (optional)

            try
            {
                // POST
                RefBrandPost200Response result = apiInstance.RefBrandPost(apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandApi.RefBrandPost: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RefBrandPostWithHttpInfo variant

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

try
{
    // POST
    ApiResponse<RefBrandPost200Response> response = apiInstance.RefBrandPostWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey);
    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 BrandApi.RefBrandPostWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

RefBrandPost200Response

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

RefBrandPut

RefBrandPutRequest RefBrandPut (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, RefBrandPutRequest? refBrandPutRequest = null)

PUT

Example

using System.Collections.Generic;
using System.Diagnostics;
using CIN7.DearInventory.Api;
using CIN7.DearInventory.Client;
using CIN7.DearInventory.Model;

namespace Example
{
    public class RefBrandPutExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new BrandApi(config);
            var apiAuthAccountid = 704ef231-cd93-49c9-a201-26b4b5d0d35b;  // string? | e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b (optional)
            var apiAuthApplicationkey = 0342a546-e0c2-0dff-f0be-6a5e17154033;  // string? | e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 (optional)
            var refBrandPutRequest = new RefBrandPutRequest?(); // RefBrandPutRequest? |  (optional)

            try
            {
                // PUT
                RefBrandPutRequest result = apiInstance.RefBrandPut(apiAuthAccountid, apiAuthApplicationkey, refBrandPutRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BrandApi.RefBrandPut: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RefBrandPutWithHttpInfo variant

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

try
{
    // PUT
    ApiResponse<RefBrandPutRequest> response = apiInstance.RefBrandPutWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, refBrandPutRequest);
    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 BrandApi.RefBrandPutWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]
refBrandPutRequest RefBrandPutRequest? [optional]

Return type

RefBrandPutRequest

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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