Brands & Categories Endpoint

TIP

Refer to note page for Base URL

* List Brands

Endpoint: GET

products/brands/

Parameters
Not required

Sample Response

[
  {
      "id": "81c260ff-fb32-4dc5-b6a3-80267ebbd8cc",
      "name": "Adidas",
      "icon": null
  },
  {
      "id": "14126ace-892c-4d52-8888-ffc4fec58048",
      "name": "Aldo",
      "icon": null
  }
]

* List Main Categories

Endpoint: GET

products/main-categories/

Parameters
Not required

Sample Response

[
    {
        "id": "2be6607f-0f8f-4830-8327-22e1755c92dd",
        "name": "Boys",
        "icon": null
    },
    {
        "id": "fbad61aa-1917-4060-ae1f-d3eff7b62b69",
        "name": "Girls",
        "icon": null
    },
    {
        "id": "8b22665d-0dd1-4448-8e2b-2776234e0eb5",
        "name": "Men",
        "icon": null
    },
    {
        "id": "f202128d-55ba-488a-9e46-64a18bbc9194",
        "name": "Women",
        "icon": null
    }
]

* List Sub Categories

Endpoint: GET

products/sub-categories/

Parameters
Not required

Sample Response

[
  {
      "id": "40669bb7-059f-42fc-a479-2fa9714b0c70",
      "name": "Boy's Accessories",
      "icon": null,
      "mainCategory": {
          "id": "2be6607f-0f8f-4830-8327-22e1755c92dd",
          "name": "Boys",
          "icon": null
      }
  },
]

* Filter Sub Categories

Endpoint: GET

products/sub-categories/filter/?param=value

Query Parameters

Name	Type	Description	Required
param	string	mainCategory__name	✔️
value	string	eg. Boys	✔️

Sample Request

products/sub-categories/filter/?mainCategory__name=Boys

Sample Response

[
  {
    "id": "40669bb7-059f-42fc-a479-2fa9714b0c70",
    "name": "Boy's Accessories",
    "icon": null,
    "mainCategory": "2be6607f-0f8f-4830-8327-22e1755c92dd"
  },
  {
    "id": "e7ca615b-7acd-4167-92f8-c1919f9ceac0",
    "name": "Boy's Bags",
    "icon": null,
    "mainCategory": "2be6607f-0f8f-4830-8327-22e1755c92dd"
  },
]

* List Product Categories

Endpoint: GET

products/product-categories/

Parameters
Not required

Sample Response

[
  {
      "id": "2891f81e-5034-4df6-85ab-c769f3932092",
      "name": "Active Tracksuits",
      "icon": null,
      "subCategory": {
          "id": "8f8d31d9-b4c8-4cdc-ab8b-72bd8e73443d",
          "name": "Women's Clothing",
          "icon": null,
          "mainCategory": {
              "id": "f202128d-55ba-488a-9e46-64a18bbc9194",
              "name": "Women",
              "icon": null
          }
      }
  },
]

* Filter Product Categories

Endpoint: GET

products/product-categories/filter/?param=value

Query Parameters

Name	Type	Description	Required
param	string	subCategory__name	✔️
value	string	eg. Boy's Accessories	✔️

Sample Request

products/product-categories/filter/?subCategory__name=Boy's Accessories

Sample Response

[
  {
    "id": "15a46f53-5fc1-41d8-8e19-7834e78023df",
    "name": "Belts",
    "icon": null,
    "subCategory": "40669bb7-059f-42fc-a479-2fa9714b0c70"
  },
  {
    "id": "94d6c439-fe72-4b9f-9b48-67ddf504a5ae",
    "name": "Gloves and Mittens",
    "icon": null,
    "subCategory": "40669bb7-059f-42fc-a479-2fa9714b0c70"
  },
]