Option Restrictions

Get a list of configurator option restrictions

GET /configurator-option-restrictions

Simplio3D API: Configurator Option Restrictions (GET Endpoint)

The configurator option restrictions GET endpoint allows you to retrieve a list of options and their associated restrictions for product configurations.

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

Parameters:

• productId (required): The ID of the product whose configuration options you want to retrieve.

Response: Returns a JSON object containing:

• optionId: The ID of the configuration option.

• restrictedOptions: A list of option IDs that are restricted when this option is chosen.

Example Request:

GET /open-api/v1/configurator-option-restrictions?productId=12345

Usage: Use this endpoint to ensure that the user's selections adhere to the defined restrictions, providing a seamless and error-free configuration process.

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 option restrictions

get

Get a list of configurator option restrictions.

Authorizations

Query parameters

configurator_option_idintegerOptional

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

Example: 17

order_bystringOptional

Column to order results by (e.g., 'created_at')

Example: created_at

orderstring · enumOptional

Sorting order (asc or desc)

Example: descPossible values:

per_pageintegerOptional

Number of records per page (-1 for all records)

Example: 25

pageintegerOptional

Number of page

Example: 2

Responses

200

List of configurator option restrictions

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-restrictions HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {
      "id": 1,
      "configurator_id": 127,
      "configurator_option_id": 17,
      "configurator_option_value": "Red",
      "settings": "{}",
      "note": "Restricted due to availability",
      "created_at": "2024-02-25T12:00:00Z",
      "updated_at": "2024-02-25T12:30:00Z"
    }
  ]
}