Skip to main content
PATCH
/
categories
/
{categoryId}
Update a category.
curl --request PATCH \
  --url https://api.aasaan.shop/api/v1/stores/categories/{categoryId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Shampoo",
  "slug": "shampoo",
  "description": "Hair categories",
  "hide": false,
  "displayOrder": 0,
  "parentCategoryId": "6124bc492f3660f743776404",
  "image": {
    "id": 0,
    "url": "https://images.aasaan.app/123412421",
    "type": "image/png"
  }
}
'
{
  "id": "623d3455ec3c4b3548eb4a322",
  "name": "Shampoo",
  "slug": "shampoo",
  "description": "Hair categories",
  "hide": false,
  "displayOrder": 0,
  "parentCategoryId": "6124bc492f3660f743776404",
  "image": {
    "id": 0,
    "url": "https://images.aasaan.app/123412421",
    "type": "image/png"
  },
  "date_created": "2022-03-25T03:17:44.092Z",
  "date_modified": "2022-06-10T07:51:12.510Z"
}

Documentation Index

Fetch the complete documentation index at: https://help.aasaan.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
categoryId
string
required

Category Id

Body

application/json
​
name
string
required

Name

Example:

"Shampoo"

​
slug
string

Slug

Example:

"shampoo"

​
description
string

Shampoos and conditioners

Example:

"Hair categories"

​
hide
boolean

Hide a category

Example:

false

​
displayOrder
string

Display order

Example:

0

​
parentCategoryId
string

Parent category id

Example:

"6124bc492f3660f743776404"

​
image
object

Category image

Response

Category updated.

​
id
string

Unique identifier for the resource that was used to create this category

Example:

"623d3455ec3c4b3548eb4a322"

​
name
string

Name

Example:

"Shampoo"

​
slug
string

Slug

Example:

"shampoo"

​
description
string

Shampoos and conditioners

Example:

"Hair categories"

​
hide
boolean

Hide a category

Example:

false

​
displayOrder
string

Display order

Example:

0

​
parentCategoryId
string

Parent category id

Example:

"6124bc492f3660f743776404"

​
image
object

Category image

​
date_created
string

Created date

Example:

"2022-03-25T03:17:44.092Z"

​
date_modified
string

Modified date

Example:

"2022-06-10T07:51:12.510Z"