docs
  1. Storefront Api
  2. Resources
  3. Categories
  4. Get A Category

Get a Category

Get a category

Path Parameters

ParameterDetails
category
  • required
  • MinLength: 1
integer
Examples:
  • {
      "type": "integer"
    }
  • {
      "type": "string"
    }

Query Parameters

ParameterDetails
shopId
integer
Example:
10001
showHidden
boolean
depth
integer
Example:
3
with
Array of strings
Default:
[]
Example:
parents,children
string

Header Parameters

ParameterDetails
X-Shop-Id
integer
Example:
10001

Responses

200
Request successful
application/json
Success
idrequired
integer
pathrequired
string
namerequired
string
slugrequired
string
parentIdrequired
integer
rootlineIdsrequired
Array of integer
childrenIdsrequired
Array of integer
required
Array of object
isHiddenrequired
boolean
depthrequired
integer
supportedFilterrequired
Array of string
shopLevelCustomDatarequired
object
countryLevelCustomDatarequired
object
object
Array of object
400
Required query parameter missing / invalid
application/json
Error
401
Authentication information is missing or invalid
application/json
Error
404
The specified resource was not found
application/json
Error
429
Triggered when a client exceeds the API request limit.
application/json
Error
GET/v1/categories/{category}

Request samples

Response samples

200
Content type: application/json
Provide Feedback