Mircate
  1. PIM
Mircate
  • Introduction
  • Authentication
  • Errors
  • Change Logs
  • Promotion
    • Calculate
      POST
    • Start Transaction
      POST
    • Commit Transaction
      POST
    • Revert Transaction
      POST
    • Cancel Transaction
      POST
    • Get Active Promotions
      GET
  • Loyalty
    • Receive Event
      POST
    • Calculate
      POST
    • Start Transaction
      POST
    • Commit Transaction
      POST
    • Cancel Transaction
      POST
    • List Measurements
      POST
  • Wallet
    • Get Wallet
    • Create Account
    • Get Account
    • Get Accounts
    • List Accounts
    • List Transactions
    • Add Account
    • Remove Account
    • Fix
    • Load
    • Spend
    • Refund
    • Cancel
  • PIM
    • Get Products
      POST
    • Get Product Settings
      GET
    • Get Catalog Settings
      GET
    • Upsert Product
      POST
    • Upsert Category
      POST
    • Bulk Product Upsert
      POST
    • Check Batch Status
      POST
    • Delete Product
      POST
    • Attach Product Attribute Image
      POST
    • Attach Category Image
      POST
    • Get Image
      GET
    • Upsert Attributes
      POST
    • Delete Attribute
      POST
    • Upsert Attribute Options
      POST
    • Upsert Attribute Option
      POST
    • Delete Attribute Option
      POST
  • Merchant
    • Sales Channel
      • Reserve Stock
      • Cancel Stock
      • Commit Stock
      • Refund Stock
      • Get Current Stock
    • Product Supplier
      • Receive Stock
      • Receive Price
      • Get Stock/Price History
      • Check Batch Status
      • Remove My Products
      • Clean My Products
      • Export Stock/Price
      • List Exports
      • Get Exported Files
    • Global Products
      • Receive Products
      • Get Global Products
      • Remove Global Products
  • How to
    • Creating a Promotion Template
    • Promotion Transaction Flow
    • Understanding PIM Product Statuses
  1. PIM

Upsert Category

