### Product Data Schema and Example (JSON)

Source: https://developer.aiqfome.com/docs/api/v2/list-item

This snippet shows the expected JSON structure for product data returned by the API. It includes fields like UUID, SKU, name, description, status, and blocking information. The example demonstrates a typical response payload.

```json
{
  "data": [
    {
      "uuid": "a420d57f-7c50-33dc-ae46-a9daeb155532",
      "sku": "38302",
      "name": "cerveja puro malte zero álcool heineken 330ml",
      "description": "cerveja puro malte zero álcool heineken 330ml",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "9efb4952-256a-35ed-9934-3185eff21de9",
      "sku": "5959",
      "name": "sabonete alfazema equilíbrio francis 85g",
      "description": "sabonete alfazema equilíbrio francis 85g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "a48ddf44-55e1-3e35-991c-8701a2c8bdda",
      "sku": "31480",
      "name": "polpa de fruta sabor cupuaçu polpanorte 100g",
      "description": "polpa de fruta sabor cupuaçu polpanorte 100g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "b2f80e3d-18a3-355a-a826-d47b15b60dd9",
      "sku": "6741",
      "name": "tempero para massas sazón 60g",
      "description": "tempero para massas sazón 60g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "7e89e8c6-deb9-38fc-a486-670efcc002e5",
      "sku": "2662",
      "name": "melão sapo kg",
      "description": "melão sapo kg",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "b6893242-d6ba-34cf-af90-da53b17f5ac8",
      "sku": "1603",
      "name": "refrigerante com café espresso coca-cola 220ml",
      "description": "refrigerante com café espresso coca-cola 220ml",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "c6efb531-7615-308c-bdaf-34baa7bf0a33",
      "sku": "909777",
      "name": "biscoito wafer chocolate e baunilha minueto 115g",
      "description": "biscoito wafer chocolate e baunilha minueto 115g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "bd53a3fe-8dd5-3566-ae68-b98c0cb8b31b",
      "sku": "21286",
      "name": "chimichurri de flocos sweet sabor 40g",
      "description": "chimichurri de flocos sweet sabor 40g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "3d35e022-3f0f-3c08-a4fa-7fa1e1c84420",
      "sku": "1696",
      "name": "chocolate ao leite laka e diamante negro lacta 90g",
      "description": "chocolate ao leite laka e diamante negro lacta 90g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "f60109ba-9506-3da9-85ca-9e3abbdb32b2",
      "sku": "22241",
      "name": "colorau colorífico sweet sabor pacote 70g",
      "description": "colorau colorífico sweet sabor pacote 70g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "fb45efe8-7a66-3181-827f-b1365b3351cd",
      "sku": "17975",
      "name": "cerveja pilsen extra corona 330ml",
      "description": "cerveja pilsen extra corona 330ml",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "e1d4543e-e74c-3e47-b829-499e3cb11d69",
      "sku": "32623",
      "name": "tirinhas stick de frango empanado copacol 300g",
      "description": "tirinhas stick de frango empanado copacol 300g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "d417789e-5ac2-39a4-94d9-bcabf839a43b",
      "sku": "17953",
      "name": "biscoito recheado morango zabet 145g",
      "description": "biscoito recheado morango zabet 145g",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    },
    {
      "uuid": "ab6f873e-5efa-3d2d-adf8-1deeb65ad8b3",
      "sku": "7629",
      "name": "leite pasteurizado integral polly cativa 1l",
      "description": "leite pasteurizado integral polly cativa 1l",
      "status": "AVAILABLE",
      "blocked_until_tomorrow": false
    }
  ],
  "links": {
    "first": "http://localhost:8898/alfredo/catalog/95434/items?page=1",
    "last": null,
    "prev": null,
    "next": "http://localhost:8898/alfredo/catalog/95434/items?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "http://localhost:8898/alfredo/catalog/95434/items",
    "per_page": 15,
    "to": 15
  }
}
```

--------------------------------

### Daily Sale Structure Example

Source: https://developer.aiqfome.com/docs/api/v2/show-menu-by-url

This JSON snippet defines the structure for daily sales promotions associated with an item size. It includes the sale period (start and end dates) and a list of daily weekday sales, each specifying a discount amount and type.

```json
{
  "id": 168155,
  "start": "2022-12-01",
  "end": "2022-12-15",
  "daily_weekday_sale": [
    {
      "discount": "5.99",
      "discount_type": 1,
      "week_day": {
        "code": 0,
        "name": "segunda-feira"
      }
    }
  ]
}
```

