API Documentation

Introduction

Simplio3D has an API library ready to unlock integration with third-party systems such as ERPs, CRMs and other web services and to increase the degree of customization in terms of implementing a product configurator using the Simplio3D foundation.

The platform offers REST API access at 2 levels:

Pro subscriptions: Partner API
Enterprise subscription: Dashboard and Open API

Pro subscription: Partner REST API

If you are a Pro user, you have access to the Partner API and in your user account profile you can generate a token to execute and generate a JSON response. The Partner API only handles the execution of order data coming from the 3D configurators. Here is an example of a JSON result below:

      {
          "id": 22,
          "price": 250,
          "status": "new",
          "customer_details": {
            "Phone": "000",
            "Last Name": "John",
            "First Name": "Smith",
            "Email address": "john@smith.smith",
            "GDPR/DSA": "yes"
          },
          "configurator_summary": {
            "Width": "60inches",
            "Colors": "Vintage Brown Wood",
            "Height": "60inches",
            "Profile Depth": "4inches",
            "Opening System": "Tilt & turn (left)",
            "Type of Window": "Tilt & Turn",
            "Upright Fanlight": "No upper fanlight"
          },
          "invoice_url": 1,
          "order_shopify": {
            "id": 3,
            "shopify_draft_order_id": "000",
            "order_id": 22,
            "currency": "INR",
            "invoice_url": "[link]invoices/f1c6f192caa9e1570dc7be672437d3ec",
            "return_url": "[link]configurator",
            "total_price": 250,
            "subtotal_price": 250,
            "total_tax": 20.64,
            "status": "open",
            "created_at": "2025-01-21T15:15:22.000000Z",
            "updated_at": "2025-01-21T15:15:22.000000Z"
          },
          "created_at": "2025-01-21 15:15:21",
          "updated_at": "2025-01-21 15:15:21"
        },

Enterprise subscription: Dashboard and Open API

Enterprise allows access to both the Dashboard and the Open API. This is for more advanced customization solutions, useful for IT development teams that want to implement more complex configurators based on the Simplio3D foundation.

PreviousOrders NextChange Log

Last updated 1 month ago

Was this helpful?

{ "id": 22, "price": 250, "status": "new", "customer_details": { "Phone": "000", "Last Name": "John", "First Name": "Smith", "Email address": "john@smith.smith", "GDPR/DSA": "yes" }, "configurator_summary": { "Width": "60inches", "Colors": "Vintage Brown Wood", "Height": "60inches", "Profile Depth": "4inches", "Opening System": "Tilt & turn (left)", "Type of Window": "Tilt & Turn", "Upright Fanlight": "No upper fanlight" }, "invoice_url": 1, "order_shopify": { "id": 3, "shopify_draft_order_id": "000", "order_id": 22, "currency": "INR", "invoice_url": "[link]invoices/f1c6f192caa9e1570dc7be672437d3ec", "return_url": "[link]configurator", "total_price": 250, "subtotal_price": 250, "total_tax": 20.64, "status": "open", "created_at": "2025-01-21T15:15:22.000000Z", "updated_at": "2025-01-21T15:15:22.000000Z" }, "created_at": "2025-01-21 15:15:21", "updated_at": "2025-01-21 15:15:21" },