List Product Categories

List Categories

get

Authorizations

Query parameters

queryany ofOptional

Search term to filter items by path name

stringOptional

or

nullOptional

parent_categoryany ofOptional

Filter items by parent category ID

integer · min: 1Optional

ID (integer) of this property

Example: 1

or

nullOptional

pageinteger · min: 1Optional

Page number to retrieve items from.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of items per page.

Default: 20

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/categories/ HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "name": "Caps",
      "path": "Fashion|Women|Caps",
      "parent_id": 123,
      "parent": 1
    }
  ],
  "pagination": {
    "per_page": 1,
    "page": 1,
    "pages": 1,
    "total": 1,
    "next": "text",
    "prev": "text"
  }
}