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

# Product

## Properties

| Name                     | Type                                                       | Description                                                                                                                                         | Notes      |
| ------------------------ | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **associated_bar_codes** | [**Vec<models::Barcode>**](Barcode.md)                     | Which barcodes are associated with this product.                                                                                                    |
| **description**          | Option\<**String**>                                        | An optional description of this product.                                                                                                            | [optional] |
| **id**                   | [**models::ProductId**](ProductId.md)                      | The id of the product.                                                                                                                              |
| **name**                 | **String**                                                 | The name of the product. This should be globally unique, to make searching easier for the user.                                                     |
| **parent**               | Option\<[**models::ProductParentId**](ProductParentId.md)> | The parent this product has. This is effectively it's anchor in the product DAG. None means, that it has no parents and as such is in the toplevel. | [optional] |
| **unit_property**        | [**models::UnitPropertyId**](UnitPropertyId.md)            | The property this product is measured in. (This is probably always either Mass, Volume or Quantity).                                                |

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