# Get upsell group details

`GET /api/v1/Tenants/{tenantId}/UpsellGroups/{upsellGroupsId}`

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

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tenantId` | string (uuid) | yes |  |
| `upsellGroupsId` | 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 |
| --- | --- | --- | --- |
| `upsellGroup` | object or null | no |  |
| `upsellGroup.id` | string (uuid) | no |  |
| `upsellGroup.name` | string or null | no |  |
| `upsellGroup.products` | array<object> or null | no |  |
| `upsellGroup.products[].id` | string (uuid) | no |  |
| `upsellGroup.products[].productId` | string (uuid) | no |  |
| `upsellGroup.products[].variantId` | string (uuid) | no |  |
| `upsellGroup.products[].productName` | string or null | no |  |
| `upsellGroup.products[].variantName` | string or null | no |  |
| `upsellGroup.products[].hasVariants` | boolean | no |  |
| `upsellGroup.products[].position` | integer (int32) | no |  |
| `upsellGroup.products[].hasOwnPrice` | boolean | no |  |
| `upsellGroup.products[].defaultPrice` | object or null | no |  |
| `upsellGroup.products[].defaultPrice.unitPrice` | object or null | no |  |
| `upsellGroup.products[].defaultPrice.unitPrice.amount` | number (double) | no |  |
| `upsellGroup.products[].defaultPrice.unitPrice.currency` | string or null | no |  |
| `upsellGroup.products[].defaultPrice.additionalPrice` | object or null | no |  |
| `upsellGroup.products[].defaultPrice.additionalPrice.amount` | number (double) | no |  |
| `upsellGroup.products[].defaultPrice.additionalPrice.currency` | string or null | no |  |
| `upsellGroup.products[].price` | object or null | no |  |
| `upsellGroup.products[].price.unitPrice` | object or null | no |  |
| `upsellGroup.products[].price.unitPrice.amount` | number (double) | no |  |
| `upsellGroup.products[].price.unitPrice.currency` | string or null | no |  |
| `upsellGroup.products[].price.additionalPrice` | object or null | no |  |
| `upsellGroup.products[].price.additionalPrice.amount` | number (double) | no |  |
| `upsellGroup.products[].price.additionalPrice.currency` | string or null | no |  |
| `upsellGroup.products[].outletStocks` | array<object> or null | no |  |
| `upsellGroup.products[].outletStocks[].stockProductId` | string (uuid) | no |  |
| `upsellGroup.products[].outletStocks[].outletId` | string (uuid) | no |  |
| `upsellGroup.products[].outletStocks[].productVariantId` | string (uuid) | no |  |
| `upsellGroup.products[].outletStocks[].count` | number (double) | no |  |
| `upsellGroup.products[].outletStocks[].reorderCount` | number (double) | no |  |
| `upsellGroup.outletShares` | array<object> or null | no |  |
| `upsellGroup.outletShares[].id` | string (uuid) | no |  |
| `upsellGroup.outletShares[].name` | string or null | no |  |
| `upsellGroup.outletShares[].productShareType` | integer (int32) | no | Allowed values: `0`, `1`. |

#### Example

```json
{
  "upsellGroup": {
    "id": "2fdd9ee9-daa0-4e9f-89eb-2ab9c3b90859",
    "name": "Upsell group name",
    "products": [
      {
        "id": "74460152-d05a-45da-8ccc-0952a2dd5ecf",
        "productId": "d6c139c4-e0cb-4991-963c-9f65f5941269",
        "variantId": "ea99f32c-8b8c-4b9d-af42-96bfcfd434be",
        "productName": "Upsell product example 1",
        "variantName": "Upsell product example 1",
        "hasVariants": false,
        "position": 0,
        "hasOwnPrice": false,
        "defaultPrice": {
          "unitPrice": {
            "amount": 100,
            "currency": "SEK"
          },
          "additionalPrice": {
            "amount": 0,
            "currency": "SEK"
          }
        },
        "price": {
          "unitPrice": {
            "amount": 0,
            "currency": "SEK"
          },
          "additionalPrice": {
            "amount": 0,
            "currency": "SEK"
          }
        },
        "outletStocks": [
          {
            "stockProductId": "1380bdea-0cf2-476d-94a9-83823c81e23a",
            "outletId": "8ff73dfb-75bc-44fe-84a0-9b4b43570cf5",
            "productVariantId": "ff953be0-6e56-4575-a45f-3937acae5196",
            "count": 934,
            "reorderCount": 100
          }
        ]
      }
    ],
    "outletShares": [
      {
        "id": "f0e3b465-3120-4a23-a433-e9cbab4b8f70",
        "name": "Outlet share",
        "productShareType": 0
      }
    ]
  }
}
```

### 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}/UpsellGroups/{upsellGroupsId}" \
  -H "Access-Token: $ANCON_TOKEN"
```