W3Block Docs
  • 🚀Start here
    • Welcome to the Docs
    • Integrated Blockchains
  • 👨‍💻Dev Docs
    • API
      • Getting Started
      • Authentication
      • Commerce API services
        • Company Administration
          • Companies (Admin)
          • Assets (Admin)
          • Tags (Admin)
          • Products (Admin)
            • Order Rules (Admin)
          • Orders (Admin)
          • Faq (Admin)
          • Webhooks (Admin)
        • Products
        • Orders
        • Webhooks
        • Faq
        • Globals
      • Key API Services
        • Authentication
        • Companies
        • Tokens
          • Contracts
            • External Contacts
            • Royalty Eligible
          • Categories
            • Subcategories
          • Token Collections
            • Token Editions
          • Metadata
        • Blockchain
        • Cloudinary
        • Integration
          • Ecommerce
            • Associate Tokens
            • Hooks
        • Users
        • Vouchers
  • 📘Knowledge Base
    • First Steps
    • FAQ
    • Glossary
Powered by GitBook
On this page
  1. Dev Docs
  2. API
  3. Key API Services
  4. Tokens
  5. Categories

Subcategories

This module can be used to create and list subcategories (token templates)

PreviousCategoriesNextToken Collections

Last updated 2 years ago

Token Templates are the barebones of any token collection, when you create a collection you select a category for it and then a template, this contains a set of pre-defined parameters that any one of your tokens will need in its metadata.

List all subcategories

When listing subcategories you have three scope options:

  • generic: brings subcategories that are generic and are not for a specific company

  • specific: lists only subcategories created by the company

  • all: lists all of the above

Create a subcategory

Get subcategory details

Update subcategory

👨‍💻
get

List subcategories of a company

Authorizations
Path parameters
companyIdstringRequired
Query parameters
categoryIdstringOptional
scopestringOptionalExample: all
Responses
application/json
object[]Optional
get
GET /{companyId}/subcategories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "companyId": "text",
    "category": {
      "id": "text",
      "companyId": "text",
      "subcategories": [
        {}
      ],
      "name": "text",
      "image": "text",
      "createdAt": "2025-04-19T04:38:59.589Z",
      "updatedAt": "2025-04-19T04:38:59.589Z"
    },
    "categoryId": "text",
    "name": "text",
    "tokenTemplate": {
      "prop1": {
        "type": "SELECT",
        "config": {
          "required": {},
          "label": "text",
          "tooltip": "text",
          "placeholder": "text",
          "order": 1,
          "childrenType": "SELECT",
          "range": {
            "min": 1,
            "max": 1
          },
          "options": [
            "text"
          ],
          "float": true
        },
        "children": {}
      },
      "prop2": {
        "type": "SELECT",
        "config": {
          "required": {},
          "label": "text",
          "tooltip": "text",
          "placeholder": "text",
          "order": 1,
          "childrenType": "SELECT",
          "range": {
            "min": 1,
            "max": 1
          },
          "options": [
            "text"
          ],
          "float": true
        },
        "children": {}
      }
    },
    "deletedAt": "2025-04-19T04:38:59.589Z",
    "createdAt": "2025-04-19T04:38:59.589Z",
    "updatedAt": "2025-04-19T04:38:59.589Z",
    "certificateTemplate": "text"
  }
]
get

Get a subcategory by id

Authorizations
Path parameters
idstringRequired
companyIdstringRequired
Responses
application/json
objectOptional
get
GET /{companyId}/subcategories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "companyId": "text",
  "category": {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-04-19T04:38:59.589Z",
    "updatedAt": "2025-04-19T04:38:59.589Z"
  },
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {
    "prop1": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    },
    "prop2": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    }
  },
  "deletedAt": "2025-04-19T04:38:59.589Z",
  "createdAt": "2025-04-19T04:38:59.589Z",
  "updatedAt": "2025-04-19T04:38:59.589Z",
  "certificateTemplate": "text"
}
  • List all subcategories
  • GET/{companyId}/subcategories
  • Create a subcategory
  • POST/{companyId}/subcategories
  • Get subcategory details
  • GET/{companyId}/subcategories/{id}
  • Update subcategory
  • PATCH/{companyId}/subcategories/{id}
post

Create a new subcategory

Authorizations
Path parameters
companyIdstringRequired
Body
categoryIdstringRequired
namestringRequired
tokenTemplateobjectRequired
certificateTemplatestringOptional
Responses
application/json
objectOptional
post
POST /{companyId}/subcategories HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {},
  "certificateTemplate": "text"
}
{
  "id": "text",
  "companyId": "text",
  "category": {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-04-19T04:38:59.589Z",
    "updatedAt": "2025-04-19T04:38:59.589Z"
  },
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {
    "prop1": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    },
    "prop2": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    }
  },
  "deletedAt": "2025-04-19T04:38:59.589Z",
  "createdAt": "2025-04-19T04:38:59.589Z",
  "updatedAt": "2025-04-19T04:38:59.589Z",
  "certificateTemplate": "text"
}
patch

Update a subcategory by id

Authorizations
Path parameters
idstringRequired
companyIdstringRequired
Body
categoryIdstringOptional
namestringOptional
tokenTemplateobjectOptional
certificateTemplatestringOptional
Responses
application/json
objectOptional
patch
PATCH /{companyId}/subcategories/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {},
  "certificateTemplate": "text"
}
{
  "id": "text",
  "companyId": "text",
  "category": {
    "id": "text",
    "companyId": "text",
    "subcategories": [
      {}
    ],
    "name": "text",
    "image": "text",
    "createdAt": "2025-04-19T04:38:59.589Z",
    "updatedAt": "2025-04-19T04:38:59.589Z"
  },
  "categoryId": "text",
  "name": "text",
  "tokenTemplate": {
    "prop1": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    },
    "prop2": {
      "type": "SELECT",
      "config": {
        "required": {},
        "label": "text",
        "tooltip": "text",
        "placeholder": "text",
        "order": 1,
        "childrenType": "SELECT",
        "range": {
          "min": 1,
          "max": 1
        },
        "options": [
          "text"
        ],
        "float": true
      },
      "children": {}
    }
  },
  "deletedAt": "2025-04-19T04:38:59.589Z",
  "createdAt": "2025-04-19T04:38:59.589Z",
  "updatedAt": "2025-04-19T04:38:59.589Z",
  "certificateTemplate": "text"
}