Price Groups

Managing configurator price groups

GET /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:

  {
    "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.

Retrieve a list of configurator price groups

get

Get a list of configurator price groups.

Authorizations

Responses

200

List of configurator price groups

application/json

400

Invalid request parameters

401

Unauthorized request

403

Forbidden - user does not have access

500

Internal server error

get

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": 1,
      "configurator_id": 127,
      "title": "Premium Package",
      "type": "Fixed Price",
      "variable_type": "Percentage",
      "settings": {
        "discount": "10%",
        "tiered_pricing": true
      },
      "prices": [
        {
          "amount": 99.99,
          "currency": "USD"
        }
      ],
      "created_at": "2024-02-25T12:00:00Z",
      "updated_at": "2024-02-25T12:30:00Z"
    }
  ]
}

GET /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>

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

Get details of a specific configurator price group.

Authorizations

Path parameters

configurator_price_group_idintegerRequired

The ID of the configurator price group to retrieve

Example: 1

Responses

200

Configurator price group details retrieved successfully

application/json

400

Invalid request parameters

401

Unauthorized request

403

Forbidden - user does not have permission

404

Configurator price group not found

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-price-groups/{configurator_price_group_id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

{
  "id": 1,
  "configurator_id": 127,
  "title": "Premium Package",
  "type": "Fixed Price",
  "variable_type": "Percentage",
  "settings": {
    "discount": "10%",
    "tiered_pricing": true
  },
  "prices": [
    {
      "amount": 99.99,
      "currency": "USD"
    }
  ],
  "created_at": "2024-02-25T12:00:00Z",
  "updated_at": "2024-02-25T12:30:00Z"
}

GET /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

Get a list of configurator price group variables.

Authorizations

Responses

200

List of configurator price group variables

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

{
  "data": [
    {
      "id": 1,
      "configurator_id": 127,
      "title": "Premium Package",
      "type": "Fixed Price",
      "variable_type": "Percentage",
      "settings": {
        "discount": "10%",
        "tiered_pricing": true
      },
      "prices": [
        {
          "amount": 99.99,
          "currency": "USD"
        }
      ],
      "created_at": "2024-02-25T12:00:00Z",
      "updated_at": "2024-02-25T12:30:00Z"
    }
  ]
}