Skip to main content

Get Categories page

GET 
/catalog/categories

Returns a paginated list of catalog categories for the company resolved from gateway context. When status is omitted, only active categories are returned.

Optional has_parent restricts results to root categories (false) or to categories that have a parent (true). When parent_id is also supplied, has_parent is ignored.

Request​

Query Parameters

    cursor string

    Possible values: <= 128 characters

    Pagination cursor (opaque token). Invalid or expired cursors yield 400 with code invalid_cursor.

    status string

    Possible values: [active, inactive, all]

    Default value: active

    Filter categories by lifecycle status

    text_filter string

    Possible values: >= 2 characters and <= 128 characters

    Case-insensitive text match (per service defaults) against fields exposed by the target list operation. For categories: category name and description. For regular goods: good-level and variation-level name and description, and values in each variation's codes (codes[].value, e.g. SKU or barcode).

    parent_id uuid

    Filter by parent category identifier

    has_parent boolean

    Filter by whether the category has a parent category.

    • true — only categories with a non-null parent_id
    • false — only root categories (parent_id is null)
    • omitted — no filter by parent presence (subject to other parameters)

    When query parameter parent_id is present, has_parent is ignored.

    order_by string

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, name_asc, name_desc]

    Default value: created_at_asc

Responses​

OK

Schema

    cursor stringnullable

    Token of the next page of the list. null when there is no next page.

    items

    object[]

    required

  • Array [

    • name stringrequired

    Possible values: >= 2 characters and <= 128 characters

    Display name

    status CategoryStatusesDTO (string)required

    Possible values: [active, inactive, unknown]

    Default value: active

    List of catalog category statuses

    description stringnullable

    Possible values: >= 2 characters and <= 1024 characters

    Additional information

    external_data

    object

    nullable

    External system reference data; null when no external link exists.

    id stringrequired

    Possible values: >= 4 characters and <= 128 characters

    Unique identifier in the external system

    property name* anynullable

    External system reference data; null when no external link exists.

    image_url stringnullable

    Possible values: <= 2048 characters

    Link to main image

    parent_id uuidnullable

    Parent category identifier (nesting depth as in catalog domain)

    created_at date-timerequired

    Creation date and time. Format: ISO 8601

    updated_at date-timerequired

    Update date and time. Format: ISO 8601

    archived_at date-timenullable

    Archiving date and time. Format: ISO 8601

    id uuidrequired

    Possible values: >= 36 characters and <= 36 characters

    Global unique identifier. Format: UUID (id) v4 ISO/IEC 11578:1996

  • ]

Loading...