about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiSetApi.md
blob: 993c6d1326a8caa7f732f294a95cb0f39c4e36a0 (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
<!--
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>.
-->

# \\ApiSetApi

All URIs are relative to _http://localhost_

| Method                                                  | HTTP request                     | Description                        |
| ------------------------------------------------------- | -------------------------------- | ---------------------------------- |
| [**associate_barcode**](ApiSetApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product |
| [**register_product**](ApiSetApi.md#register_product)   | **POST** /product/new            | Register a product                 |

## associate_barcode

> associate_barcode(id, barcode) Associate a barcode with a product

### Parameters

| Name        | Type                      | Description                                          | Required   | Notes |
| ----------- | ------------------------- | ---------------------------------------------------- | ---------- | ----- |
| **id**      | **uuid::Uuid**            | The id of the product to associated the barcode with | [required] |
| **barcode** | [**Barcode**](Barcode.md) |                                                      | [required] |

### Return type

(empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: 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)

## register_product

> uuid::Uuid register_product(product_stub) Register a product

### Parameters

| Name             | Type                              | Description | Required   | Notes |
| ---------------- | --------------------------------- | ----------- | ---------- | ----- |
| **product_stub** | [**ProductStub**](ProductStub.md) |             | [required] |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **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)