blob: bcf20131a9203b48b8ae8a82dd45a6a91ffe1c67 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
<!--
rocie - An enterprise grocery management system
Copyright (C) 2026 Benedikt Peetz <benedikt.peetz@b-peetz.de>
SPDX-License-Identifier: GPL-3.0-or-later
This file is part of Rocie.
You should have received a copy of the License along with this program.
If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.
-->
# \\ApiGetAuthProductApi
All URIs are relative to _http://localhost_
| Method | HTTP request | Description |
| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | ----------------------------------------------------- |
| [**product_by_id**](ApiGetAuthProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id |
| [**product_by_name**](ApiGetAuthProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name |
| [**product_suggestion_by_name**](ApiGetAuthProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name |
| [**products_by_product_parent_id_direct**](ApiGetAuthProductApi.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**](ApiGetAuthProductApi.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**](ApiGetAuthProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage |
| [**products_registered**](ApiGetAuthProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products |
| [**products_without_product_parent**](ApiGetAuthProductApi.md#products_without_product_parent) | **GET** /product/without-product-parent | Get Products by it's absents of a product parent |
## 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)
## products_without_product_parent
> Vec<models::Product> products_without_product_parent() Get Products by it's
> absents of a product parent
This will only return products without a product parent associated with it
### 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)
|
