Option Variations

Get a list of configurator option variations

GET /configurator-option-variations

Retrieve a List of Configurator Option Variations

Endpoint: GET /open-api/v1/configurator-option-variations

Description: This endpoint retrieves all available variations for a specific configurator option. It provides detailed information about each variation, including attributes and available customization options.

Request Parameters:

• configurator_id (required): The unique identifier for the configurator.

• option_id (required): The unique identifier for the configurator option.

Response Format: Returns a JSON object containing an array of option variations.

Example Response:

{
  "status": "success",
  "data": [
    {
      "variation_id": "string",
      "name": "string",
      "description": "string",
      "attributes": {
         "color": "string",
         "size": "string"
      },
      "available": true
    }
  ]
}

Notes:

• Ensure proper authentication headers are included in the request to access the endpoint.

• Check the response for the status key to verify if the retrieval was successful.

Retrieve a list of configurator option variations

get

Get a list of configurator option variations.

Authorizations

Query parameters

configurator_option_idintegerOptional

The ID of the configurator option for which to retrieve variations.

Example: 45

Responses

200

List of configurator option variations

application/json

400

Invalid request parameters

401

Unauthorized request

403

Forbidden - user does not have permission

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-option-variations HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {
      "id": 1,
      "configurator_id": 127,
      "configurator_option_id": 45,
      "configurator_option_value": "Red",
      "title": "Red Glossy",
      "name": "Glossy Finish",
      "settings": "{}",
      "created_at": "2024-02-25T12:00:00Z",
      "updated_at": "2024-02-25T12:30:00Z"
    }
  ]
}