Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Categories API

Create, Retrieve, Update and Delete Categories via the public API endpoint using "where" filtering.

GET Categories List

Retrieves a list of Categories as a JSON response based on your provided query parameters.

/api/v2/admin/categories

Data / Response:

{
    "Where" : {},
    "Order_By" : "Id",
    "Offset" : 0,
    "Limit" : 100,
}
{
  "Items": [
    {
      "Id": "string",
      "Name": "string",
      "FullName": "string",
      "NestingLevel": 0,
      "Weight": 0,
      "Children": [
        "string"
      ]
    }
  ],
  "TotalItemsCount": 0
}

POST Category Create

Creates a new Category based on the provided data.

/api/v2/admin/categories

Data / Response:

{
  "Name": "string",
  "ParentId": "string"
}
{
  "Id": "string",
  "Name": "string",
  "FullName": "string",
  "NestingLevel": 0,
  "Weight": 0,
  "Children": [
    "string"
  ]
}

GET Category Item

Retrieves a single Category based on the ID passed in the endpoint URL.

/api/v2/admin/categories/{id}

Data / Response:

N/A
{
  "Id": "string",
  "Name": "string",
  "FullName": "string",
  "NestingLevel": 0,
  "Weight": 0,
  "Children": [
    "string"
  ]
}

PUT Category Update

Updates a single Category based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/categories/{id}

Data / Response:

{
  "Id": "string",
  "Name": "string",
  "ParentId": "string"
}
{
  "Id": "string",
  "Name": "string",
  "FullName": "string",
  "NestingLevel": 0,
  "Weight": 0,
  "Children": [
    "string"
  ]
}

DELETE Category Delete

Deletes a single Category based on the ID passed in the endpoint URL.

/api/v2/admin/categories/{id}

Data / Response:

N/A
Status 204