# \\ApiGetProductApi

All URIs are relative to _http://localhost_

| Method                                                                                                   | HTTP request                                        | Description                                           |
| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------- |
| [**product_by_id**](ApiGetProductApi.md#product_by_id)                                                   | **GET** /product/by-id/{id}                         | Get Product by id                                     |
| [**product_by_name**](ApiGetProductApi.md#product_by_name)                                               | **GET** /product/by-name/{name}                     | Get Product by name                                   |
| [**product_suggestion_by_name**](ApiGetProductApi.md#product_suggestion_by_name)                         | **GET** /product/by-part-name/{name}                | Get Product suggestion by name                        |
| [**products_by_product_parent_id_direct**](ApiGetProductApi.md#products_by_product_parent_id_direct)     | **GET** /product/by-product-parent-id-direct/{id}   | Get Products by it's product parent id                |
| [**products_by_product_parent_id_indirect**](ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id                |
| [**products_in_storage**](ApiGetProductApi.md#products_in_storage)                                       | **GET** /products_in_storage/                       | Return all products, which non-null amount in storage |
| [**products_registered**](ApiGetProductApi.md#products_registered)                                       | **GET** /products_registered/                       | Return all registered products                        |

## product_by_id

> models::Product product_by_id(id) Get Product by id

### Parameters

| Name   | Type                 | Description | Required   | Notes |
| ------ | -------------------- | ----------- | ---------- | ----- |
| **id** | [**ProductId**](.md) | Product id  | [required] |

### Return type

[**models::Product**](Product.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[Back to top]](#)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## product_by_name

> models::Product product_by_name(name) Get Product by name

### Parameters

| Name     | Type       | Description         | Required   | Notes |
| -------- | ---------- | ------------------- | ---------- | ----- |
| **name** | **String** | Name of the product | [required] |

### Return type

[**models::Product**](Product.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[Back to top]](#)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## product_suggestion_by_name

> Vec<models::Product> product_suggestion_by_name(name) Get Product suggestion
> by name

### Parameters

| Name     | Type       | Description               | Required   | Notes |
| -------- | ---------- | ------------------------- | ---------- | ----- |
| **name** | **String** | Partial name of a product | [required] |

### Return type

[**Vec<models::Product>**](Product.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[Back to top]](#)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## products_by_product_parent_id_direct

> Vec<models::Product> products_by_product_parent_id_direct(id) Get Products by
> it's product parent id

This will only return products directly associated with this product parent id

### Parameters

| Name   | Type                       | Description       | Required   | Notes |
| ------ | -------------------------- | ----------------- | ---------- | ----- |
| **id** | [**ProductParentId**](.md) | Product parent id | [required] |

### Return type

[**Vec<models::Product>**](Product.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[Back to top]](#)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## products_by_product_parent_id_indirect

> Vec<models::Product> products_by_product_parent_id_indirect(id) Get Products
> by it's product parent id

This will also return all products below this product parent id

### Parameters

| Name   | Type                       | Description       | Required   | Notes |
| ------ | -------------------------- | ----------------- | ---------- | ----- |
| **id** | [**ProductParentId**](.md) | Product parent id | [required] |

### Return type

[**Vec<models::Product>**](Product.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[Back to top]](#)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## products_in_storage

> Vec<models::Product> products_in_storage() Return all products, which non-null
> amount in storage

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::Product>**](Product.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[Back to top]](#)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)

## products_registered

> Vec<models::Product> products_registered() Return all registered products

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::Product>**](Product.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[Back to top]](#)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)