v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

Update category

Updates an existing category in the store. Requires the stores.categories.update permission.

put/stores/{storeId}/categories/{categoryId}

Path parameters

storeIdstring uuid required

The ID of the store that the category belongs to

categoryIdstring uuid required

The ID of the category to update

Request body

namestring required

The name of the category

slugstring nullable

The slug of the category, if null then the ID is used

visibility0 | 1 | 2 | 3 required

List of product visibility (or privacy) levels

productIdsstring[] required

The list of product IDs in this category. This replaces the existing product list.

Response

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

{"stackTrail":"components:schemas:ObjectResponse:properties:data","oasType":"schema","type":"unknown","description":"Represents the data associated with a response.","nullable":true}