Options
Managing Configurator Options
GET /configurator-options/types/list
Retrieve Available Configurator Option Types
Endpoint
GET /open-api/v1/configurator-options/types/list
Description
This endpoint retrieves the list of available configurator option types supported by Simplio3D.
Request Headers
Authorization: Bearer token for authentication
Response
200 OK: Returns a JSON object containing an array of available option types.
400 Bad Request: Invalid request parameters.
401 Unauthorized: Invalid or missing authentication token.
Example Response
Notes
Ensure you have valid authentication to access this endpoint.
Utilize the retrieved option types to understand and configure products efficiently within Simplio3D.
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.
GET /configurator-option/{id}
Retrieve details of a specific configurator option using its ID.
GET /configurator-option/{id}
GET /configurator-option/{id}Request
Endpoint:
/configurator-option/{id}Method:
GETAuthentication: Required
Parameters
id (string): The unique identifier of the configurator option.
Response
A successful request returns a JSON object with details of the configurator option, including:
id (string): The unique identifier of the option.
name (string): The name of the option.
description (string, optional): A description of the option.
type (string): The type of option, e.g., "color", "size".
values (array): The possible values for this option.
Example Request
Example Response
Notes
Ensure proper handling of the authentication token in your API calls.
Use this endpoint to look up and validate option specifications for product configurators.
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.
GET /configurator-options
Fetch All Configurator Options
To retrieve all configurator options, use the GET /configurator-options endpoint. This endpoint returns a list of options available for product configuration.
Request
Method: GET
Endpoint:
/configurator-optionsHeaders:
Authorization: Bearer <your_auth_token>
Response
A successful response will return a JSON object with details such as option
id,name,description,type, andvalues.
Example Response
Notes
Ensure that the authentication token is included in the request header to access the endpoint successfully.
Use this data to validate and check available options for product configurators efficiently.
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.
GET /configurator-options-variations
Retrieve a List of Configurator Option Variations
To retrieve a list of configurator option variations, you will need to make a GET request to the Simplio3D API endpoint designed for this purpose. Below is a brief explanation of how to interact with this endpoint:
Endpoint:
GET /api/configurator-options-variations
Headers:
Authorization: Bearer YOUR_AUTH_TOKEN
Response Format:
The endpoint responds with a JSON array where each element contains details about a specific configurator option. Example structure of each item in the array:
id: Unique identifier for the option.name: Name of the option.description: Brief description of the option.type: Type of input field (e.g., "color", "dropdown").values: An array of possible values.
Ensure to replace YOUR_AUTH_TOKEN with your actual authentication token and verify that your request headers are correctly set for successful interaction with the API.
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.
Last updated
Was this helpful?