> ## Documentation Index
> Fetch the complete documentation index at: https://docs.erp.arukz.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List products
> Retrieve a paginated list of products with filtering and sorting
## OpenAPI
````yaml /api-reference/openapi.json get /admin/api/v1/accounts/products
openapi: 3.0.3
info:
title: ARUKZ ERP API
version: v1
description: >-
The REST API of ARUKZ ERP: sales, purchases, inventory, products, partners,
accounts, projects and reference data. Every call acts as the user whose
token it carries and sees only that user's company.
servers:
- url: https://erp.arukz.com
description: ARUKZ ERP (hosted)
security:
- bearerAuth: []
tags:
- name: Authentication
description: Sign in for a token and sign out.
- name: Sales
description: Quotations, sales orders and their lines, deliveries and invoices.
- name: Purchases
description: Purchase orders, receipts, bills, agreements and vendor price lists.
- name: Inventory
description: >-
Warehouses, locations, lots, stock quantities, receipts, deliveries,
transfers and scrap.
- name: Products
description: 'The product catalogue: categories, attributes, variants and packaging.'
- name: Partners
description: Customers, vendors, contacts, addresses and bank accounts.
- name: Accounts
description: >-
Invoices, bills, credit notes, refunds, taxes, journals and the chart of
accounts.
- name: Projects
description: Projects, tasks, stages and milestones.
- name: Reference data
description: Currencies and rates, banks, countries, states and units of measure.
paths:
/admin/api/v1/accounts/products:
get:
tags:
- Accounts
summary: List products
description: Retrieve a paginated list of products with filtering and sorting
operationId: accounts-products-list-products
parameters:
- name: include
in: query
required: false
schema:
type: string
description: >-
Comma-separated list of relationships to include.
**Available options:** parent, variants, uom, uomPO, category,
tags, attributes, attribute_values, company, creator,
propertyAccountIncome, propertyAccountExpense
example: category,tags
description: >-
Comma-separated list of relationships to include.
**Available options:** parent, variants, uom, uomPO, category, tags,
attributes, attribute_values, company, creator,
propertyAccountIncome, propertyAccountExpense
- name: filter[id]
in: query
required: false
schema:
type: string
description: Comma-separated list of IDs to filter by
description: Comma-separated list of IDs to filter by
- name: filter[type]
in: query
required: false
schema:
type: string
description: Filter by product type
enum:
- goods
- service
description: Filter by product type
- name: filter[enable_sales]
in: query
required: false
schema:
type: boolean
description: Filter by sales enabled
example: 'true'
description: Filter by sales enabled
- name: filter[enable_purchase]
in: query
required: false
schema:
type: boolean
description: Filter by purchase enabled
example: 'false'
description: Filter by purchase enabled
- name: filter[category_id]
in: query
required: false
schema:
type: string
description: Comma-separated list of category IDs to filter by
description: Comma-separated list of category IDs to filter by
- name: filter[trashed]
in: query
required: false
schema:
type: string
description: >-
Filter by trashed status: "with" (include trashed), "only" (only
trashed), or any other value for non-trashed only
enum:
- with
- only
example: with
description: >-
Filter by trashed status: "with" (include trashed), "only" (only
trashed), or any other value for non-trashed only
- name: sort
in: query
required: true
schema:
type: string
description: Sort field
example: '-created_at'
description: Sort field
- name: page
in: query
required: true
schema:
type: integer
description: Page number
example: 1
description: Page number
responses:
'200':
description: Success
content:
application/json:
example:
data:
- id: 1
type: goods
name: Big Vision 4K Action Camera
service_tracking: none
reference: Action-01
barcode: BV4K-0001
price: 150
cost: 100
volume: 0
weight: 1.2
description: >-
A high-quality 4k action camera designed for everyday
use.
The 4K Action Camera is
crafted with premium materials, ensuring durability and
functionality. Perfect for those who value quality and
innovation in their everyday essentials.
description_purchase: null
description_sale: null
enable_sales: false
enable_purchase: false
is_favorite: false
is_configurable: true
images:
- 01JR9QKPXFKP1S054PZDM17MEP.png
- 01JR9QKPXPX1TJKCH0DMZ29M12.png
sort: null
parent_id: null
uom_id: 1
uom_po_id: 1
category_id: 11
creator_id: 1
company_id: 1
created_at: '2025-04-08T03:37:55.000000Z'
updated_at: '2025-09-23T07:28:33.000000Z'
deleted_at: null
category:
id: 11
name: Electronic's Devices
full_name: All / Electronic's Devices
parent_path: /1/
parent_id: 1
creator_id: 1
created_at: '2025-04-08T03:34:44.000000Z'
updated_at: '2025-04-08T03:34:44.000000Z'
tags: []
property_account_income_id: null
property_account_expense_id: null
image: null
service_type: null
sale_line_warn: null
expense_policy: null
invoice_policy: null
sale_line_warn_msg: null
sales_ok: true
purchase_ok: true
- id: 1
type: goods
name: Big Vision 4K Action Camera
service_tracking: none
reference: Action-01
barcode: BV4K-0001
price: 150
cost: 100
volume: 0
weight: 1.2
description: >-
A high-quality 4k action camera designed for everyday
use.
The 4K Action Camera is
crafted with premium materials, ensuring durability and
functionality. Perfect for those who value quality and
innovation in their everyday essentials.
description_purchase: null
description_sale: null
enable_sales: false
enable_purchase: false
is_favorite: false
is_configurable: true
images:
- 01JR9QKPXFKP1S054PZDM17MEP.png
- 01JR9QKPXPX1TJKCH0DMZ29M12.png
sort: null
parent_id: null
uom_id: 1
uom_po_id: 1
category_id: 11
creator_id: 1
company_id: 1
created_at: '2025-04-08T03:37:55.000000Z'
updated_at: '2025-09-23T07:28:33.000000Z'
deleted_at: null
category:
id: 11
name: Electronic's Devices
full_name: All / Electronic's Devices
parent_path: /1/
parent_id: 1
creator_id: 1
created_at: '2025-04-08T03:34:44.000000Z'
updated_at: '2025-04-08T03:34:44.000000Z'
tags: []
property_account_income_id: null
property_account_expense_id: null
image: null
service_type: null
sale_line_warn: null
expense_policy: null
invoice_policy: null
sale_line_warn_msg: null
sales_ok: true
purchase_ok: true
links:
first: /?page=1
last: /?page=1
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
- url: null
label: '« Previous'
active: false
- url: /?page=1
label: '1'
active: true
- url: null
label: Next »
active: false
path: /
per_page: 10
to: 2
total: 2
'401':
description: Unauthenticated
content:
application/json:
example:
message: Unauthenticated.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
An API token from [Sign in](/api-reference/authentication), sent as
`Authorization: Bearer `. Tokens last 30 days.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.