# Price Groups

## <mark style="color:green;">GET</mark> /configurator-price-groups

### Retrieve a List of Configurator Price Groups

To retrieve a list of configurator price groups, you can use the following GET endpoint provided by the Simplio3D API:

#### Endpoint

```
GET /api/configurator-price-groups
```

#### Description

This endpoint retrieves a list of all price groups associated with the configurators available in the system. Each price group represents a set of pricing rules applied to a particular configurator.

#### Request

* **Method:** GET
* **URL:** `https://app.simplio3d.com/open-api/v1/configurator-price-groups`
* **Headers:**

  * `Authorization: Bearer <Your_API_Token>`

  #### Response

  A successful response returns a JSON object containing the list of configurator price groups:

  ```json
  {
    "priceGroups": [
      {
        "groupId": "1",
        "name": "Color Pricing",
        "description": "Calculate price by color"
      },
      {
        "groupId": "2",
        "name": "Width x Length Pricing",
        "description": "Calculate price by size"
      }
    ]
  }
  ```

  #### Notes

  * Ensure that you have the correct API token with sufficient permissions to access this endpoint.
  * The returned list will include each price group's unique identifier, name, and description.
  * Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

  For more detailed information, refer to the [Simplio3D API Documentation](https://docs.simplio3d.com).

## Retrieve a list of configurator price groups

> Get a list of configurator price groups.

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Price Groups","description":"API Endpoints for managing configurator price groups"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}},"schemas":{"ConfiguratorPriceGroupsResource":{"title":"Configurator Price Groups Resource","description":"Schema for configurator price groups","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"},"variable_type":{"type":"string"},"settings":{"type":"object"},"prices":{"type":"array","items":{"properties":{"amount":{"type":"number","format":"float"},"currency":{"type":"string"}},"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-price-groups":{"get":{"tags":["Configurator Price Groups"],"summary":"Retrieve a list of configurator price groups","description":"Get a list of configurator price groups.","operationId":"c9ebc0bd57516a253bcde0870c943810","responses":{"200":{"description":"List of configurator price groups","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguratorPriceGroupsResource"}}},"type":"object"}}}},"400":{"description":"Invalid request parameters"},"401":{"description":"Unauthorized request"},"403":{"description":"Forbidden - user does not have access"},"500":{"description":"Internal server error"}}}}}}
```

## <mark style="color:green;">GET</mark> /configurator-price-group/{configurator\_price\_group\_id}

#### Retrieve a Specific Configurator Price Group

This endpoint allows you to retrieve detailed information about a specific configurator price group by using its unique identifier. This can be useful for gaining insights into the pricing rules applied to a particular configurator within the system.

**Request**

* **Method:** GET
* **URL:** `https://app.simplio3d.com/open-api/v1/configurator-price-groups/{configurator_price_group_id}`
* **Headers:**
  * `Authorization: Bearer <Your_API_Token>`&#x20;

**NOTE:** Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

## Retrieve a specific configurator price group

> Get details of a specific configurator price group.

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Price Groups","description":"API Endpoints for managing configurator price groups"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}},"schemas":{"ConfiguratorPriceGroupsResource":{"title":"Configurator Price Groups Resource","description":"Schema for configurator price groups","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"},"variable_type":{"type":"string"},"settings":{"type":"object"},"prices":{"type":"array","items":{"properties":{"amount":{"type":"number","format":"float"},"currency":{"type":"string"}},"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-price-groups/{configurator_price_group_id}":{"get":{"tags":["Configurator Price Groups"],"summary":"Retrieve a specific configurator price group","description":"Get details of a specific configurator price group.","operationId":"a9a0fe95223b8d20f666cd676d9fd5f1","parameters":[{"name":"configurator_price_group_id","in":"path","description":"The ID of the configurator price group to retrieve","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Configurator price group details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfiguratorPriceGroupsResource"}}}},"400":{"description":"Invalid request parameters"},"401":{"description":"Unauthorized request"},"403":{"description":"Forbidden - user does not have permission"},"404":{"description":"Configurator price group not found"},"500":{"description":"Internal server error"}}}}}}
```

## <mark style="color:green;">GET</mark> /configurator-price-groups/variables/list

#### Retrieve a List of Configurator Price Group Variables

This endpoint allows you to obtain a list of all the variables associated with a specific configurator price group, which can help in understanding the various dynamic factors affecting pricing.

**Request**

* **Method:** GET
* **URL:** `https://app.simplio3d.com/open-api/v1/configurator-price-groups/variables/list`
* **Headers:**
  * `Authorization: Bearer <Your_API_Token>`

**NOTE:** Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

## Retrieve a list of configurator price group variables

> Get a list of configurator price group variables.

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Configurator Price Groups","description":"API Endpoints for managing configurator price groups"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}},"schemas":{"ConfiguratorPriceGroupsResource":{"title":"Configurator Price Groups Resource","description":"Schema for configurator price groups","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"},"variable_type":{"type":"string"},"settings":{"type":"object"},"prices":{"type":"array","items":{"properties":{"amount":{"type":"number","format":"float"},"currency":{"type":"string"}},"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}},"paths":{"/api/open-api/v1/configurator-price-groups/variables/list":{"get":{"tags":["Configurator Price Groups"],"summary":"Retrieve a list of configurator price group variables","description":"Get a list of configurator price group variables.","operationId":"9637e4600514977f837d8dff656f7757","responses":{"200":{"description":"List of configurator price group variables","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguratorPriceGroupsResource"}}},"type":"object"}}}},"400":{"description":"Invalid request parameters"},"401":{"description":"Unauthorized request"},"403":{"description":"Forbidden - user does not have permission"},"500":{"description":"Internal server error"}}}}}}
```

## The ConfiguratorPriceGroupsResource object

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"components":{"schemas":{"ConfiguratorPriceGroupsResource":{"title":"Configurator Price Groups Resource","description":"Schema for configurator price groups","properties":{"id":{"type":"integer"},"configurator_id":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"},"variable_type":{"type":"string"},"settings":{"type":"object"},"prices":{"type":"array","items":{"properties":{"amount":{"type":"number","format":"float"},"currency":{"type":"string"}},"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"type":"object"}}}}
```

## The ConfiguratorResource object

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"components":{"schemas":{"ConfiguratorResource":{"title":"Configurator Resource","description":"Schema for configurator data","properties":{"id":{"type":"integer"},"name":{"type":"string"},"configurator_type":{"type":"string"},"configurator_template":{"type":"string"},"configurator_integration":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"}},"type":"object"}}}}
```