API docs by Redocly

Product Modifiers Group API (1.0.0)

Download OpenAPI specification:Download

API for managing product modifier groups

Product Modifiers Group

Product modifier group management operations

Get all product modifier groups

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

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

disabled
boolean

Filter by disabled status

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new product modifier group

Create a new product modifier group entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Product modifier group name

description
string

Group description

Array of objects
is_required
boolean
Default: false

Whether selecting a modifier from this group is required

max_selection
integer
Default: 1

Maximum number of modifiers that can be selected

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the group is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Size Options",
  • "description": "Available size options for products",
  • "modifiers": [
    ],
  • "is_required": false,
  • "max_selection": 1,
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get product modifier group by ID

Retrieve a specific product modifier group by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Product modifier group ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update product modifier group

Update an existing product modifier group

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Product modifier group ID

Request Body schema: application/json
name
string

Product modifier group name

description
string

Group description

Array of objects
is_required
boolean

Whether selecting a modifier from this group is required

max_selection
integer

Maximum number of modifiers that can be selected

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the group is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Size Options",
  • "description": "string",
  • "modifiers": [
    ],
  • "is_required": true,
  • "max_selection": 0,
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete product modifier group

Delete a product modifier group by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Product modifier group ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete product modifier groups

Delete multiple product modifier groups by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of product modifier group IDs to delete

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}