RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

category

A product category (and optional subcategory tree).

Shop taxonomy. Products reference categoryId / subcategoryId. Parent/child via parentId.

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The category object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

9 fields on category. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Category id.

Type
id: string

name

string

Display name.

Type
name: string

code

string

Shop-scoped code (unique with parentId).

Type
code: string

description

string | null

Optional description.

Type
description: string | null

parentId

string | null

Parent category id when this row is a subcategory.

Type
parentId: string | null

position

number

Sort order within siblings.

Type
position: number

isActive

boolean

Whether the category is active.

Type
isActive: boolean

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related