Categories

Get Categories

Retrieves the categories.

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonOptional

pageinteger

perPageinteger

Must be at least 1. Must not be greater than 100.

orderColumnstring

Value in: "id" | "parent_id" | "name" | "created_at" | "updated_at"

orderDirectionstring

Value in: "asc" | "desc"

namestring

Must not be greater than 255 characters.

parent_idstring

Path Parameters

shopIdRequiredinteger

The shop ID.

curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/categories" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 12,
    "perPage": 1,
    "orderColumn": "updated_at",
    "orderDirection": "asc",
    "name": "zwszwtxpeqqikym",
    "parent_id": null
  }'

{
  "current_page": 1,
  "data": [
    {
      "id": 5,
      "shop_id": 38,
      "parent_id": null,
      "name": "General",
      "path": "general",
      "description": "General products",
      "image_id": null,
      "meta_title": "General",
      "meta_description": "Find something for yourself.",
      "color": null,
      "order": 0,
      "created_at": "2026-01-25T17:02:56.000000Z",
      "updated_at": "2026-01-25T17:02:56.000000Z",
      "deleted_at": null
    }
  ],
  "first_page_url": "https://api.sellauth.com/v1/shops/38/categories?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.sellauth.com/v1/shops/38/categories?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "https://api.sellauth.com/v1/shops/38/categories?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "https://api.sellauth.com/v1/shops/38/categories",
  "per_page": 20,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Create Category

Creates a new category.

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired

nameRequiredstring

Must not be greater than 255 characters.

parent_idstring

pathstring

Must match the regex /^[a-z0-9-]+$/.

descriptionstring

Must not be greater than 1000 characters.

image_idstring

meta_titlestring

Must not be greater than 255 characters.

meta_descriptionstring

Must not be greater than 255 characters.

colorstring

Must not be greater than 7 characters.

orderinteger

Path Parameters

shopIdRequiredinteger

The shop ID.

curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/categories" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "pasyzwszwtxpeqq",
    "parent_id": null,
    "path": "8",
    "description": "Accusamus nihil repellat vero omnis voluptates id amet et.",
    "image_id": null,
    "meta_title": "qikymwkiinfowtz",
    "meta_description": "mixkolowyuffszf",
    "color": "rcsnw",
    "order": 12
  }'

Get Category

Retrieves a specific category.

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger

The shop ID.

categoryIdRequiredinteger

The category ID.

curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/categories/{categoryId}" \
  -H "Authorization: Bearer <token>"

{
  "id": 5,
  "shop_id": 38,
  "parent_id": null,
  "name": "General",
  "path": "general",
  "description": "General products",
  "image_id": null,
  "meta_title": "General",
  "meta_description": "Find something for yourself.",
  "color": null,
  "order": 0,
  "created_at": "2026-01-25T17:02:56.000000Z",
  "updated_at": "2026-01-25T17:02:56.000000Z",
  "deleted_at": null
}

Delete Category

Deletes a specific category.

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger

The shop ID.

categoryIdRequiredinteger

The category ID.

curl -X DELETE "https://api.sellauth.com/v1/shops/{shopId}/categories/{categoryId}" \
  -H "Authorization: Bearer <token>"

Update Category

Updates a specific category.

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired

idRequiredinteger

nameRequiredstring

Must not be greater than 255 characters.

parent_idstring

pathstring

Must match the regex /^[a-z0-9-]+$/.

descriptionstring

Must not be greater than 1000 characters.

image_idstring

meta_titlestring

Must not be greater than 255 characters.

meta_descriptionstring

Must not be greater than 255 characters.

colorstring

Must not be greater than 7 characters.

orderinteger

Path Parameters

shopIdRequiredinteger

The shop ID.

categoryIdRequiredinteger

The category ID.

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/categories/{categoryId}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 12,
    "name": "asyzwszwtxpeqqi",
    "parent_id": null,
    "path": "8",
    "description": "Accusamus nihil repellat vero omnis voluptates id amet et.",
    "image_id": null,
    "meta_title": "qikymwkiinfowtz",
    "meta_description": "mixkolowyuffszf",
    "color": "rcsnw",
    "order": 12
  }'

Reorder Categories

Reorders categories and updates their parent relationships.

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired

categoriesRequiredarray<integer>

Must have at least 1 items.

Path Parameters

shopIdRequiredinteger

The shop ID.

curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/categories/reorder" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": "pasyzwszwtxpeqqikymwkiinfowtzmixkolowyuffszfrcsnwwxvx"
  }'

Categories

Response

TypeScript

Response

TypeScript