Products > Categories > categories
Commerce APIProductsCategoriescategories
categories
GET:categories.json

Description

Get top level or specific categories.

Permission bit: "categories.read"

Topic: Categories

Arguments

children_of: String

Unique category identifier. See also: Unique Identifiers

Example: "ca_EQzGqWoY"


featured: Boolean

If set, show only featured categories


ids: [String!]

List of category ids. See also: Unique Identifiers

Example: ["ca_EQzGqWoY"]


loose: Boolean

When asking for multiple items, allow returning less than was asked (in case some are missing)


published: Boolean

If set, show only published categories


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Result

[Category!]

Preview (typescript)

Loading module