v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Product Categories

Retrieves the details of all product categories.

get/product/categories

Query parameters

include_idboolean

Retrieves category ids of each category fetched.

valuesboolean

Retrieves all child categories if values=true.

value_limitinteger

Limits number of child categories to be retrieved.

namestring

Retrieves the details of a specific product category based on the category name passed (not case sensitive).

idinteger

Retrieves the details of a specific product category based on the product id.

parent_idinteger

Retrieves the details of a specific product category and its child categories based on the parent product id passed.

parent_namestring

Fetch categories by name of the parent product.

limitinteger

Limits the number of product categories to be retrieved.

offsetinteger

Entries to be ignored from the top.

ou_codestring

Identifier code of the organisation.

fetch_type'ALL' | 'ORG' | 'SCOPE'

ALL - Fetches details of product associated with both master org and org unit. ORG-Fetches details of products associated with master ORG. SCOPE-Fetches details of products associated with an org unit.

Response

200

Example response

{
  "response": {
    "status": {
      "success": true,
      "code": 200,
      "message": "SUCCESS"
    },
    "product": {
      "count": 20,
      "categories": {
        "category": [
          {
            "name": "AAA",
            "label": "a1",
            "description": "aa13",
            "item_status": {
              "success": true,
              "code": 9172,
              "message": "Category retrieval successful"
            }
          }
        ]
      }
    }
  }
}