v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Get All Product Category

Use this API to get all product category

get/v1/product-category

Query parameters

perPageinteger

Example:20

pageinteger

Example:1

activeboolean

Example:true

Filter by active status

parent_idstring

Example:9a12fab0-d282-4437-9460-c3d26662d11a

The parent category id, to list all subcategories of a parent category

keywordsstring

Example:Beanie

Filter by keywords, name

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

Successful response

Example response

{
  "data": [
    {
      "id": "9d8cbab5-13fe-4102-8bf5-3b13668ab811",
      "name": "mens hat example",
      "description": "mens hat example",
      "is_active": true,
      "order": 1,
      "children": [],
      "is_parent": true,
      "emoji": "?",
      "pos_color": "#4C689C"
    }
  ],
  "links": {
    "first": "https://api.sandbox.hit-pay.com/v1/product-category?page=1",
    "last": "https://api.sandbox.hit-pay.com/v1/product-category?page=4",
    "next": "https://api.sandbox.hit-pay.com/v1/product-category?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "path": "https://api.sandbox.hit-pay.com/v1/product-category",
    "per_page": 20,
    "to": 20,
    "total": 66
  }
}