List Item Categories

This endpoint allows you to obtain a list of all item categories available in the inventory. To emphasise specific results, you can add filters based on category name.

Endpoint

GET https://app.xtrakit.com/api/v1/inventory/categories

Headers

Authorization: Bearer API_KEY

Query Parameters

Parameters	Type	Description
category_name string	Optional	Filters items by the category name.
created_at datetime	Optional	Start date for filtering items records (format: YYYY-MM-DD H:m:s)
updated_at date	Optional	End date for filtering items records (format: YYYY-MM-DD)

Sample Requests

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://app.xtrakit.com/api/v1/inventory/categories',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer API_KEY', // Replace 'API_KEY' with your actual API key
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

NodeJS

const axios = require('axios');

const config = {
    method: 'get',
    url: 'https://app.xtrakit.com/api/v1/inventory/categories',
    headers: {
        'Authorization': 'Bearer API_KEY' // Replace 'API_KEY' with your actual API key
    }
};

axios(config).then(function(response) {
    console.log(JSON.stringify(response.data));
}).catch(function(error) {
    console.error(error);
});

Python

import requests

url = "https://app.xtrakit.com/api/v1/inventory/categories"

headers = {
    "Authorization": "Bearer API_KEY" # Replace 'API_KEY' with your actual API key
}

response = requests.get(url, headers=headers)
print(response.json())

Sample Response

Success

{
    "status": 200,
    "message": "Item categories found",
    "data": {
        "item-categories": [
            {
                "id": 14,
                "category_name": "Protein",
                "created_at": "2023-11-27 07:49:27",
                "updated_at": "2023-11-27 07:49:27"
            },
            {
                "id": 15,
                "category_name": "Creatine",
                "created_at": "2023-11-27 07:49:47",
                "updated_at": "2023-11-27 07:49:47"
            },
            {
                "id": 26,
                "category_name": "Supplement",
                "created_at": "2025-01-07 21:53:50",
                "updated_at": "2025-01-07 21:53:50"
            },
            {
                "id": 27,
                "category_name": "Supplement 2",
                "created_at": "2025-01-07 22:56:53",
                "updated_at": "2025-01-07 22:56:53"
            }
        ]
    }
}

Error

{
    "status": 401,
    "error": "Authentication invalid"
},

{
    "status": 401,
    "error": "Unauthorized: Invalid API Key"
}