# Get add on group details

`GET /api/v1/Tenants/{tenantId}/AddOnGroups/{id}`

Core API · AddOnGroups · base URL `https://core-api.ancon.io` · auth: `Access-Token` header · docs: https://ancon.dev/api/core/add-on-groups/get-add-on-group-details

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tenantId` | string (uuid) | yes |  |
| `id` | string (uuid) | yes |  |

## Header parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `correlationId` | string | no | Correlation Id for the request |

## Responses

| Status | Description |
| --- | --- |
| 200 | OK |
| 401 | Unauthorized |
| 404 | Not Found |

### 200 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `addOnGroup` | object or null | no |  |
| `addOnGroup.id` | string (uuid) | no |  |
| `addOnGroup.tenantId` | string (uuid) | no |  |
| `addOnGroup.name` | string or null | no | Name of the add-on group. The name is used to easily identify the group. |
| `addOnGroup.minimumAmount` | number (double) | no | Minimum amount of ingredients from this group you must add to the order. 0 means it has no minimum amount. |
| `addOnGroup.maximumAmount` | number (double) | no | Maximum amount of ingredients from this group you are allowed to add to the order. 0 means it has no maximum amount. |
| `addOnGroup.allowMultiple` | boolean | no | A value indicating whether to allow multiple of the same ingredients from this group to be added to the order. |
| `addOnGroup.freeAmount` | number (double) | no | Aount of ingredients that will be free of charge from this group. 0 menas it has no free ingredients and the normal ingredient prices will be used. |
| `addOnGroup.afterFreePrice` | object or null | no | Price that will be set for all ingredients that exceedes the 'FreeAmount'. If 'FreeAmount' is 0 then this price will not be used. |
| `addOnGroup.afterFreePrice.amount` | number (double) | no |  |
| `addOnGroup.afterFreePrice.currency` | string or null | no |  |
| `addOnGroup.ingredients` | array<object> or null | no | List of of ingredients and their prices. |
| `addOnGroup.ingredients[].id` | string (uuid) | no |  |
| `addOnGroup.ingredients[].name` | string or null | no |  |
| `addOnGroup.ingredients[].position` | integer (int32) | no | Sorting position of the ingredient in the group |
| `addOnGroup.ingredients[].hasOwnPrice` | boolean | no | Whether the connected ingredient price is overriden for this add-on group. If this is set to false the price from the ingredient will be used. |
| `addOnGroup.ingredients[].defaultPrice` | object or null | no | The default price on the ingredient, used if 'HasOwnPrice' is false |
| `addOnGroup.ingredients[].defaultPrice.amount` | number (double) | no |  |
| `addOnGroup.ingredients[].defaultPrice.currency` | string or null | no |  |
| `addOnGroup.ingredients[].price` | object or null | no | The overriden price for the connected ingredient, used if 'HasOwnPrice' is true |
| `addOnGroup.ingredients[].price.amount` | number (double) | no |  |
| `addOnGroup.ingredients[].price.currency` | string or null | no |  |

#### Example

```json
{
  "addOnGroup": {
    "id": "cc04f947-fe95-4240-8cf4-925c9c6ccf85",
    "tenantId": "d759507f-8390-4185-a968-d70d31d5b592",
    "name": "Sauces",
    "minimumAmount": 0,
    "maximumAmount": 5,
    "allowMultiple": true,
    "freeAmount": 0,
    "afterFreePrice": {
      "amount": 0,
      "currency": "SEK"
    },
    "ingredients": [
      {
        "id": "64674261-2e4a-456d-9f3d-4b472cb72304",
        "name": "Hot Sauce",
        "position": 0,
        "hasOwnPrice": false,
        "defaultPrice": {
          "amount": 20,
          "currency": "SEK"
        },
        "price": {
          "amount": 0,
          "currency": "SEK"
        }
      },
      {
        "id": "7c397c78-c5d3-4cca-8d38-a9285029e0c2",
        "name": "BBQ Sauce",
        "position": 1,
        "hasOwnPrice": true,
        "defaultPrice": {
          "amount": 15,
          "currency": "SEK"
        },
        "price": {
          "amount": 18,
          "currency": "SEK"
        }
      }
    ]
  }
}
```

### 401 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |

#### Example (from schema)

```json
{
  "message": "string"
}
```

### 404 response (`application/json`)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | string or null | no |  |
| `errorCode` | string (uuid) | no |  |

#### Example (from schema)

```json
{
  "message": "string",
  "errorCode": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

## Example request

```bash
curl -X GET "https://core-api.ancon.io/api/v1/Tenants/{tenantId}/AddOnGroups/{id}" \
  -H "Access-Token: $ANCON_TOKEN"
```