GET:categories.json
Commerce APIGET:categories.json

GET:categories.json

Description

Get top level or specific categories.

Permission bit: "categories.read"

Topic: Categories

Query Parameters

children_of: String

Unique category identifier. See also: Unique Identifiers

Example: ?children_of=ca_EQzGqWoY


featured: Boolean

If set, show only featured categories

Example: ?featured=true


ids: Comma-separated array of String, required

List of category ids. See also: Unique Identifiers

Example: ?ids=ca_EQzGqWoY,ca_EQzGqWoY


loose: Boolean

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

Example: ?loose=true


published: Boolean

If set, show only published categories

Example: ?published=true


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Response Body

Array of Category

Response Body Type

Loading module