Categories

List all categories of products.

get

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/core/categories

HTTPcURLJavaScriptPython

GET /v1/core/categories HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "image": "text",
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "sort": 1,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "id": "text"
      }
    ],
    "next": "text"
  }
}

Creates a new category

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

post

/v1/core/categories

HTTPcURLJavaScriptPython

POST /v1/core/categories HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "params": {
    "image": "text",
    "locales": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "sort": 1
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "image": "text",
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "sort": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text"
    }
  }
}

Returns a specific category

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

/v1/core/categories/{uid}

HTTPcURLJavaScriptPython

GET /v1/core/categories/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "image": "text",
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "sort": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text"
    }
  }
}

Deletes a specific category

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

delete

/v1/core/categories/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/core/categories/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a specific categoy

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/core/categories/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/core/categories/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "params": {
    "id": "text",
    "image": "text",
    "locales": {},
    "sort": 1
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "item": {
      "image": "text",
      "locales": {
        "ar": {
          "name": "text",
          "description": "text"
        },
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "sort": 1,
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "uid": "text",
      "id": "text"
    }
  }
}

Exports all categories with support for incremental fetching.

get

Authorizations

api-key

api-keystringRequired

API Key

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

get

/v1/core/categories/export

HTTPcURLJavaScriptPython

GET /v1/core/categories/export HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "items": [
      {
        "image": "text",
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "sort": 1,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "uid": "text",
        "id": "text"
      }
    ],
    "next": "text"
  }
}