Update/create a category

PATCH

/api/rest/v1/categories/{code}

Category

This endpoint allows you to update a given category. Know more about Update behavior. Note that if no category exists for the given code, it creates it.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/categories/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "winter_collection",
    "labels": {
        "en_US": "Winter collection",
        "fr_FR": "Collection hiver"
    },
    "parent": null,
    "position": 1,
    "updated": "2023-08-15T05:53:50.708Z",
    "values": {
        "description|96b88bf4-c2b7-4b64-a1f9-5d4876c02c26|ecommerce|en_US": {
            "attribute_code": "description|96b88bf4-c2b7-4b64-a1f9-5d4876c02c26",
            "channel": "ecommerce",
            "data": "<p>Winter collection description</p>\n",
            "locale": "en_US",
            "type": "textarea"
        }
    }
}'

Response Example

201 - Example 1

{}

Request

Path Params

code

string

required

Code of the resource

Body Params application/json

code

string

required

Category code

labels

object

optional

Category labels for each locale

Default:

{}

localeCode

string

optional

Category label for the locale localeCode

parent

string

optional

Category code of the parent's category

Default:

null

position

integer

optional

Position of the category in its level, start from 1 (only available since the 7.0 version and when query parameter "with_position" is set to "true")

updated

string <dateTime>

optional

Date of the last update

values

object

optional

Attribute values

Default:

null

attributeCode|attributeUuid|channelCode|localeCode

array [object {5}]

optional

Examples

Responses

🟢201Created

application/json

Body

object {0}

🟢204No content to return

🟠400Bad request

🟠401Authentication required

🟠403Access forbidden

🟠415Unsupported Media type

🟠422Unprocessable entity

Modified at 2023-08-15 05:53:55

Get a category

Download a category media file [COMING SOON]