# Plus
[`PLU`](https://developers.portos.sk/data-models#plu) is common abbreviation for goods or services, sold via cash register system. Each PLU can be uniquely identified by its `id` or a combination of the `stockName` and `code` properties.
There are several PLU [types](https://developers.portos.sk/data-models#plutype) defined in PORTOS system:
1. **Stock item**: This refers to a product that can be physically held in stock. Information regarding stock quantity can be linked to PLUs of the stock item type, using `stockQuantity` property. When customers purchase items of this type, the corresponding stock quantities are updated accordingly.
2. **Recipe**: A recipe PLU represents a product that is a combination of other stock items and/or recipes. When a single unit of a recipe is sold, one or more products of the stock item type are deducted from the stock, based on `receipt` collection. However, no information related to stock quantity is associated with this particular type of PLU.
3. **Service**: This type of PLU represents a product that lacks a physical form. Services, unlike tangible goods, are intangible offerings. They are provided to customers without any physical representation or inventory involvement.
4. **Container**: A container (cover) that can be the subject of a deposit and can be repurchased by a trader. This is an material product that has physical representation and associated stock quantity and can be processed in stock takings. Container PLU must be associated with VAT that represents non-taxable items.
Stock items, recipes, services and containers can be accessed through the PLU API routes listed below.
## API methods
## Get PLUs
`GET` `http://{server-address}/plus`
Returns all roles that matches query parameters. Result is of type [`QueryResult`](https://developers.portos.sk/data-models#queryresult).
To retrieve PLUs referenced by receipt as well, specify `Receipt.Plu` value in `$include` query parameter (e.g. `GET {server_address}/plus?$include=Receipt.Plu`).
#### Query Parameters
| Name | Type | Description |
| ------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | string | Supports NData syntax. |
| articleCategoryLabel | string | Supports NData syntax. |
| $skip | int | Pagination property. Describing number of records to skip from beginning of result collection. |
| $take | int | Pagination property. Maximum count of items to be returned. |
| $sort | string\[] | Comma separated list of property names. Please see NData syntax.
|
| $count | bool | If set to `true`, response will not contain `items` collection. Use to get resource count, not the resources themselves. |
| code | int | Supports NData syntax. |
| color | string | Supports NData syntax. |
| isActive | bool | Supports NData syntax. |
| isDiscountAllowed | bool | Supports NData syntax. |
| isPriceFixed | bool | Supports NData syntax. |
| courseNumber | int | Supports NData syntax. |
| unit | string | Supports NData syntax. |
| type | PluType | Supports NData syntax. |
| stockName | string | Supports NData syntax. |
| name | string | Supports NData syntax. |
| isSplittable | bool | Supports NData syntax. |
| stockQuantityAmount | decimal | Supports NData syntax. |
| search | string | Provided parameter will perform partial, case insensitive search across name, code and codes properties. |
| vatCategory | int | Supports NData syntax. |
| isStockQuantitySufficient | bool | If set true, only PLUs with stockQuantity equal or above respective minStockQuantity will be returned. If set to false, only PLUs with stockQuantity less than minStockQuantity will be returned. |
| receiptItemPluCode | int | Only PLUs that contains PLU with specified code in receipt collection will match the query. Supports NData syntax. |
| receiptItemPluStockName | string | Only PLUs that contains PLU with specified stock name in receipt collection will match the query. Supports NData syntax. |
| $include | string | If `Receipt.Plu` is specified as value of query parameter, all [`PluReceiptItem`](https://developers.portos.sk/data-models#plureceiptitem)s will contain referenced [`Plu`](https://developers.portos.sk/data-models#plu) in `plu` property. See example responses. |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ---------------------------------------------- |
| Authorization\* | string | Authorization header with authorization token. |
{% tabs %}
{% tab title="200: OK Successful response" %}
```javascript
{
"items":
[
{
"receipt":
[
{
"pluId":
{
"code": 1,
"stockName": "S11"
},
"quantity":
{
"amount": 3.0,
"unit": "ks"
}
},
{
"pluId":
{
"code": 2,
"stockName": "S11"
},
"quantity":
{
"amount": 0.2,
"unit": "kg"
}
}
],
"articleCategoryLabel": "RAN",
"courseNumber": null,
"codes":
[],
"code": 411,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9fac869b340658c98cc",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham & Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"modifiers": [
{
"id": "657b20bbde0bfde5af0f59dd"
}
],
"retailPriceIncludingVat":
{
"amount": 7.9,
"currencyLabel": "EUR"
},
"stockName": "S01",
"stockQuantity": null,
"stockValue": null,
"lastPurchasePrice": null,
"type": "Recipe",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
},
{
"receipt": null,
"articleCategoryLabel": "OTH",
"courseNumber": null,
"codes":
[],
"code": 1,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e99cc869b340658c98ca",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"modifiers": null,
"retailPriceIncludingVat":
{
"amount": 0.5,
"currencyLabel": "EUR"
},
"stockName": "S11",
"stockQuantity":
{
"amount": 10.0,
"unit": "ks"
},
"stockValue":
{
"amount": 20.0,
"currencyLabel": "EUR"
},
"lastPurchasePrice":
{
"amount": 2.0,
"currencyLabel": "EUR"
},
"type": "StockItem",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 2
},
{
"receipt": null,
"articleCategoryLabel": "OTH",
"courseNumber": null,
"codes":
[],
"code": 2,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9c6c869b340658c98cb",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"modifiers": null,
"retailPriceIncludingVat":
{
"amount": 32.0,
"currencyLabel": "EUR"
},
"stockName": "S11",
"stockQuantity":
{
"amount": 0.0,
"unit": "kg"
},
"stockValue":
{
"amount": 0.0,
"currencyLabel": "EUR"
},
"lastPurchasePrice": null,
"type": "StockItem",
"unit": "kg",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
}
],
"count": 3,
"totalCount": 3
}
```
{% endtab %}
{% tab title="200: OK Response using $include=Receipt.Plu query parameter" %}
```json
{
"items":
[
{
"receipt":
[
{
"plu":
{
"receipt": null,
"articleCategoryLabel": "OTH",
"courseNumber": null,
"codes":
[],
"code": 1,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e99cc869b340658c98ca",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"retailPrice":
{
"amount": 0.5,
"currencyLabel": "EUR"
},
"stockName": "S11",
"stockQuantity":
{
"amount": 10.0,
"unit": "ks"
},
"stockValue":
{
"amount": 20.0,
"currencyLabel": "EUR"
},
"lastPurchasePrice":
{
"amount": 2.0,
"currencyLabel": "EUR"
},
"type": "StockItem",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
},
"pluId":
{
"code": 1,
"stockName": "S11"
},
"quantity":
{
"amount": 3.0,
"unit": "ks"
}
},
{
"plu":
{
"receipt": null,
"articleCategoryLabel": "OTH",
"courseNumber": null,
"codes":
[],
"code": 2,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9c6c869b340658c98cb",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"retailPrice":
{
"amount": 32.0,
"currencyLabel": "EUR"
},
"stockName": "S11",
"stockQuantity":
{
"amount": 0.0,
"unit": "kg"
},
"stockValue":
{
"amount": 0.0,
"currencyLabel": "EUR"
},
"lastPurchasePrice": null,
"type": "StockItem",
"unit": "kg",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
},
"pluId":
{
"code": 2,
"stockName": "S11"
},
"quantity":
{
"amount": 0.2,
"unit": "kg"
}
}
],
"articleCategoryLabel": "RAN",
"courseNumber": null,
"codes":
[],
"code": 411,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9fac869b340658c98cc",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham & Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"retailPrice":
{
"amount": 7.9,
"currencyLabel": "EUR"
},
"stockName": "S01",
"stockQuantity": null,
"stockValue": null,
"lastPurchasePrice": null,
"type": "Recipe",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
},
{
"receipt": null,
"articleCategoryLabel": "OTH",
"courseNumber": null,
"codes":
[],
"code": 1,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e99cc869b340658c98ca",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"retailPrice":
{
"amount": 0.5,
"currencyLabel": "EUR"
},
"stockName": "S11",
"stockQuantity":
{
"amount": 10.0,
"unit": "ks"
},
"stockValue":
{
"amount": 20.0,
"currencyLabel": "EUR"
},
"lastPurchasePrice":
{
"amount": 2.0,
"currencyLabel": "EUR"
},
"type": "StockItem",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
},
{
"receipt": null,
"articleCategoryLabel": "OTH",
"courseNumber": null,
"codes":
[],
"code": 2,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9c6c869b340658c98cb",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"retailPrice":
{
"amount": 32.0,
"currencyLabel": "EUR"
},
"stockName": "S11",
"stockQuantity":
{
"amount": 0.0,
"unit": "kg"
},
"stockValue":
{
"amount": 0.0,
"currencyLabel": "EUR"
},
"lastPurchasePrice": null,
"type": "StockItem",
"unit": "kg",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
}
],
"count": 3,
"totalCount": 3
}// Some code
```
{% endtab %}
{% endtabs %}
## Get PLU
`GET` `http://{server-address}/plus/{id}`
Result is of type [Plu](https://developers.portos.sk/data-models#plu).
#### Path Parameters
| Name | Type | Description |
| ------------------------------------ | ------ | ---------------------- |
| id\* | string | Unique PLU identifier. |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ---------------------------------------------- |
| Authorization\* | string | Authorization header with authorization token. |
{% tabs %}
{% tab title="200: OK Resource found" %}
```javascript
{
"receipt":
[
{
"pluId":
{
"code": 1,
"stockName": "S11"
},
"quantity":
{
"amount": 3.0,
"unit": "ks"
}
},
{
"pluId":
{
"code": 2,
"stockName": "S11"
},
"quantity":
{
"amount": 0.2,
"unit": "kg"
}
}
],
"articleCategoryLabel": "RAN",
"courseNumber": null,
"codes":
[],
"code": 411,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9fac869b340658c98cc",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham & Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"modifiers": null,
"retailPriceIncludingVat":
{
"amount": 7.9,
"currencyLabel": "EUR"
},
"stockName": "S01",
"stockQuantity": null,
"stockValue": null,
"lastPurchasePrice": null,
"type": "Recipe",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
}
```
{% endtab %}
{% tab title="404: Not Found Resource is not found." %}
```javascript
{
"title": "Zdroj nebol nájdený",
"status": 404
}
```
{% endtab %}
{% endtabs %}
## Create PLU
`POST` `http://{server-address}plus`
Creates new PLU. Result is of type [Plu](https://developers.portos.sk/data-models#plu).
**Required rights**
Authorized user must have `PluCreate` [right ](https://developers.portos.sk/user-rights)assigned.
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ---------------------------------------------- |
| Authorization\* | string | Authorization header with authorization token. |
#### Request Body
| Name | Type | Description |
| ---------------------------------------- | ---- | ------------------- |
| (body)\* | Plu | PLU model to create |
{% tabs %}
{% tab title="201: Created Successfuly created." %}
```javascript
{
"receipt":
[
{
"pluId":
{
"code": 1,
"stockName": "S11"
},
"quantity":
{
"amount": 3.0,
"unit": "ks"
}
},
{
"pluId":
{
"code": 2,
"stockName": "S11"
},
"quantity":
{
"amount": 0.2,
"unit": "kg"
}
}
],
"articleCategoryLabel": "RAN",
"courseNumber": null,
"codes":
[],
"code": 411,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9fac869b340658c98cc",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham & Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"modifiers": null,
"retailPriceIncludingVat":
{
"amount": 7.9,
"currencyLabel": "EUR"
},
"stockName": "S01",
"stockQuantity": null,
"stockValue": null,
"lastPurchasePrice": null,
"type": "Recipe",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
}
```
{% endtab %}
{% endtabs %}
## Create or update PLU
`PUT` `http://{server-address}/plus/{id}`
Updates existing or creates new PLU. Result is of type [Plu](https://developers.portos.sk/data-models#plu).
**Required rights**
Authorized user must have assigned `PluCreate` or `PluUpdate` [right](https://developers.portos.sk/user-rights).
#### Path Parameters
| Name | Type | Description |
| ------------------------------------ | ------ | ---------------------- |
| id\* | string | Unique PLU identifier. |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ---------------------------------------------- |
| Authorization\* | string | Authorization header with authorization token. |
#### Request Body
| Name | Type | Description |
| ---------------------------------------- | ---- | -------------------------- |
| (body)\* | Plu | Model to create or update. |
{% tabs %}
{% tab title="200: OK Successfuly created or updated." %}
```javascript
{
"receipt":
[
{
"pluId":
{
"code": 1,
"stockName": "S11"
},
"quantity":
{
"amount": 3.0,
"unit": "ks"
}
},
{
"pluId":
{
"code": 2,
"stockName": "S11"
},
"quantity":
{
"amount": 0.2,
"unit": "kg"
}
}
],
"articleCategoryLabel": "RAN",
"courseNumber": null,
"codes":
[],
"code": 411,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9fac869b340658c98cc",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham & Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"modifiers": null,
"retailPriceIncludingVat":
{
"amount": 7.9,
"currencyLabel": "EUR"
},
"stockName": "S01",
"stockQuantity": null,
"stockValue": null,
"lastPurchasePrice": null,
"type": "Recipe",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
}
```
{% endtab %}
{% endtabs %}
## Delete PLU
`DELETE` `http://{server-address}/plus/{id}`
**Required rights**
Authorized user must have `PluDelete` [right ](https://developers.portos.sk/user-rights)assigned.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------ | ------ | ---------------------- |
| id\* | string | Unique PLU identifier. |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ---------------------------------------------- |
| Authorization\* | string | Authorization header with authorization token. |
{% tabs %}
{% tab title="200: OK Successfuly deleted." %}
```javascript
{
"receipt":
[
{
"pluId":
{
"code": 1,
"stockName": "S11"
},
"quantity":
{
"amount": 3.0,
"unit": "ks"
}
},
{
"pluId":
{
"code": 2,
"stockName": "S11"
},
"quantity":
{
"amount": 0.2,
"unit": "kg"
}
}
],
"articleCategoryLabel": "RAN",
"courseNumber": null,
"codes":
[],
"code": 411,
"color": null,
"description": null,
"customerDescription": null,
"id": "64d9e9fac869b340658c98cc",
"isActive": true,
"isDiscountAllowed": true,
"isPriceFixed": false,
"isSplittable": false,
"minStockQuantity": null,
"name": "Ham & Eggs",
"orderEndpointNames":
[],
"priceHistory":
[],
"images": null,
"ordering": null,
"purchaseTypes": null,
"modifiers": null,
"retailPriceIncludingVat":
{
"amount": 7.9,
"currencyLabel": "EUR"
},
"stockName": "S01",
"stockQuantity": null,
"stockValue": null,
"lastPurchasePrice": null,
"type": "Recipe",
"unit": "ks",
"vatCategory": 1,
"packaging": null,
"specialRegulation": null,
"isCashbackAllowed": false,
"isFavorite": false,
"sortHint": null,
"_v": 1
}
```
{% endtab %}
{% tab title="404: Not Found Given resource was not found." %}
```javascript
{
"title": "Zdroj nebol nájdený",
"status": 404
}
```
{% endtab %}
{% endtabs %}