List Items

A list of all items available in the inventory may be obtained using this endpoint. For emphasis on specific results, you can add filters based on user, business, or category.

Endpoint

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

Headers

Authorization: Bearer API_KEY

Query Parameters

Parameters
Type
Description

category_id

int

Optional

Filters items by the category.

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
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://app.xtrakit.com/api/v1/inventory/items',
  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;

?>

Sample Response

{
    "status": 200,
    "message": "Items found: 20",
    "data": {
        "items": {
            "id": 1,
            "user_id": "f93c5a51-ffa4-4aef-a45b-4cdec1c8cc10",
            "business_code": "15848484",
            "item_code": " Jce84a50",
            "item_name": "HP Laptop",
            "category_id": 1,
            "unit": "pcs",
            "description": "High-end gaming laptop with advanced graphics and processing power.",
            "unit_cost": 1000.00,
            "item_price": 1500.00,
            "previous_price": 1400.00,
            "quantity": "20",
            "minimum_qty_alert": "5",
            "online": 1,
            "status": "in-stock",
            "barcode": "123456789",
            "sku": "LAPTOP001",
            "warehouse_id": 2,
            "item_location": "A1",
            "item_slug": "laptop",
            "created_at": "2024-08-04 08:23:45",
            "updated_at": "2024-08-04 02:00:43"
        },
        ...
    }
}

Last updated