Skip to content

Latest commit

 

History

History
1888 lines (1464 loc) · 77 KB

ReferenceBooksApi.md

File metadata and controls

1888 lines (1464 loc) · 77 KB

CIN7.DearInventory.Api.ReferenceBooksApi

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

Method HTTP request Description
CustomPricesPost POST /custom-prices POST
CustomPricesProductidCustomeridDelete DELETE /custom-prices?ProductID={ProductID}&CustomerID={CustomerID} DELETE
CustomPricesPut PUT /custom-prices PUT
Get GET /reference/shipZonesEnabled Get
ProductSuppliersPost POST /product-suppliers POST
ProductSuppliersProductidGet GET /product-suppliers?ProductID={ProductID} GET
ProductSuppliersProductidSupplieridDelete DELETE /product-suppliers?ProductID={ProductID}&SupplierID={SupplierID} DELETE
ProductSuppliersPut PUT /product-suppliers PUT
ReferenceDealsIdPgLmtSrchGet GET /reference/deals?ID={ID}&Page={Page}&Limit={Limit}&Search={Search} GET
ReferenceDealsPost POST /reference/deals POST
ReferenceDealsPut PUT /reference/deals PUT
ReferenceDiscountIdPgLmtSrchGet GET /reference/discount?ID={ID}&Page={Page}&Limit={Limit}&Search={Search} GET
ReferenceDiscountPost POST /reference/discount POST
ReferenceDiscountPut PUT /reference/discount PUT
ReferenceShipzonesIdPgLmtSrchGet GET /reference/shipZones?ID={ID}&Page={Page}&Limit={Limit}&Search={Search} GET
ReferenceShipzonesPost POST /reference/shipZones POST
ReferenceShipzonesPut PUT /reference/shipZones PUT
ReferenceShipzonesShipzoneidDelete DELETE /reference/shipZones?ShipZoneID ={ShipZoneID} Delete
Update PUT /reference/shipZonesEnabled Update

CustomPricesPost

CustomPricesPut200Response CustomPricesPost (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, CustomPricesPutRequest? customPricesPutRequest = null)

POST

  • Method will create new Customer specific prices for specified products.

Example

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

namespace Example
{
    public class CustomPricesPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 customPricesPutRequest = new CustomPricesPutRequest?(); // CustomPricesPutRequest? |  (optional)

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

Using the CustomPricesPostWithHttpInfo variant

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

try
{
    // POST
    ApiResponse<CustomPricesPut200Response> response = apiInstance.CustomPricesPostWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, customPricesPutRequest);
    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 ReferenceBooksApi.CustomPricesPostWithHttpInfo: " + 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]
customPricesPutRequest CustomPricesPutRequest? [optional]

Return type

CustomPricesPut200Response

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]

CustomPricesProductidCustomeridDelete

void CustomPricesProductidCustomeridDelete (string productID, string customerID, string? apiAuthAccountid = null, string? apiAuthApplicationkey = null)

DELETE

  • Method will delete specified Production BOM of specified product.

Example

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

