Configurators

Retrieve detailed information about a specific configurator

GET /configurator/{id}

Endpoint

GET /open-api/v1/configurator/{id}

Description

Retrieve detailed information about a specific configurator identified by the unique id.

Parameters

  • id (required): A unique identifier for the configurator you want to retrieve.

Request Example

GET /api/configurators/12345 HTTP/1.1
Host: api.simplio3d.com
Authorization: Bearer {access_token}
Accept: application/json

Response

  • 200 OK: The request was successful, and the configurator details are returned.

  • 404 Not Found: No configurator was found with the specified id.

Response Example

{
  "id": "12345",
  "name": "3D Configurator",
  "description": "A sample 3D product configurator",
  "created_at": "2023-05-12T14:30:00Z"
}

Error Handling

  • Ensure the id provided is correct and exists.

  • Verify authentication token is valid and has adequate permissions.

Notes

  • Make sure to replace {id} with the actual configurator ID you need.

  • Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint.

Get configurator by ID

get

Get a specific configurator by ID.

Authorizations
Responses
200
Successful response
application/json
get
GET /api/open-api/v1/configurator/show HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*
{
  "id": 1,
  "name": "3D Product Configurator",
  "configurator_type": "Advanced",
  "configurator_template": "Default Template",
  "configurator_integration": "Shopify",
  "created_at": "2024-02-25T12:00:00Z",
  "updated_at": "2024-02-25T12:30:00Z",
  "created_by": "John Doe"
}

Last updated

Was this helpful?