Upsert Category

Production

https://api.b2b.retter.io/5p1hp1d2t

POST

/CALL/PIMAPI/upsertCategory/{PROJECT_ID}

PIM

Last modified:2025-05-28 11:03:12

The upsertCategory method is used to update, delete, and add visuals to a category tree. If the specified category code already exists, the method updates the category; otherwise, it adds a new category.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

PROJECT_ID

string

required

Body Params application/json

path

string

required

category

object

required

code

string

required

image

string

required

subCategories

array [object {3}]

required

Example

{
    "path": "masterCatalog",
    "category": {
        "code": "masterCatalog",
        "image": "https://picsum.photos/200/300",
        "subCategories": [
            {
                "code": "clothing",
                "image": "https://picsum.photos/200/300",
                "label": [
                    {
                        "locale": "en_US",
                        "value": "Clothing"
                    },
                    {
                        "locale": "tr_TR",
                        "value": "Giyim"
                    }
                ]
            }
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/PIMAPI/upsertCategory/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "path": "masterCatalog",
    "category": {
        "code": "masterCatalog",
        "image": "https://picsum.photos/200/300",
        "subCategories": [
            {
                "code": "clothing",
                "image": "https://picsum.photos/200/300",
                "label": [
                    {
                        "locale": "en_US",
                        "value": "Clothing"
                    },
                    {
                        "locale": "tr_TR",
                        "value": "Giyim"
                    }
                ]
            }
        ]
    }
}'

Responses

🟢200OK

application/json

Body