GET All Products - Daftra API Docs

Retrieves a paginated list of all products. The response includes both product data and pagination information.

Parameters:

limit: Number of records per page (1-1000)

page: Page number for pagination

search: Optional search term to filter results (name, description, code, etc.)

product_type: Optional filter by product type (1: product, 2: service)

category_id: Optional filter by product category ID

brand: Optional filter by brand name

store_id: Optional filter by store/location ID

sort: Optional field to sort by (id, name, unit_price, created, etc.)

direction: Optional sort direction (asc or desc)

Response:

{
  "result": "success",
  "code": 200,
  "data": [
    {
      "Product": {
        "id": 1,
        "name": "Premium Widget",
        "description": "High-quality premium widget for industrial applications",
        "unit_price": 199.99,
        "tax1": 1,
        "tax2": 0,
        "supplier_id": 1,
        "brand": "WidgetCo",
        "tags": "premium, industrial, widget",
        "buy_price": 149.99,
        "product_code": "WID-001",
        "track_stock": 1,
        "stock_balance": 100,
        "low_stock_thershold": 20,
        "barcode": "1234567890123",
        "type": 1,
        "availabe_online": 1,
        "created": "2023-01-05 10:15:22",
        "modified": "2023-03-02 14:30:45"
        // Additional product fields...
      }
    },
    // Additional products...
  ],
  "pagination": {
    "page": 1,
    "page_count": 6,
    "total_results": 120,
    "prev": null,
    "next": "/api2/products.json?page=2"
  }
}

{ "result": "success", "code": 200, "data": [ { "Product": { "id": 1, "name": "Premium Widget", "description": "High-quality premium widget for industrial applications", "unit_price": 199.99, "tax1": 1, "tax2": 0, "supplier_id": 1, "brand": "WidgetCo", "tags": "premium, industrial, widget", "buy_price": 149.99, "product_code": "WID-001", "track_stock": 1, "stock_balance": 100, "low_stock_thershold": 20, "barcode": "1234567890123", "type": 1, "availabe_online": 1, "created": "2023-01-05 10:15:22", "modified": "2023-03-02 14:30:45", "category_id": 3, "category_name": "Industrial Components" } }, { "Product": { "id": 2, "name": "Standard Widget", "description": "Reliable standard widget for everyday use", "unit_price": 99.99, "tax1": 1, "tax2": 0, "supplier_id": 1, "brand": "WidgetCo", "tags": "standard, widget", "buy_price": 75, "product_code": "WID-002", "track_stock": 1, "stock_balance": 250, "low_stock_thershold": 50, "barcode": "1234567890456", "type": 1, "availabe_online": 1, "created": "2023-01-05 10:20:35", "modified": "2023-02-28 11:15:20", "category_id": 3, "category_name": "Industrial Components" } } ], "pagination": { "page": 1, "page_count": 6, "total_results": 120, "prev": null, "next": "/api2/products.json?page=2" } }

Request

Query Params

limit

string

required

Number of records to return per page (1-1000)

Example:

page

string

required

Page number for pagination

Example:

string

required

Search term to filter results (name, description, code, etc.)

product_type

string

required

Filter by product type (1: product, 2: service)

category_id

string

required

Filter by product category ID

brand

string

required

Filter by brand name

store_id

string

required

Filter by store/location ID

sort

string

required

Field to sort by (id, name, unit_price, created, etc.)

Example:

direction

string

required

Sort direction (asc or desc)

Example:

desc

Responses

🟢200Success Response

application/json

Body

result

string

required

code

integer

required

data

array [object {1}]

required

Product

object

required

pagination

object

required

page

integer

required

page_count

integer

required

total_results

integer

required

null

required

string

required