Beta
Not authenticated — log in first
VendorCategories

List Categories

List Categories — vendor REST API endpoint.

GET/vendor/categoriesVendor bearer token required

List Categories

List product categories available to your vendor on the G-Commerce storefront.

What this means in plain English

Returns category trees (root categories with nested children) from the backend for the authenticated vendor. Only vendors linked to the G-Commerce storefront (or all vendors when the storefront has no vendor restrictions) receive categories. Categories are **read-only** for vendors — use [List Categories](/docs/v1/vendor/categories/list) or [Get Category](/docs/v1/vendor/categories/get) to look up existing IDs, then pass those UUIDs in product `categoryIds` when creating or updating products.

When to use this

  • Looking up category UUIDs before assigning products to categories.
  • Building category pickers in a catalog integration.

Query parameters

NameTypeRequiredDescription
includeInactivebooleanNoWhen `true`, include inactive and hidden categories. Defaults to active, visible categories only.

Request example

curl -X GET 'https://api.next.gcommerce.glass/api/v1/vendor/categories'

Response examples

200Success
[{
  "id": "550e8400-e29b-41d4-a716-446655440070",
  "name": "Industrial Supplies",
  "slug": "industrial-supplies",
  "description": "Industrial and MRO supplies",
  "pageTitle": "Industrial Supplies",
  "pageDescription": "Browse industrial supplies",
  "image": "https://api.next.gcommerce.glass/assets/categories/industrial-supplies.jpg",
  "icon": "factory",
  "parentId": null,
  "isActive": true,
  "isHidden": false,
  "isPopular": true,
  "sortOrder": 0,
  "createdAt": "2025-06-01T10:00:00.000Z",
  "updatedAt": "2025-06-01T10:00:00.000Z",
  "children": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440071",
      "name": "Hand Tools",
      "slug": "hand-tools",
      "description": null,
      "pageTitle": null,
      "pageDescription": null,
      "image": null,
      "icon": null,
      "parentId": "550e8400-e29b-41d4-a716-446655440070",
      "isActive": true,
      "isHidden": false,
      "isPopular": false,
      "sortOrder": 1,
      "createdAt": "2025-06-01T10:00:00.000Z",
      "updatedAt": "2025-06-01T10:00:00.000Z",
      "children": []
    }
  ]
}]

Status codes

200

OK

Request succeeded.

401

Unauthorized

Missing or invalid bearer token.

403

Forbidden

Insufficient permissions for this action.

400

Bad Request

Validation failed or invalid parameters.

404

Not Found

Resource not found.

429

Too Many Requests

Global rate limit exceeded (10,000 requests per 10 minutes per IP).

500

Internal Server Error

Unexpected server error.

403

Forbidden

No vendor membership, or insufficient vendor role (requires OWNER, ADMIN, or EDITOR for write operations).

Categories are read-only for vendors. There is no vendor API to create, update, or delete categories.
Categories are loaded from the backend and scoped to your vendor. Vendors must be linked to the G-Commerce storefront when it restricts suppliers.
Nested `children` arrays represent subcategories. Use any category UUID in the tree when assigning `categoryIds` on products.
`image` is an absolute public asset URL when set (`{API_ORIGIN}/assets/categories/…`). See [Media URLs](/docs/v1/vendor#media-urls-images--documents).

Try it

Uses your saved session from login. Edit values and send a live request, or copy the cURL command.