mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-23 18:46:50 +00:00
cb6c735dd5
* 2025.3: Beta release notes * 2025.3: Sync with codebase * 2025.3: Tweaks * tiny tweaks * tweaks * some more tweaks * Update 2025-03-05-release-20253.markdown * update * missing breaking change --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Co-authored-by: Bram Kragten <mail@bramkragten.nl>
75 lines
5.0 KiB
Markdown
75 lines
5.0 KiB
Markdown
---
|
|
title: Picnic
|
|
description: How to setup and use the Picnic integration in Home Assistant.
|
|
ha_category:
|
|
- Other
|
|
ha_release: 2021.5
|
|
ha_iot_class: Cloud Polling
|
|
ha_config_flow: true
|
|
ha_codeowners:
|
|
- '@corneyl'
|
|
- '@codesalatdev'
|
|
ha_domain: picnic
|
|
ha_platforms:
|
|
- sensor
|
|
- todo
|
|
ha_integration_type: integration
|
|
---
|
|
|
|
The Picnic integration allows one to get information from [Picnic](https://picnic.app) about orders, deliveries and cart content.
|
|
|
|
{% include integrations/config_flow.md %}
|
|
|
|
## Sensors
|
|
|
|
This integration provides the following sensors. Some sensors are disabled by default when adding the integration.
|
|
|
|
| Name | Description |
|
|
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| Cart items count | The amount of different products currently in the cart. |
|
|
| Cart total price | The total price for products currently in the cart. |
|
|
| Selected slot start | Start of the selected delivery slot, `unknown` if none is selected. |
|
|
| Selected slot end | End of the selected delivery slot, `unknown` if none is selected. |
|
|
| Selected slot max order time | Maximum time it's still possible to place an order for the selected delivery slot, `unknown` if none is selected. |
|
|
| Selected slot min order value | The minimum order value needed to be able to place an order for the selected delivery window slot, `unknown` if none is selected. |
|
|
| Last order slot start | Start of the last placed order's delivery slot |
|
|
| Last order slot end | End of the last placed order's delivery slot |
|
|
| Last order status | Status of the last order, either `CURRENT`, `CANCELLED` or `COMPLETED`. Will only transition to `COMPLETED` after the invoice email has been sent. |
|
|
| Last order max order time | Maximum time it is/was still possible to add products to the last order. |
|
|
| Last order delivery time | The delivery time of the last order, `unavailable` if not yet delivered. |
|
|
| Last order total price | The total price of the last order. |
|
|
| Next delivery ETA start | Start of the ETA window of the next delivery, will get more precise if the driver is underway. |
|
|
| Next delivery ETA end | End of the ETA window of the next delivery. |
|
|
| Next delivery slot start | Start of the next delivery's delivery slot. |
|
|
| Next delivery slot end | End of the next delivery's delivery slot. |
|
|
|
|
|
|
## Shopping cart
|
|
|
|
This integration provides a list containing the content of your shopping cart. This list is provided as a [to-do list](/integrations/todo/) and can also be found in the to-do list dashboard in the main sidebar of your Home Assistant instance.
|
|
|
|
You can add products to your shopping cart by entering a name in the **Add item** field. Just like with the [`picnic.add_product`](#action-picnicadd_product) action, a search will be done and the first item found will be added.
|
|
|
|
## Actions
|
|
|
|
### Action `picnic.add_product`
|
|
|
|
Add a product to your cart using the `picnic.add_product` action, either using a product ID or a product name.
|
|
A search will be done and the first result will be added to the cart when one adds a product using a product name.
|
|
The action will fail when no product can be found, or when no `product_id` or `product_name` is specified.
|
|
|
|
| Data attribute | Optional | Description |
|
|
|------------------------|----------|----------------------------------------------------------------------------------|
|
|
| `config_entry_id` | No | The Id of the Picnic service config entry. |
|
|
| `product_id` | yes | The Picnic product ID. |
|
|
| `product_name` | yes | A product name to search for, the first search result will be added to the cart. |
|
|
| `amount` | yes | The amount to add, defaults to 1. |
|
|
|
|
```yaml
|
|
# Example automation action to add a product to the cart by name.
|
|
- action: picnic.add_product
|
|
data:
|
|
config_entry_id: 6b4be47a1fa7c3764f14cf756dc9899d
|
|
product_name: "Picnic cola zero"
|
|
```
|