Production
Production
POST
https://api.b2b.retter.io/5p1hp1d2t/CALL/PIMAPI/upsertCategory/{PROJECT_ID}
PIM
Last modified:2025-04-08 11:33:06
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
category
object 
required
code
string 
required
image
string 
required
label
array [object {2}] 
required
description
array [object {2}] 
required
subCategories
array [object {4}] 
required
Example
{
  "category": {
    "code": "masterCatalog",
    "image": "https://picsum.photos/200/300",
    "label": [
      {
        "value": "Main Menü",
        "locale": "en_US"
      },
      {
        "value": "Ana Menü",
        "locale": "tr_TR"
      }
    ],
    "description": [
      {
        "locale": "en_US",
        "value": "All Cloths"
      },
      {
        "locale": "tr_TR",
        "value": "Tüm Menü"
      }
    ],
    "subCategories": [
      {
        "code": "clothing",
        "label": [
          {
            "locale": "en_US",
            "value": "Clothing"
          },
          {
            "locale": "tr_TR",
            "value": "Giyim"
          }
        ],
        "subCategories": [
          {
            "code": "001",
            "image": "https://picsum.photos/200/300",
            "label": [
              {
                "locale": "en_US",
                "value": "Sweaters"
              },
              {
                "value": "Sweatshirt",
                "locale": "tr_TR"
              }
            ]
          },
          {
            "code": "0011",
            "image": "https://picsum.photos/200/300",
            "label": [
              {
                "value": "Long Sleeve Sweats",
                "locale": "en_US"
              },
              {
                "value": "Uzun Kollu Sweatshirts",
                "locale": "tr_TR"
              }
            ]
          },
          {
            "code": "002",
            "image": "https://picsum.photos/200/300",
            "label": [
              {
                "locale": "en_US",
                "value": "Pants"
              },
              {
                "value": "Pantolon",
                "locale": "tr_TR"
              }
            ],
            "description": [
              {
                "locale": "en_US",
                "value": "Pants"
              },
              {
                "value": "Pantalonlar",
                "locale": "tr_TR"
              }
            ]
          },
          {
            "code": "tshirts",
            "image": "https://picsum.photos/200/300",
            "label": [
              {
                "locale": "en_US",
                "value": "T-shirts"
              }
            ]
          },
          {
            "code": "shoes",
            "label": [
              {
                "locale": "en_US",
                "value": "Shoes"
              },
              {
                "locale": "tr_TR",
                "value": "Ayakkabılar"
              }
            ],
            "subCategories": [
              {
                "code": "sportshoes",
                "label": [
                  {
                    "value": "Sport Shoes",
                    "locale": "en_US"
                  },
                  {
                    "value": "Spor Ayakkabılar",
                    "locale": "tr_TR"
                  }
                ],
                "subCategories": [
                  {
                    "code": "running",
                    "label": [
                      {
                        "locale": "en_US",
                        "value": "Running Shoes"
                      },
                      {
                        "locale": "tr_TR",
                        "value": "Koşu Ayakkabıları"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/PIMAPI/upsertCategory/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "category": {
        "code": "masterCatalog",
        "image": "https://picsum.photos/200/300",
        "label": [
            {
                "value": "Main Menü",
                "locale": "en_US"
            },
            {
                "value": "Ana Menü",
                "locale": "tr_TR"
            }
        ],
        "description": [
            {
                "locale": "en_US",
                "value": "All Cloths"
            },
            {
                "locale": "tr_TR",
                "value": "Tüm Menü"
            }
        ],
        "subCategories": [
            {
                "code": "clothing",
                "label": [
                    {
                        "locale": "en_US",
                        "value": "Clothing"
                    },
                    {
                        "locale": "tr_TR",
                        "value": "Giyim"
                    }
                ],
                "subCategories": [
                    {
                        "code": "001",
                        "image": "https://picsum.photos/200/300",
                        "label": [
                            {
                                "locale": "en_US",
                                "value": "Sweaters"
                            },
                            {
                                "value": "Sweatshirt",
                                "locale": "tr_TR"
                            }
                        ]
                    },
                    {
                        "code": "0011",
                        "image": "https://picsum.photos/200/300",
                        "label": [
                            {
                                "value": "Long Sleeve Sweats",
                                "locale": "en_US"
                            },
                            {
                                "value": "Uzun Kollu Sweatshirts",
                                "locale": "tr_TR"
                            }
                        ]
                    },
                    {
                        "code": "002",
                        "image": "https://picsum.photos/200/300",
                        "label": [
                            {
                                "locale": "en_US",
                                "value": "Pants"
                            },
                            {
                                "value": "Pantolon",
                                "locale": "tr_TR"
                            }
                        ],
                        "description": [
                            {
                                "locale": "en_US",
                                "value": "Pants"
                            },
                            {
                                "value": "Pantalonlar",
                                "locale": "tr_TR"
                            }
                        ]
                    },
                    {
                        "code": "tshirts",
                        "image": "https://picsum.photos/200/300",
                        "label": [
                            {
                                "locale": "en_US",
                                "value": "T-shirts"
                            }
                        ]
                    },
                    {
                        "code": "shoes",
                        "label": [
                            {
                                "locale": "en_US",
                                "value": "Shoes"
                            },
                            {
                                "locale": "tr_TR",
                                "value": "Ayakkabılar"
                            }
                        ],
                        "subCategories": [
                            {
                                "code": "sportshoes",
                                "label": [
                                    {
                                        "value": "Sport Shoes",
                                        "locale": "en_US"
                                    },
                                    {
                                        "value": "Spor Ayakkabılar",
                                        "locale": "tr_TR"
                                    }
                                ],
                                "subCategories": [
                                    {
                                        "code": "running",
                                        "label": [
                                            {
                                                "locale": "en_US",
                                                "value": "Running Shoes"
                                            },
                                            {
                                                "locale": "tr_TR",
                                                "value": "Koşu Ayakkabıları"
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}'

Responses

🟢200OK
application/json
OK
Body
meta
object 
optional
updateToken
string 
optional
Example
{
  "meta": {
    "updateToken": "string"
  }
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-04-08 11:33:06
Previous
Upsert Product
Next
Bulk Product Upsert
Built with