Search categories in a store catalog by their path. The response provides basic details of found categories.
The method returns a list of categories with the specified path, sorted in ascending order of the category's internal ID. The search is case insensitive.
Headers
Name
Type
Description
Authorization
string
oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.
All query params
Query field
Type
Description
path
string
A category path where elements are separated by a delimiter. Spaces around the delimiter and empty path elements are ignored
delimiter
string
A string of 1 or more characters used as path element separator
offset
number
Offset from the beginning of the returned items list (for paging)
limit
number
Maximum number of returned items. Maximum allowed value: 100. Default value: 100
slugsWithoutIds
boolean
Set trueto receive custom page slug
Response
A JSON object of type 'CategorySearchResult' with the following fields:
SearchResult
Field
Type
Description
total
number
The total number of found items (might be more than the number of returned items)
count
number
The total number of the items returned in this batch
offset
number
Offset from the beginning of the returned items list (for paging)
limit
number
Maximum number of returned items. Maximum allowed value: 100. Default value: 100
items
Array
The categories list
Category
Field
Type
Description
id
number
Internal unique category ID
parentId
number
ID of the parent category, if any
orderBy
number
Sort order of the category in the parent category subcategories list
hdThumbnailUrl
string
Category HD thumbnail URL resized to fit 800x800px
thumbnailUrl
string
Category thumbnail URL. The thumbnail size is specified in the store settings. Resized to fit 400x400px by default
imageUrl
string
Category image URL. A resized original image to fit 1500x1500px
originalImageUrl
string
Link to the original (not resized) category image
originalImage
<ImageDetails>
Details of the category image
name
string
Category name
thumbnail
<ImageDetails>
Thumbnail image data. The thumbnail size is specified in the store settings. Resized to fit 400x400px by default
nameTranslated
<Translations>
Available translations for category name
origin
string
Read-only field returns if a category originated outside of Ecwid, e.g. "origin": "LIGHTSPEED"
url
string
URL of the category page in the store
productCount
number
Number of products in the category and its subcategories. Important: if new products are assigned or unassigned for this category, the changes to productCount value will apply after several minutes.
enabledProductCount
number
Number of enabled products in the category (excluding its subcategories)
description
string
The category description in HTML
descriptionTranslated
<Translations>
Available translations for category description
enabled
boolean
true if the category is enabled, false otherwise. Use hidden_categories in request to get disabled categories
productIds
Array<number>
IDs of products assigned to the category as they appear in Ecwid Control Panel > Catalog > Categories. To make this field appear in a response, send productIds=true in a request.
ImageDetails
Field
Type
Description
url
string
Image URL
width
integer
Image width
height
integer
Image height
Translations
Field
Type
Description
<ISO_LANG_CODE>
string
Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings
Errors
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP codes
HTTP Status
Meaning
Code (optional)
400
Request parameters are malformed
415
Unsupported content-type: expected application/json or text/json
500
Cannot retrieve the categories info because of an error on the server
