Create Category

Production

POST

https://api.salla.dev/admin/v2/categories

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params application/json

name

string

required

The title or label assigned to a specific grouping or classification of items, products, or content, often used to organize and categorize them for easier navigation or identification. 🌐 Support multi-language

status

enum<string>

optional

The status of the category, whether or not it is active or hidden

Allowed values:

activehidden

image

string

optional

Category display image

metadata_title

string

optional

Category SEO Metadata Title which is a concise label used to optimize search engine results and enhance the visibility of a category page.

metadata_description

string

optional

A succinct summary crafted to enhance search engine optimization and spotlight a brand's attributes within a category.

metadata_url

string

optional

Metadata URL is a web address that contains information designed to improve a webpage's search engine visibility and shareability on social platforms.

shows_in

object

optional

Category channels that will be displayed to them

app

string

required

Salla Merchant App

translations

object

optional

Category translations are based on the store's enabled language locale. For instance, if the store supports both Arabic and English, the translations object will return two entries: ar for Arabic and en for English.

object

optional

parent_id

number

optional

A unique identifier that references the parent or higher-level category to which a specific category belongs, establishing a hierarchical relationship within a categorization system.

sort_order

number

optional

Sort order dictates the sequence or arrangement of categories when displayed to users. It determines the order in which categories are presented, often using numerical values to assign priority, allowing for controlled and organized navigation.

products

array [object {2}]

optional

Assign products and specify the sort order.

number

optional

Product ID. Get a list of Product IDs from here

Example:

939485452

sort

number

optional

an Integer number signifying the sort order of the product inside the category

Examples:

1510

Example

{
  "name": "طعام قطط",
  "status": "hidden",
  "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/dBmLWHOfKm3tRfQ3Txqs3l96SjI6jdbf6rCsYYQu.jpg",
  "metadata_title": "Dress",
  "metadata_description": "Amazing Dress",
  "metadata_url": "https://dress.com",
  "show_in": {
    "app": true
  },
  "translations": {
    "en": {
      "name": "cat food",
      "metadata_title": "cat food",
      "metadata_description": "welcome",
      "metadata_url": "cat-food"
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.salla.dev/admin/v2/categories' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "طعام قطط",
    "status": "hidden",
    "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/dBmLWHOfKm3tRfQ3Txqs3l96SjI6jdbf6rCsYYQu.jpg",
    "metadata_title": "Dress",
    "metadata_description": "Amazing Dress",
    "metadata_url": "https://dress.com",
    "show_in": {
        "app": true
    },
    "translations": {
        "en": {
            "name": "cat food",
            "metadata_title": "cat food",
            "metadata_description": "welcome",
            "metadata_url": "cat-food"
        }
    }
}'

Responses

🟢201Created

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (Category)

optional

number

required

Category ID, is a unique identifier assigned to a specific product category, facilitating organized classification and efficient management of products within a similar group. List of categories can be found here.

name

string

required

Category name is a descriptive label assigned to a product category, aiding in clear identification and organization of related products. 🌐 Support multi-language

image

string

required

The category image

urls

object (Urls)

required

To help companies and merchants, Salla provides a “urls” attribute that has been added to different modules to guide the merchants to have the full URL of this module from both scopes, the dashboard scope as a store admin, and as a customer.

parent_id

integer

required

Category Parent ID refers to the unique identifier assigned to the parent category of a subcategory, establishing a hierarchical relationship between different levels of product classification.

sort_order

integer | null

required

The sequence or arrangement of categories when displayed to users.

status

enum<string>

required

The category status indicates whether the category is currently visible and accessible to users active or intentionally concealed from view hidden. It essentially controls whether the category is publicly displayed or kept private within the system.

Allowed values:

activehidden

show_in

object

required

has_hidden_products

boolean

required

Whether or not the category has hidden products.

update_at

string

required

The date where the category is updated in.

metadata

object

required

sub_categories

array[string]

required

The subcategories list of the main category.

translations

object

required

You will get this object in the response if you use with=translations query parameter.

items

array[object (Category) {14}]

required

You will get this array in the response if you use with=items query parameter.

Example

{
  "status": 201,
  "success": true,
  "data": {
    "id": 707972603,
    "name": "Dress 101",
    "urls": {
      "customer": "https://shtara.com/profile",
      "admin": "https://shtara.com/profiles"
    },
    "sort_order": 0,
    "items": [],
    "parent_id": 516861512,
    "status": "hidden",
    "metadata": {
      "title": "Dress",
      "description": "Amazing Dress",
      "url": "https://dress.com"
    }
  }
}

🟠422Error Validation

🟠401Unauthorized

Modified at 2025-01-20 07:25:03

Delete Digital File

List Categories