# Product Modifiers Group API

API for managing product modifier groups

**Version:** 1.0.0

## Overview

### Base URLs

- **Production server**: `https://api.repzo.me/v1`

### API Categories

- **Product Modifiers Group**: Product modifier group management operations

## Authentication

This API uses the following authentication methods:

- **ApiKeyAuth**

## Endpoints

### `/product-modifiers-group`

#### GET /product-modifiers-group

**Summary:** Get all product modifier groups

**Description:** Retrieve a list of all product modifier groups with optional filtering and pagination

**Tags:** Product Modifiers Group

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `page` | query | integer | No | Page number for pagination |

| `per_page` | query | integer | No | Number of items per page |

| `sort` | query | string | No | Sort field |

| `company_namespace` | query | array | No | Company namespace for filtering |

| `disabled` | query | boolean | No | Filter by disabled status |

| `_id` | query | array | No | Filter by ID |

##### Responses

**200** - Successful response

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**500** - No description

---

#### POST /product-modifiers-group

**Summary:** Create a new product modifier group

**Description:** Create a new product modifier group entry

**Tags:** Product Modifiers Group

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Product modifier group created successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**422** - No description

**500** - No description

---

### `/product-modifiers-group/{id}`

#### GET /product-modifiers-group/{id}

**Summary:** Get product modifier group by ID

**Description:** Retrieve a specific product modifier group by its ID

**Tags:** Product Modifiers Group

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Product modifier group ID |

##### Responses

**200** - Successful response

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**404** - No description

**500** - No description

---

#### PATCH /product-modifiers-group/{id}

**Summary:** Update product modifier group

**Description:** Update an existing product modifier group

**Tags:** Product Modifiers Group

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Product modifier group ID |

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Product modifier group updated successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**404** - No description

**422** - No description

**500** - No description

---

#### DELETE /product-modifiers-group/{id}

**Summary:** Delete product modifier group

**Description:** Delete a product modifier group by ID

**Tags:** Product Modifiers Group

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Product modifier group ID |

##### Responses

**200** - Product modifier group deleted successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**404** - No description

**500** - No description

---

### `/product-modifiers-group/remove`

#### POST /product-modifiers-group/remove

**Summary:** Bulk delete product modifier groups

**Description:** Delete multiple product modifier groups by their IDs

**Tags:** Product Modifiers Group

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Product modifier groups deleted successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**500** - No description

---

## Data Models

### ProductModifiersGroup

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `_id` | string | No | Unique identifier |

| `name` | string | Yes | Product modifier group name |

| `description` | string | No | Group description |

| `modifiers` | array | No | List of modifiers in this group |

| `is_required` | boolean | No | Whether selecting a modifier from this group is required |

| `max_selection` | integer | No | Maximum number of modifiers that can be selected |

| `company_namespace` | array | No | Company namespace |

| `disabled` | boolean | No | Whether the group is disabled |

| `createdAt` | string | No | Creation timestamp |

| `modifiedAt` | string | No | Last modification timestamp |

| `SVClient` | integer | No | Client version |

| `__v` | integer | No | Document version |

### ProductModifier

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `_id` | string | No | Modifier ID |

| `name` | string | No | Modifier name |

| `price_adjustment` | number | No | Price adjustment for this modifier |

| `description` | string | No | Modifier description |

### CreateProductModifiersGroupRequest

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `name` | string | Yes | Product modifier group name |

| `description` | string | No | Group description |

| `modifiers` | array | No | No description |

| `is_required` | boolean | No | Whether selecting a modifier from this group is required |

| `max_selection` | integer | No | Maximum number of modifiers that can be selected |

| `company_namespace` | array | No | Company namespace |

| `disabled` | boolean | No | Whether the group is disabled |

### UpdateProductModifiersGroupRequest

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `name` | string | No | Product modifier group name |

| `description` | string | No | Group description |

| `modifiers` | array | No | No description |

| `is_required` | boolean | No | Whether selecting a modifier from this group is required |

| `max_selection` | integer | No | Maximum number of modifiers that can be selected |

| `company_namespace` | array | No | Company namespace |

| `disabled` | boolean | No | Whether the group is disabled |

### PagingInfo

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `total` | integer | No | Total number of items |

| `page` | integer | No | Current page number |

| `per_page` | integer | No | Items per page |

| `pages` | integer | No | Total number of pages |

## TypeScript Usage

See [product-modifiers-group-examples.md](./product-modifiers-group-examples.md) for detailed TypeScript usage examples.