namespace Example
{
    public class CustomPricesProductidCustomeridDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(config);
            var productID = "productID_example";  // string | Identifier of the Product whose Custom Price will be deleted
            var customerID = "customerID_example";  // string | Identifier of a Customer whose Custom Price will be deleted
            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
                apiInstance.CustomPricesProductidCustomeridDelete(productID, customerID, apiAuthAccountid, apiAuthApplicationkey);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.CustomPricesProductidCustomeridDelete: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CustomPricesProductidCustomeridDeleteWithHttpInfo variant

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

try
{
    // DELETE
    apiInstance.CustomPricesProductidCustomeridDeleteWithHttpInfo(productID, customerID, apiAuthAccountid, apiAuthApplicationkey);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ReferenceBooksApi.CustomPricesProductidCustomeridDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
productID string Identifier of the Product whose Custom Price will be deleted
customerID string Identifier of a Customer whose Custom Price will be deleted
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

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

CustomPricesPut

CustomPricesPut200Response CustomPricesPut (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, CustomPricesPutRequest? customPricesPutRequest = null)

PUT

  • Method will update Production BOM for specified product.

Example

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

namespace Example
{
    public class CustomPricesPutExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 customPricesPutRequest = new CustomPricesPutRequest?(); // CustomPricesPutRequest? |  (optional)

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

Using the CustomPricesPutWithHttpInfo variant

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

try
{
    // PUT
    ApiResponse<CustomPricesPut200Response> response = apiInstance.CustomPricesPutWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, customPricesPutRequest);
    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 ReferenceBooksApi.CustomPricesPutWithHttpInfo: " + 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]
customPricesPutRequest CustomPricesPutRequest? [optional]

Return type

CustomPricesPut200Response

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]

Get

Get200Response Get (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 GetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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
            {
                // Get
                Get200Response result = apiInstance.Get(apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.Get: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetWithHttpInfo variant

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

try
{
    // Get
    ApiResponse<Get200Response> response = apiInstance.GetWithHttpInfo(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 ReferenceBooksApi.GetWithHttpInfo: " + 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

Get200Response

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]

ProductSuppliersPost

MeAddressesIdDelete200Response ProductSuppliersPost (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ProductSuppliersPostRequest? productSuppliersPostRequest = 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 ProductSuppliersPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 productSuppliersPostRequest = new ProductSuppliersPostRequest?(); // ProductSuppliersPostRequest? |  (optional)

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

Using the ProductSuppliersPostWithHttpInfo variant

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

try
{
    // POST
    ApiResponse<MeAddressesIdDelete200Response> response = apiInstance.ProductSuppliersPostWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, productSuppliersPostRequest);
    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 ReferenceBooksApi.ProductSuppliersPostWithHttpInfo: " + 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]
productSuppliersPostRequest ProductSuppliersPostRequest? [optional]

Return type

MeAddressesIdDelete200Response

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]

ProductSuppliersProductidGet

ProductSuppliersProductidGet200Response ProductSuppliersProductidGet (string productID, 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 ProductSuppliersProductidGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(config);
            var productID = "productID_example";  // string | Return product suppliers of a particular Product
            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
                ProductSuppliersProductidGet200Response result = apiInstance.ProductSuppliersProductidGet(productID, apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.ProductSuppliersProductidGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ProductSuppliersProductidGetWithHttpInfo variant

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

try
{
    // GET
    ApiResponse<ProductSuppliersProductidGet200Response> response = apiInstance.ProductSuppliersProductidGetWithHttpInfo(productID, 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 ReferenceBooksApi.ProductSuppliersProductidGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
productID string Return product suppliers of a particular Product
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

ProductSuppliersProductidGet200Response

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]

ProductSuppliersProductidSupplieridDelete

void ProductSuppliersProductidSupplieridDelete (string productID, string supplierID, string? apiAuthAccountid = null, string? apiAuthApplicationkey = null)

DELETE

  • Method will delete specified Product Supplier settings with their Options and Intervals.

Example

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

namespace Example
{
    public class ProductSuppliersProductidSupplieridDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(config);
            var productID = "productID_example";  // string | Identifier of the Product
            var supplierID = "supplierID_example";  // string | Identifier of a Supplier
            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
                apiInstance.ProductSuppliersProductidSupplieridDelete(productID, supplierID, apiAuthAccountid, apiAuthApplicationkey);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.ProductSuppliersProductidSupplieridDelete: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ProductSuppliersProductidSupplieridDeleteWithHttpInfo variant

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

try
{
    // DELETE
    apiInstance.ProductSuppliersProductidSupplieridDeleteWithHttpInfo(productID, supplierID, apiAuthAccountid, apiAuthApplicationkey);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ReferenceBooksApi.ProductSuppliersProductidSupplieridDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
productID string Identifier of the Product
supplierID string Identifier of a Supplier
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

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

ProductSuppliersPut

MeAddressesIdDelete200Response ProductSuppliersPut (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ProductSuppliersPutRequest? productSuppliersPutRequest = 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 ProductSuppliersPutExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 productSuppliersPutRequest = new ProductSuppliersPutRequest?(); // ProductSuppliersPutRequest? |  (optional)

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

Using the ProductSuppliersPutWithHttpInfo variant

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

try
{
    // PUT
    ApiResponse<MeAddressesIdDelete200Response> response = apiInstance.ProductSuppliersPutWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, productSuppliersPutRequest);
    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 ReferenceBooksApi.ProductSuppliersPutWithHttpInfo: " + 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]
productSuppliersPutRequest ProductSuppliersPutRequest? [optional]

Return type

MeAddressesIdDelete200Response

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]

ReferenceDealsIdPgLmtSrchGet

ReferenceDealsIdPgLmtSrchGet200Response ReferenceDealsIdPgLmtSrchGet (string ID, decimal page, decimal limit, string search, 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 ReferenceDealsIdPgLmtSrchGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(config);
            var ID = "ID_example";  // string | Returns detailed info of a particular Product Deal
            var page = 8.14D;  // decimal | Page (Default: 1)
            var limit = 8.14D;  // decimal | Specifies the page size for pagination. Default page size is 25 (Default: 25)
            var search = "search_example";  // string | Only return Product Deal that have the provided text in Name (Default: not set)
            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
                ReferenceDealsIdPgLmtSrchGet200Response result = apiInstance.ReferenceDealsIdPgLmtSrchGet(ID, page, limit, search, apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.ReferenceDealsIdPgLmtSrchGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ReferenceDealsIdPgLmtSrchGetWithHttpInfo variant

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

try
{
    // GET
    ApiResponse<ReferenceDealsIdPgLmtSrchGet200Response> response = apiInstance.ReferenceDealsIdPgLmtSrchGetWithHttpInfo(ID, page, limit, search, 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 ReferenceBooksApi.ReferenceDealsIdPgLmtSrchGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
ID string Returns detailed info of a particular Product Deal
page decimal Page (Default: 1)
limit decimal Specifies the page size for pagination. Default page size is 25 (Default: 25)
search string Only return Product Deal that have the provided text in Name (Default: not set)
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

ReferenceDealsIdPgLmtSrchGet200Response

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]

ReferenceDealsPost

ReferenceDealsPost200Response ReferenceDealsPost (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ReferenceDealsPostRequest? referenceDealsPostRequest = 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 ReferenceDealsPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 referenceDealsPostRequest = new ReferenceDealsPostRequest?(); // ReferenceDealsPostRequest? |  (optional)

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

Using the ReferenceDealsPostWithHttpInfo variant

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

try
{
    // POST
    ApiResponse<ReferenceDealsPost200Response> response = apiInstance.ReferenceDealsPostWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, referenceDealsPostRequest);
    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 ReferenceBooksApi.ReferenceDealsPostWithHttpInfo: " + 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]
referenceDealsPostRequest ReferenceDealsPostRequest? [optional]

Return type

ReferenceDealsPost200Response

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]

ReferenceDealsPut

ReferenceDealsPut200Response ReferenceDealsPut (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ReferenceDealsPutRequest? referenceDealsPutRequest = 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 ReferenceDealsPutExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 referenceDealsPutRequest = new ReferenceDealsPutRequest?(); // ReferenceDealsPutRequest? |  (optional)

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

Using the ReferenceDealsPutWithHttpInfo variant

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

try
{
    // PUT
    ApiResponse<ReferenceDealsPut200Response> response = apiInstance.ReferenceDealsPutWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, referenceDealsPutRequest);
    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 ReferenceBooksApi.ReferenceDealsPutWithHttpInfo: " + 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]
referenceDealsPutRequest ReferenceDealsPutRequest? [optional]

Return type

ReferenceDealsPut200Response

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]

ReferenceDiscountIdPgLmtSrchGet

ReferenceDiscountIdPgLmtSrchGet200Response ReferenceDiscountIdPgLmtSrchGet (string ID, decimal page, decimal limit, string search, 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 ReferenceDiscountIdPgLmtSrchGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(config);
            var ID = "ID_example";  // string | Returns detailed info of a particular Discount Rule
            var page = 8.14D;  // decimal | Page (Default: 1)
            var limit = 8.14D;  // decimal | Specifies the page size for pagination. Default page size is 25 (Default: 25)
            var search = "search_example";  // string | Only return Discount Rules that have the provided text in Name (Default: not set)
            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
                ReferenceDiscountIdPgLmtSrchGet200Response result = apiInstance.ReferenceDiscountIdPgLmtSrchGet(ID, page, limit, search, apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.ReferenceDiscountIdPgLmtSrchGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ReferenceDiscountIdPgLmtSrchGetWithHttpInfo variant

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

try
{
    // GET
    ApiResponse<ReferenceDiscountIdPgLmtSrchGet200Response> response = apiInstance.ReferenceDiscountIdPgLmtSrchGetWithHttpInfo(ID, page, limit, search, 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 ReferenceBooksApi.ReferenceDiscountIdPgLmtSrchGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
ID string Returns detailed info of a particular Discount Rule
page decimal Page (Default: 1)
limit decimal Specifies the page size for pagination. Default page size is 25 (Default: 25)
search string Only return Discount Rules that have the provided text in Name (Default: not set)
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

ReferenceDiscountIdPgLmtSrchGet200Response

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]

ReferenceDiscountPost

ReferenceDiscountPost200Response ReferenceDiscountPost (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ReferenceDiscountPostRequest? referenceDiscountPostRequest = 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 ReferenceDiscountPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 referenceDiscountPostRequest = new ReferenceDiscountPostRequest?(); // ReferenceDiscountPostRequest? |  (optional)

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

Using the ReferenceDiscountPostWithHttpInfo variant

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

try
{
    // POST
    ApiResponse<ReferenceDiscountPost200Response> response = apiInstance.ReferenceDiscountPostWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, referenceDiscountPostRequest);
    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 ReferenceBooksApi.ReferenceDiscountPostWithHttpInfo: " + 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]
referenceDiscountPostRequest ReferenceDiscountPostRequest? [optional]

Return type

ReferenceDiscountPost200Response

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]

ReferenceDiscountPut

ReferenceDiscountPut200Response ReferenceDiscountPut (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ReferenceDiscountPutRequest? referenceDiscountPutRequest = 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 ReferenceDiscountPutExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 referenceDiscountPutRequest = new ReferenceDiscountPutRequest?(); // ReferenceDiscountPutRequest? |  (optional)

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

Using the ReferenceDiscountPutWithHttpInfo variant

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

try
{
    // PUT
    ApiResponse<ReferenceDiscountPut200Response> response = apiInstance.ReferenceDiscountPutWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, referenceDiscountPutRequest);
    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 ReferenceBooksApi.ReferenceDiscountPutWithHttpInfo: " + 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]
referenceDiscountPutRequest ReferenceDiscountPutRequest? [optional]

Return type

ReferenceDiscountPut200Response

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]

ReferenceShipzonesIdPgLmtSrchGet

ReferenceShipzonesIdPgLmtSrchGet200Response ReferenceShipzonesIdPgLmtSrchGet (string ID, decimal page, decimal limit, string search, 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 ReferenceShipzonesIdPgLmtSrchGetExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(config);
            var ID = "ID_example";  // string | Returns detailed info of a particular Shipping zone
            var page = 8.14D;  // decimal | Page (Default: 1)
            var limit = 8.14D;  // decimal | Specifies the page size for pagination. Default page size is 25 (Default: 25)
            var search = "search_example";  // string | Only return Shiping Zones that have the provided text in Name (Default: not set)
            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
                ReferenceShipzonesIdPgLmtSrchGet200Response result = apiInstance.ReferenceShipzonesIdPgLmtSrchGet(ID, page, limit, search, apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.ReferenceShipzonesIdPgLmtSrchGet: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ReferenceShipzonesIdPgLmtSrchGetWithHttpInfo variant

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

try
{
    // GET
    ApiResponse<ReferenceShipzonesIdPgLmtSrchGet200Response> response = apiInstance.ReferenceShipzonesIdPgLmtSrchGetWithHttpInfo(ID, page, limit, search, 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 ReferenceBooksApi.ReferenceShipzonesIdPgLmtSrchGetWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
ID string Returns detailed info of a particular Shipping zone
page decimal Page (Default: 1)
limit decimal Specifies the page size for pagination. Default page size is 25 (Default: 25)
search string Only return Shiping Zones that have the provided text in Name (Default: not set)
apiAuthAccountid string? e.g. 704ef231-cd93-49c9-a201-26b4b5d0d35b [optional]
apiAuthApplicationkey string? e.g. 0342a546-e0c2-0dff-f0be-6a5e17154033 [optional]

Return type

ReferenceShipzonesIdPgLmtSrchGet200Response

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]

ReferenceShipzonesPost

ReferenceShipzonesPost200Response ReferenceShipzonesPost (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ReferenceShipzonesPostRequest? referenceShipzonesPostRequest = 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 ReferenceShipzonesPostExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 referenceShipzonesPostRequest = new ReferenceShipzonesPostRequest?(); // ReferenceShipzonesPostRequest? |  (optional)

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

Using the ReferenceShipzonesPostWithHttpInfo variant

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

try
{
    // POST
    ApiResponse<ReferenceShipzonesPost200Response> response = apiInstance.ReferenceShipzonesPostWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, referenceShipzonesPostRequest);
    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 ReferenceBooksApi.ReferenceShipzonesPostWithHttpInfo: " + 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]
referenceShipzonesPostRequest ReferenceShipzonesPostRequest? [optional]

Return type

ReferenceShipzonesPost200Response

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]

ReferenceShipzonesPut

ReferenceShipzonesPut200Response ReferenceShipzonesPut (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, ReferenceShipzonesPutRequest? referenceShipzonesPutRequest = 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 ReferenceShipzonesPutExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 referenceShipzonesPutRequest = new ReferenceShipzonesPutRequest?(); // ReferenceShipzonesPutRequest? |  (optional)

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

Using the ReferenceShipzonesPutWithHttpInfo variant

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

try
{
    // PUT
    ApiResponse<ReferenceShipzonesPut200Response> response = apiInstance.ReferenceShipzonesPutWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, referenceShipzonesPutRequest);
    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 ReferenceBooksApi.ReferenceShipzonesPutWithHttpInfo: " + 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]
referenceShipzonesPutRequest ReferenceShipzonesPutRequest? [optional]

Return type

ReferenceShipzonesPut200Response

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]

ReferenceShipzonesShipzoneidDelete

MeAddressesIdDelete200Response ReferenceShipzonesShipzoneidDelete (string shipZoneID, 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 ReferenceShipzonesShipzoneidDeleteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(config);
            var shipZoneID = "shipZoneID_example";  // string | ID of Ship Zone 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.ReferenceShipzonesShipzoneidDelete(shipZoneID, apiAuthAccountid, apiAuthApplicationkey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.ReferenceShipzonesShipzoneidDelete: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ReferenceShipzonesShipzoneidDeleteWithHttpInfo variant

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

try
{
    // Delete
    ApiResponse<MeAddressesIdDelete200Response> response = apiInstance.ReferenceShipzonesShipzoneidDeleteWithHttpInfo(shipZoneID, 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 ReferenceBooksApi.ReferenceShipzonesShipzoneidDeleteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
shipZoneID string ID of Ship Zone 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]

Update

UpdateRequest Update (string? apiAuthAccountid = null, string? apiAuthApplicationkey = null, UpdateRequest? updateRequest = null)

Update

Example

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

namespace Example
{
    public class UpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://inventory.dearsystems.com/ExternalApi/v2";
            var apiInstance = new ReferenceBooksApi(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 updateRequest = new UpdateRequest?(); // UpdateRequest? |  (optional)

            try
            {
                // Update
                UpdateRequest result = apiInstance.Update(apiAuthAccountid, apiAuthApplicationkey, updateRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ReferenceBooksApi.Update: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateWithHttpInfo variant

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

try
{
    // Update
    ApiResponse<UpdateRequest> response = apiInstance.UpdateWithHttpInfo(apiAuthAccountid, apiAuthApplicationkey, updateRequest);
    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 ReferenceBooksApi.UpdateWithHttpInfo: " + 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]
updateRequest UpdateRequest? [optional]

Return type

UpdateRequest

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]