Simplio3D
HomeHelp Center
  • INTRODUCTION
  • GETTING STARTED
    • Create an account
    • Prepare 3D models
  • LEARNING THE APP
    • Dashboard
    • My Account
    • Products
      • New Product
      • Select Layout
      • Add 3D Models
        • 3D Model versions
      • Create Options
        • Default
        • Sections
        • Dropdown
        • Material
        • Checkbox
        • Toggle
        • Thumbnails
        • Arrows
        • Upload
        • Text
        • Numeral
          • Sizing: Keep the proportions
        • Restrictions
          • 'Has one or more variants selected from' type of restriction
          • 'The variant value is between min and max' type of restriction
      • Pricing
        • Pricing formula
        • Variables
        • Add price
      • Add form
        • Add Field
        • Email Settings
          • Gmail
          • Sendgrid
      • Share
      • Product Viewer
    • Materials
      • New Materials
      • Textures
      • SVG
      • Categories
    • 3D Assets
      • Edit 3D Assets
      • Categories
      • File too large
    • Orders
  • Integrations
    • WooCommerce
    • Shopify
    • API Documentation
  • API Reference
    • Partner API
      • Managing Orders
    • Open API
      • Getting Started
      • User Authentication
      • 3D Assets
      • Configurators
      • Contact Form
        • Form Fields
        • Forms
      • Options
        • Options
        • Option Variations
        • Option Restrictions
      • Price Groups
      • Share
      • Materials
        • Materials
        • Material Categories
      • Textures
        • Textures
        • Texture Categories
      • Orders
    • Web SDK
  • Other
    • Change Log
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Open API
  3. Materials

Material Categories

API endpoints for managing material categories

GET /materials/categories

Get List of Materials Categories (Without Pagination) Endpoint

Endpoint: GET /open-api/v1/materials/categories

Description

Fetches a complete list of material categories from the Simplio3D API without pagination.

Request Headers

  • Authorization: Bearer token required.

Sample Request

GET /open-api/v1/materials/categories HTTP/1.1
Host: api.simplio3d.com
Authorization: Bearer {your_api_token}

Response

  • Status Code: 200 OK

  • Body: A JSON array containing the material categories available.

  • [
        {
            "id": "1",
            "name": "Wood"
        },
        {
            "id": "2",
            "name": "Metal"
        }
        // ... other categories
    ]

    Error Handling

    • 401 Unauthorized: If the authorization token is missing or invalid.

    • 500 Internal Server Error: For generic server-side errors.

GET /materials/categories/{id}

Get a Specific Material Category by ID

GET /open-api/v1/materials/categories/{id} HTTP/1.1
Host: api.simplio3d.com
Authorization: Bearer {your_api_token}

Response

  • Status Code: 200 OK

  • Materials Not Found: 404

  • Unauthorized: 401

PreviousMaterialsNextTextures

Last updated 22 days ago

Was this helpful?

Get list of materials categories (without pagination)

get

Get all materials categories without pagination.

Authorizations
Query parameters
order_bystringOptional

Column to order the results by (default: created_at)

Example: name
orderstring · enumOptional

Order direction (asc or desc, default: desc)

Example: ascPossible values:
Responses
200
Successful response
application/json
401
Unauthorized
500
Internal Server Error
get
GET /api/open-api/v1/materials-categories/list HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*
[
  {
    "id": 1,
    "title": "Wood",
    "description": "Wood-based materials",
    "created_at": "2024-02-26 12:00:00",
    "updated_at": "2024-02-27 15:00:00",
    "created_by": "John Doe"
  }
]

Get materials category by ID

get

Get a specific materials category by ID.

Authorizations
Path parameters
idinteger · int64Required

ID of the materials category

Responses
200
Successful response
application/json
401
Unauthorized
404
Materials category not found
get
GET /api/open-api/v1/materials-categories/{id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*
{
  "id": 1,
  "title": "Wood",
  "description": "Wood-based materials",
  "created_at": "2024-02-26 12:00:00",
  "updated_at": "2024-02-27 15:00:00",
  "created_by": "John Doe"
}
  • GET /materials/categories
  • Get List of Materials Categories (Without Pagination) Endpoint
  • GETGet list of materials categories (without pagination)
  • GET /materials/categories/{id}
  • GETGet materials category by ID