Webhooks
Models
Catalog
Catalog
Products
Product Metafields
Product Bulk Pricing Rules
Product Custom Fields
Product Images
Product Variant Options
Product Variant Option Values
Product Variants
Product Variants Metafields
Product Modifiers
Product Modifier Values
Product Modifier Images
Product Complex Rules
Product Reviews
Product Videos
Brands
Brand Metafields
Brand Images
Category Metafields
Category Images
Variants
Models
get

/catalog/categories

Returns a list of Cateogories. Optional filter parameters can be passed in.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

10 Query Parameters
2 Headers

Responses

1 Example
Schema
object
id
integer

The unique numeric ID of the category; increments sequentially.

parent_id
integer

The unique numeric ID of the category’s parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in /POST if creating a child category.

2 validations
name
string

The name displayed for the category. Name is unique with respect to the category’s siblings. Required in /POST.

4 validations
description
string

The product description, which can include HTML formatting.

1 validation
views
integer

Number of views the category has on the storefront.

1 validation
sort_order
integer

Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.

3 validations
page_title
string

Custom title for the category page. If not defined, the category name will be used as the meta title.

3 validations
search_keywords
string

A comma-separated list of keywords that can be used to locate the category when searching the store.

2 validations
meta_keywords
array[string]

Custom meta keywords for the category page. If not defined, the store’s default keywords will be used. Must post as an array like: [“awesome”,“sauce”].

meta_description
string

Custom meta description for the category page. If not defined, the store’s default meta description will be used.

2 validations
layout_file
string

A valid layout file. (Please refer to this article on creating category files.) This field is writable only for stores with a Blueprint theme applied.

3 validations
is_visible
boolean

Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.

default_product_sort
string

Determines how the products are sorted on category page load.

1 validation
image_url
string

Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.

2 validations
custom_url
object

The custom URL for the category on the storefront.

meta
object

Data about the response, including pagination and collection totals.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
store_hash
$$.env
2 variables not set
X-Auth-Client
X-Auth-Token