--------------------------------

### Create Delivery Endpoint - HTTP Request Example

Source: https://developer.aiqfome.com/docs/api/v2/create-delivery

Illustrates creating a delivery endpoint via an HTTP POST request. This example shows the request structure, including the URL, headers, and the JSON body payload.

```http
POST /api/v2/store/:store_id/delivery HTTP/1.1
Host: plataforma.aiqfome.com
Accept: application/json
Authorization: Bearer <token>
Content-Type: application/json

{
  "free_delivery": false,
  "delivery_days": null,
  "neighborhoods": null
}
```

--------------------------------

### GET /websites/developer_aiqfome_api_v2

Source: https://developer.aiqfome.com/docs/api/v2/show-menu

Retrieves detailed information about restaurant menus, including categories, items, pricing, and availability.

```APIDOC
## GET /websites/developer_aiqfome_api_v2

### Description
This endpoint retrieves comprehensive menu data, including item details, pricing, category information, and daily sales configurations.

### Method
GET

### Endpoint
/websites/developer_aiqfome_api_v2

### Parameters
#### Query Parameters
None

### Request Example
```
GET /websites/developer_aiqfome_api_v2
```

### Response
#### Success Response (200)
- **data** (object) - Contains the main menu information.
  - **id** (integer) - Unique identifier for the menu.
  - **description** (string) - Description of the menu.
  - **categories** (array) - List of menu categories.
    - **id** (integer) - Unique identifier for the category.
    - **name** (string) - Name of the category.
    - **culinary** (object) - Culinary details of the category.
      - **id** (integer) - Culinary ID.
      - **name** (string) - Culinary name.
      - **description** (string) - Culinary description.
      - **order** (integer) - Display order for the culinary type.
      - **status** (string) - Availability status.
      - **blocked_until_tomorrow** (boolean) - Indicates if the category is blocked for tomorrow.
      - **flavor_pricing_option** (string) - Pricing option for flavors.
      - **packing_fee** (string) - Packing fee for items in this category.
      - **available_hours** (object) - Operating hours for the category.
        - **first_interval** (object) - First time interval.
          - **from** (string) - Start time.
          - **to** (string) - End time.
        - **second_interval** (object) - Second time interval.
          - **from** (string) - Start time.
          - **to** (string) - End time.
      - **sizes** (array) - Available sizes for items in this category.
        - **id** (integer) - Size ID.
        - **name** (string) - Size name.
        - **order** (integer) - Display order for the size.
        - **status** (string) - Availability status.
        - **flavors_amount** (integer) - Maximum number of flavors allowed.
        - **additional_max_limit** (integer) - Maximum additional items allowed.
        - **additional_items** (array) - List of additional items.
        - **mandatory_groups** (array) - List of mandatory groups for customization.
        - **daily_sale** (string) - Daily sale information (can be null).
      - **mandatory_groups** (array) - List of mandatory customization groups for the category.
        - **id** (integer) - Mandatory group ID.
        - **name** (string) - Name of the mandatory group.
        - **order** (integer) - Display order.
        - **min_limit** (integer) - Minimum number of items to select.
        - **max_limit** (integer) - Maximum number of items to select.
        - **mandatory_items** (array) - List of mandatory items within the group.
          - **id** (integer) - Mandatory item ID.
          - **name** (string) - Name of the mandatory item.
          - **value** (string) - Value or price of the item.
          - **status** (string) - Availability status.
          - **description** (string) - Description of the item.
          - **sku** (string) - SKU of the item.
      - **daily_sale** (object) - Daily sale information for the category.
        - **id** (integer) - Daily sale ID.
        - **start** (string) - Sale start date.
        - **end** (string) - Sale end date.
        - **daily_weekday_sale** (array) - Discounts applicable on specific weekdays.
          - **discount** (string) - Discount amount.
          - **discount_type** (integer) - Type of discount.
          - **week_day** (object) - Day of the week.
            - **code** (integer) - Day code.
            - **name** (string) - Day name.
    - **items** (array) - List of items within the category.
      - **uuid** (string) - Unique identifier for the item.
      - **sku** (string) - SKU of the item.
      - **name** (string) - Name of the item.
      - **description** (string) - Description of the item.
      - **order** (integer) - Display order.
      - **highlighted** (boolean) - Indicates if the item is highlighted.
      - **excluded** (boolean) - Indicates if the item is excluded.
      - **status** (string) - Availability status.
      - **blocked_until_tomorrow** (boolean) - Indicates if the item is blocked for tomorrow.
      - **comments** (string) - Comments about the item.
      - **tags** (array) - Tags associated with the item.
        - **id** (integer) - Tag ID.
        - **name** (string) - Tag name.
      - **item_sizes** (array) - Available sizes and pricing for the item.
        - **item_size_id** (integer) - Item size ID.
        - **size_id** (integer) - Size ID.
        - **sku** (string) - SKU for this item size.
        - **name** (string) - Name of the size.
        - **status** (string) - Availability status.
        - **flavors_amount** (integer) - Maximum flavors allowed for this size.
        - **additional_max_limit** (integer) - Maximum additional items allowed.
        - **value** (string) - Price of the item in this size.
        - **promotional_value** (string) - Promotional price.
        - **inventory_quantity** (integer) - Current inventory quantity.
        - **is_inventory_active** (boolean) - Indicates if inventory tracking is active.
        - **daily_sale** (object) - Daily sale information for this item size.
          - **id** (integer) - Daily sale ID.
          - **start** (string) - Sale start date.
          - **end** (string) - Sale end date.
          - **daily_weekday_sale** (array) - Discounts applicable on specific weekdays.
            - **discount** (string) - Discount amount.
            - **discount_type** (integer) - Type of discount.
            - **week_day** (object) - Day of the week.
              - **code** (integer) - Day code.
              - **name** (string) - Day name.
        - **item_week_days** (array) - Availability on specific weekdays for this item size.
          - **id** (integer) - Item week day ID.
          - **week_day** (integer) - Day code.
          - **name** (string) - Day name.
          - **status** (string) - Availability status.
        - **mandatory_groups** (array) - Mandatory customization groups for this item size.
          - **id** (integer) - Mandatory group ID.
          - **name** (string) - Name of the mandatory group.
          - **order** (integer) - Display order.
          - **min_limit** (integer) - Minimum number of items to select.
          - **max_limit** (integer) - Maximum number of items to select.
          - **mandatory_items** (array) - List of mandatory items within the group.
            - **id** (integer) - Mandatory item ID.
            - **name** (string) - Name of the mandatory item.
            - **value** (string) - Value or price of the item.
            - **status** (string) - Availability status.
            - **description** (string) - Description of the item.
            - **sku** (string) - SKU of the item.
      - **daily_sale** (object) - Daily sale information for the item.
        - **id** (integer) - Daily sale ID.
        - **start** (string) - Sale start date.
        - **end** (string) - Sale end date.
        - **daily_weekday_sale** (array) - Discounts applicable on specific weekdays.
          - **discount** (string) - Discount amount.
          - **discount_type** (integer) - Type of discount.
          - **week_day** (object) - Day of the week.
            - **code** (integer) - Day code.
            - **name** (string) - Day name.

#### Response Example
```json
{
  "data": {
    "id": 49522,
    "description": "cardapio unico criado via importação pela api",
    "categories": [
      {
        "id": 352355,
        "name": "pizzas",
        "culinary": {
          "id": 481,
          "name": "Pizza",
          "description": "pizzas doces e salgadas",
          "order": 1,
          "status": "AVAILABLE",
          "blocked_until_tomorrow": false,
          "flavor_pricing_option": "MEAN VALUE",
          "packing_fee": "0.99",
          "available_hours": {
            "first_interval": {
              "from": "08:00",
              "to": "17:00"
            },
            "second_interval": {
              "from": "19:00",
              "to": "23:00"
            }
          },
          "sizes": [
            {
              "id": 1755816,
              "name": "p",
              "order": 1,
              "status": "AVAILABLE",
              "flavors_amount": 1,
              "additional_max_limit": 0,
              "additional_items": [],
              "mandatory_groups": [],
              "daily_sale": null
            }
          ],
          "mandatory_groups": [
            {
              "id": 398871,
              "name": "borda",
              "order": 1,
              "min_limit": 1,
              "max_limit": 2,
              "mandatory_items": [
                {
                  "id": 2626816,
                  "name": "sem borda",
                  "value": "0.00",
                  "status": "AVAILABLE",
                  "description": null,
                  "sku": "abc0001"
                }
              ]
            }
          ],
          "daily_sale": {
            "id": 168151,
            "start": "2022-12-01",
            "end": "2022-12-07",
            "daily_weekday_sale": [
              {
                "discount": "10.00",
                "discount_type": 1,
                "week_day": {
                  "code": 0,
                  "name": "segunda-feira"
                }
              }
            ],
            "items": [
              {
                "uuid": "e4694466-24aa-3af0-9eef-171e6072ee1f",
                "sku": "abc0001",
                "name": "moda da casa",
                "description": "mussarela, calabresa, bacon, ovos, tomate, cebola, pimenta, orégano e azeitona",
                "order": 2,
                "highlighted": true,
                "excluded": false,
                "status": "AVAILABLE",
                "blocked_until_tomorrow": false,
                "comments": "|0|",
                "tags": [
                  {
                    "id": 0,
                    "name": "SPICY"
                  }
                ],
                "item_sizes": [
                  {
                    "item_size_id": 14405798,
                    "size_id": 1755816,
                    "sku": "abc123",
                    "name": "p",
                    "status": "AVAILABLE",
                    "flavors_amount": 1,
                    "additional_max_limit": 0,
                    "value": "29.99",
                    "promotional_value": "25.99",
                    "inventory_quantity": 1,
                    "is_inventory_active": true,
                    "daily_sale": {
                      "id": 168155,
                      "start": "2022-12-01",
                      "end": "2022-12-15",
                      "daily_weekday_sale": [
                        {
                          "discount": "5.99",
                          "discount_type": 1,
                          "week_day": {
                            "code": 0,
                            "name": "segunda-feira"
                          }
                        }
                      ]
                    },
                    "item_week_days": [
                      {
                        "id": 1,
                        "week_day": 0,
                        "name": "segunda-feira",
                        "status": "AVAILABLE"
                      }
                    ],
                    "mandatory_groups": [
                      {
                        "id": 398877,
                        "name": "tipo de cebola",
                        "order": 1,
                        "min_limit": 1,
                        "max_limit": 1,
                        "mandatory_items": [
                          {
                            "id": 2626839,
                            "name": "sem cebola",
                            "value": "0.00",
                            "status": "AVAILABLE",
                            "description": null,
                            "sku": "abc0001"
                          }
                        ]
                      }
                    ]
                  }
                ],
                "daily_sale": {
                  "id": 168154,
                  "start": "2022-12-01",
                  "end": "2022-12-15",
                  "daily_weekday_sale": [
                    {
                      "discount": "5.99",
                      "discount_type": 1,
                      "week_day": {
                        "code": 0,
                        "name": "segunda-feira"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    ]
  }
}
```
```

--------------------------------

### GET /products/{id}

Source: https://developer.aiqfome.com/docs/api/v2/show-size

Retrieves the full details of a specific product, including its additional items, mandatory groups, and any active daily sales.

```APIDOC
## GET /products/{id}

### Description
Retrieves the detailed configuration for a specific product, including its status, associated additional items, mandatory selection groups, and daily discount schedules.

### Method
GET

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **data** (object) - The product details object containing:
  - **id** (integer) - Product ID
  - **name** (string) - Product name
  - **additional_items** (array) - List of available add-ons
  - **mandatory_groups** (array) - Groups of items that must be selected
  - **daily_sale** (object) - Configuration for daily discounts

#### Response Example
{
  "data": {
    "id": 1799999,
    "name": "small",
    "reference": "sm",
    "flavors_amount": 1,
    "additional_max_limit": 3,
    "status": true,
    "additional_items": [
      {
        "id": 2272356,
        "name": "borda catupiry",
        "sku": "AB001",
        "value": "10.50",
        "status": true
      }
    ],
    "category_id": 349790
  }
}
```

--------------------------------

### GET /api/v2/orders/open

Source: https://developer.aiqfome.com/docs/api/v2/list-open-orders

Retrieves a list of open orders for the authenticated stores.

```APIDOC
## GET https://plataforma.aiqfome.com/api/v2/orders/open

### Description
Retrieves a list of open orders for the stores authorized by the application. Requires the 'aqf:order:read' scope.

### Method
GET

### Endpoint
https://plataforma.aiqfome.com/api/v2/orders/open

### Parameters
#### Query Parameters
- **filter[store_ids]** (string) - Optional - Store IDs separated by comma (e.g., '12,13')
- **filter[is_read]** (integer) - Optional - Filter order not viewed (0) or viewed (1)
- **per_page** (integer) - Optional - Number of registers per page
- **page** (integer) - Optional - Page number

#### Header Parameters
- **User-Agent** (string) - Required - Identification of the partner (e.g., 'parceiro (parceiro@parceiro.com)')

### Request Example
GET /api/v2/orders/open?filter[store_ids]=12,13&per_page=10

### Response
#### Success Response (200)
- **data** (array) - List of open order objects
- **meta** (object) - Pagination metadata

#### Response Example
{
  "data": [
    {
      "id": "12345",
      "status": "open"
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 1
  }
}
```

--------------------------------

### GET /items

Source: https://developer.aiqfome.com/docs/api/v2/show-menu

Retrieves a list of menu items available for a restaurant, including their sizes, pricing, and weekly availability schedule.

```APIDOC
## GET /items

### Description
Retrieves the list of products/items available in the menu. Each item includes details such as SKU, description, status, and associated size options.

### Method
GET

### Endpoint
/items

### Response
#### Success Response (200)
- **uuid** (string) - Unique identifier for the item
- **sku** (string) - Stock Keeping Unit identifier
- **name** (string) - Name of the product
- **description** (string) - Ingredients or product details
- **status** (string) - Current availability status (e.g., AVAILABLE)
- **item_sizes** (array) - List of available sizes and their pricing
- **item_week_days** (array) - Schedule of availability by day of the week

#### Response Example
[
  {
    "uuid": "318ab56c-cdb4-35b7-8502-839bfb586d0d",
    "sku": "abc0002",
    "name": "x-bacon",
    "description": "hamburguer, queijo, bacon, alface, tomate, cebola, maionese e ketchup",
    "status": "AVAILABLE",
    "item_sizes": [
      {
        "item_size_id": 14405814,
        "value": "22.99",
        "promotional_value": "19.99"
      }
    ]
  }
]
```

--------------------------------

### API Response Example

Source: https://developer.aiqfome.com/docs/api/v2/mark-as-pickup-ongoing

The standard JSON response returned by the API upon a successful request.

```json
{
  "data": {
    "status": "pickup_ongoing",
    "created_at": "2025-12-11T12:00:00.000000Z"
  }
}
```

--------------------------------

### Mark Order as Ready - C# Example

Source: https://developer.aiqfome.com/docs/api/v2/order-ready

Demonstrates how to mark an order as ready using C# HttpClient. It sends a POST request to the /api/v2/orders/mark-as-ready endpoint with the order ID and authorization token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://plataforma.aiqfome.com/api/v2/orders/mark-as-ready");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"order_id\": 14\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Store Category by ID (HTTP)

Source: https://developer.aiqfome.com/docs/api/v2/show-category

This example shows how to make an HTTP GET request to retrieve a store category using the aiqfome API v2. It includes the base URL, authorization header with a Bearer token, and path parameters for store ID and category ID. The response will be in JSON format.

```http
GET /api/v2/menu/:store_id/categories/:id HTTP/1.1
Host: plataforma.aiqfome.com
Authorization: Bearer <token>
Accept: application/json
```

--------------------------------

### Product Data Schema and Example (JSON)

Source: https://developer.aiqfome.com/docs/api/v2/catalog-show-item

This snippet shows the expected JSON structure for a successful product data response. It includes details like UUID, SKU, name, pricing, inventory, and associated images and categories. This schema is crucial for clients to correctly parse and utilize product information.

```json
{
  "data": {
    "uuid": "265dff4d-bb74-365e-9a32-bd47aa32009f",
    "sku": "8488",
    "name": "açúcar cristal alto alegre 2kg",
    "description": "açúcar cristal alto alegre 2kg",
    "is_alcoholic": false,
    "type": true,
    "highlighted": false,
    "excluded": false,
    "status": "AVAILABLE",
    "blocked_until_tomorrow": false,
    "comments": "",
    "tags": [],
    "item_sizes": [
      {
        "item_size_id": 33900189,
        "size_id": 4072630,
        "name": "Unidade",
        "sku": "8488",
        "status": "AVAILABLE",
        "flavors_amount": 1,
        "additional_max_limit": null,
        "value": "8.49",
        "promotional_value": null,
        "inventory_quantity": 561,
        "is_inventory_active": true,
        "size_value": 1,
        "max_quantity": 0,
        "ean_code": "7896508200027",
        "weightable": 0,
        "weightable_value": 250,
        "net_weight": null,
        "gross_weight": null,
        "volume": null,
        "height": null,
        "width": null,
        "depth": null,
        "cost_value": null,
        "similar_sku": null,
        "brand": null,
        "color": null,
        "flavor": null,
        "voltage": null,
        "images": [
          {
            "image": "K72DsyIch55NcBOX11uEnUOPNCQSvtjb271O8TB7.jpg",
            "order": 1
          }
        ],
        "attributes": [],
        "daily_sale": null
      }
    ],
    "item_week_days": [
      {
        "id": 1,
        "week_day": 0,
        "name": "segunda",
        "status": "AVAILABLE"
      },
      {
        "id": 2,
        "week_day": 1,
        "name": "terca",
        "status": "AVAILABLE"
      },
      {
        "id": 3,
        "week_day": 2,
        "name": "quarta",
        "status": "AVAILABLE"
      },
      {
        "id": 4,
        "week_day": 3,
        "name": "quinta",
        "status": "AVAILABLE"
      },
      {
        "id": 5,
        "week_day": 4,
        "name": "sexta",
        "status": "AVAILABLE"
      },
      {
        "id": 6,
        "week_day": 5,
        "name": "sabado",
        "status": "AVAILABLE"
      },
      {
        "id": 7,
        "week_day": 6,
        "name": "domingo",
        "status": "AVAILABLE"
      }
    ],
    "mandatory_groups": [],
    "daily_sale": null,
    "menu_categories": [
      {
        "id": 815746,
        "name": "açucares e adoçantes",
        "culinary_id": 698
      }
    ]
  }
}
```

--------------------------------

### List Neighborhoods API Request (Multiple Languages)

Source: https://developer.aiqfome.com/docs/api/v2/list-neighborhoods

This snippet demonstrates how to list neighborhoods using the aiqfome API V2. It includes examples for various programming languages and HTTP clients, showing how to make a GET request with query and header parameters. Ensure you replace '<token>' with your actual API token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://plataforma.aiqfome.com/api/v2/auxiliary/neighborhood");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```http
GET /api/v2/auxiliary/neighborhood HTTP/1.1
Host: plataforma.aiqfome.com
User-Agent: parceiro (parceiro@parceiro.com)
Accept: application/json
Authorization: Bearer <token>
```

```javascript
const fetch = require('node-fetch');

const options = {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer <token>',
    'User-Agent': 'parceiro (parceiro@parceiro.com)'
  }
};

fetch('https://plataforma.aiqfome.com/api/v2/auxiliary/neighborhood?filter[city]=garanhuns&filter[name]=centro&store_id=43&per_page=43&page=43', options)
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok');
    }
    return response.json();
  })
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

```python
import requests

url = "https://plataforma.aiqfome.com/api/v2/auxiliary/neighborhood"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
    "User-Agent": "parceiro (parceiro@parceiro.com)"
}
params = {
    "filter[city]": "garanhuns",
    "filter[name]": "centro",
    "store_id": 43,
    "per_page": 43,
    "page": 43
}

response = requests.get(url, headers=headers, params=params)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

--------------------------------

### Item Data Structure Example

Source: https://developer.aiqfome.com/docs/api/v2/show-menu-by-url

This JSON snippet illustrates the structure of an item, including its ID, name, and a list of available item sizes. Each item size contains details like SKU, name, status, flavor limits, pricing, and inventory information.

```json
{
  "id": 0,
  "name": "SPICY"
}
```

--------------------------------

### Item Size Details Example

Source: https://developer.aiqfome.com/docs/api/v2/show-menu-by-url

This JSON snippet details the structure for an individual item size. It includes unique identifiers, SKU, size name, availability status, flavor constraints, pricing (regular and promotional), inventory levels, and active inventory status.

```json
{
  "item_size_id": 14405798,
  "size_id": 1755816,
  "sku": "abc123",
  "name": "p",
  "status": "AVAILABLE",
  "flavors_amount": 1,
  "additional_max_limit": 0,
  "value": "29.99",
  "promotional_value": "25.99",
  "inventory_quantity": 1,
  "is_inventory_active": true,
  "daily_sale": null
}
```

--------------------------------

### GET /api/v2/orders

Source: https://developer.aiqfome.com/docs/api/v2/list-unread-oread

Retrieve a list of unread orders for authorized stores.

```APIDOC
## GET /api/v2/orders

### Description
Retrieves a list of unread orders for the authenticated partner stores.

### Method
GET

### Endpoint
https://plataforma.aiqfome.com/api/v2/orders

### Parameters
#### Query Parameters
- **filter[store_ids]** (string) - Required - Store IDs separated by comma (e.g., "12,13")

#### Header Parameters
- **User-Agent** (string) - Required - Partner identification string (e.g., "parceiro (parceiro@parceiro.com)")

### Request Example
GET /api/v2/orders?filter[store_ids]=12,13
Host: plataforma.aiqfome.com
User-Agent: parceiro (parceiro@parceiro.com)

### Response
#### Success Response (200)
- **data** (array) - List of unread order objects

#### Response Example
{
  "data": [
    {
      "id": "12345",
      "status": "unread"
    }
  ]
}
```

--------------------------------

### Mark Order as Ready - cURL Example

Source: https://developer.aiqfome.com/docs/api/v2/order-ready

Provides a cURL command to mark an order as ready. This command sends a POST request to the API endpoint, including the necessary headers for content type and authorization, and the order ID in the request body.

```shell
curl -X POST \
  https://plataforma.aiqfome.com/api/v2/orders/mark-as-ready \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{ "order_id": 14 }'
```

--------------------------------

### Product Discount Structure

Source: https://developer.aiqfome.com/docs/api/v2/show-menu

This snippet illustrates the structure for defining discounts on products, including discount type and the specific day of the week it applies to. It shows how different discounts can be set for each day.

```json
{
  "discount": "9.00",
  "discount_type": 1,
  "week_day": {
    "code": 4,
    "name": "sexta-feira"
  }
}
```

--------------------------------

### GET /api/v2/menu/:store_id/categories

Source: https://developer.aiqfome.com/docs/api/v2/list-categories

Retrieves a paginated list of categories for a specific store.

```APIDOC
## GET /api/v2/menu/:store_id/categories

### Description
Retrieves a list of categories associated with a specific store. Requires the 'aqf:menu:read' scope.

### Method
GET

### Endpoint
https://plataforma.aiqfome.com/api/v2/menu/:store_id/categories

### Parameters
#### Path Parameters
- **store_id** (integer) - Required - The ID of the store.

#### Query Parameters
- **filter[status]** (integer) - Optional - Status of the category.
- **per_page** (integer) - Optional - Number of registers by page.
- **page** (integer) - Optional - The page number to retrieve.

### Request Example
GET /api/v2/menu/10/categories?per_page=3&page=1

### Response
#### Success Response (200)
- **data** (array) - List of category objects.
- **links** (object) - Pagination navigation links.
- **meta** (object) - Pagination metadata.

#### Response Example
{
  "data": [
    {
      "id": 349485,
      "name": "category 1",
      "description": "category docs dummy description",
      "available_at": "09:00 - 10:00 / 17:00 - 21:00",
      "status": "AVAILABLE"
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 13
  }
}
```

--------------------------------

### GET /api/v2/menu/:store_id

Source: https://developer.aiqfome.com/docs/api/v2/show-menu

Retrieves the menu or catalog for a specific store identified by its ID.

```APIDOC
## GET /api/v2/menu/:store_id

### Description
Retrieves the complete menu or catalog structure for a specified store. This endpoint requires the 'aqf:menu:read' scope.

### Method
GET

### Endpoint
https://plataforma.aiqfome.com/api/v2/menu/:store_id

### Parameters
#### Path Parameters
- **store_id** (integer) - Required - The unique identifier of the store.

#### Header Parameters
- **User-Agent** (string) - Required - Identification of the partner application (e.g., "parceiro (parceiro@parceiro.com)").

### Request Example
GET /api/v2/menu/5
User-Agent: parceiro (parceiro@parceiro.com)

### Response
#### Success Response (200)
- **data** (object) - The menu or catalog structure for the requested store.

#### Response Example
{
  "store_id": 5,
  "menu": {
    "categories": [],
    "items": []
  }
}
```

--------------------------------

### Retrieve Catalog Items via C# HttpClient

Source: https://developer.aiqfome.com/docs/api/v2/list-item

Demonstrates how to perform an authenticated GET request to the aiqfome catalog endpoint using the C# HttpClient class. It includes setting the Authorization header with a Bearer token and reading the JSON response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://plataforma.aiqfome.com/api/v2/catalog/:store_id/items");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### GET /api/v2/store/:store_id/ratings

Source: https://developer.aiqfome.com/docs/api/v2/list-ratings

Retrieves the list of ratings for a specific store identified by the store_id.

```APIDOC
## GET /api/v2/store/:store_id/ratings

### Description
Retrieves a list of customer ratings for a specific store. This endpoint requires the 'aqf:store:read' scope.

### Method
GET

### Endpoint
https://plataforma.aiqfome.com/api/v2/store/:store_id/ratings

### Parameters
#### Path Parameters
- **store_id** (integer) - Required - The unique ID of the store.

#### Header Parameters
- **User-Agent** (string) - Required - Identification of the partner application (e.g., "parceiro (parceiro@parceiro.com)").

### Request Example
GET /api/v2/store/1/ratings

### Response
#### Success Response (200)
- **ratings** (array) - List of rating objects associated with the store.

#### Response Example
{
  "ratings": [
    {
      "id": 123,
      "score": 5,
      "comment": "Excelente atendimento!"
    }
  ]
}
```

--------------------------------

### Daily Sales Discount Configuration

Source: https://developer.aiqfome.com/docs/api/v2/show-menu-by-url

Configures daily sales discounts, specifying the start and end dates for the promotion. It includes a list of daily weekday sales, each with a discount amount, discount type, and the corresponding day of the week.

```json
{
  "id": 168151,
  "start": "2022-12-01",
  "end": "2022-12-07",
  "daily_weekday_sale": [
    {
      "discount": "10.00",
      "discount_type": 1,
      "week_day": {
        "code": 0,
        "name": "segunda-feira"
      }
    },
    {
      "discount": "10.00",
      "discount_type": 0,
      "week_day": {
        "code": 1,
        "name": "terça-feira"
      }
    },
    {
      "discount": "10.00",
      "discount_type": 0,
      "week_day": {
        "code": 2,
        "name": "quarta-feira"
      }
    },
    {
      "discount": "10.00",
      "discount_type": 0,
      "week_day": {
        "code": 3,
        "name": "quinta-feira"
      }
    },
    {
      "discount": "10.00",
      "discount_type": 0,
      "week_day": {
        "code": 4,
        "name": "sexta-feira"
      }
    },
    {
      "discount": "10.00",
      "discount_type": 0,
      "week_day": {
        "code": 5,
        "name": "sábado"
      }
    },
    {
      "discount": "10.00",
      "discount_type": 0,
      "week_day": {
        "code": 6,
        "name": "domingo"
      }
    }
  ]
}
```

--------------------------------

### Full Item Object Example

Source: https://developer.aiqfome.com/docs/api/v2/show-menu-by-url

This JSON snippet represents a comprehensive item object from the AIQFome API. It includes the item's UUID, SKU, name, description, order priority, highlight status, exclusion status, availability, comments, associated tags, and a list of available item sizes with their specific details.

```json
{
  "uuid": "fbaa1066-9776-342c-9711-fc9cbc053d75",
  "sku": "abc0003",
  "name": "chocolate",
  "description": "mussarela, chocolate, creme de leite e morango",
  "order": 4,
  "highlighted": false,
  "excluded": false,
  "status": "AVAILABLE",
  "blocked_until_tomorrow": false,
  "comments": "|3|",
  "tags": [
    {
      "id": 3,
      "name": "CANDY"
    }
  ],
  "item_sizes": [
    {
      "item_size_id": 14405808,
      "size_id": 1755816,
      "sku": "abc123",
      "name": "p",
      "status": "AVAILABLE",
      "flavors_amount": 1
    }
  ],
  "item_week_days": [
    {
      "id": 1,
      "week_day": 0,
      "name": "segunda-feira",
      "status": "AVAILABLE"
    }
  ],
  "mandatory_groups": [],
  "daily_sale": null
}
```

--------------------------------

### Daily Weekday Sale Details Example

Source: https://developer.aiqfome.com/docs/api/v2/show-menu-by-url

This JSON snippet shows the details of a specific weekday sale, including the discount amount, discount type, and the corresponding day of the week with its code and name.

```json
{
  "discount": "5.99",
  "discount_type": 1,
  "week_day": {
    "code": 0,
    "name": "segunda-feira"
  }
}
```