List all products
Scope: inventory:products.read https://api.alladdin.com/api/v2/products
Returns a cursor-paginated list of products in your catalog.
Default page size is 50, configurable up to 200 with limit. Pass the returned cursor value to retrieve the next page.
Provide name to return only products whose name matches, searched across your whole catalog. Pagination works the same way (cursor + limit).
Parameters
Query parameters
name string optional
Search products by name across your whole catalog. Optional.
cursor string optional
Opaque cursor for pagination
limit integer optional = 50
Number of products per page. Defaults to 50, maximum 200.
Request
import requests
url = "https://api.alladdin.com/api/v2/products?name=value&cursor=value&limit=50"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"kind": "simple",
"name": "string",
"description": "string",
"type_id": "string",
"price": "99.95",
"taxes": [
"string"
],
"total": "string",
"has_stock": false,
"stock": "15.3",
"barcode": "string",
"sku": "string",
"cost": "50.00",
"purchase_price": "string",
"weight": "3.2",
"tags": [
"string"
],
"category_id": "string",
"factory_code": "string",
"for_sale": false,
"for_purchase": false,
"sales_channel_id": "string",
"exp_account_id": "string",
"warehouse_id": "string",
"archived": false,
"purchase_taxes": [
"string"
],
"min_stock": "5",
"min_stock_alarm": false,
"in_pos": false,
"supplier_id": "string",
"translations": [
{}
],
"rates": [
{
"id": "...",
"subtotal": "...",
"taxes": "..."
}
],
"attributes": [
{
"id": "...",
"name": "...",
"value": "..."
}
],
"variants": [
{
"id": "...",
"sku": "...",
"barcode": "...",
"price": "...",
"cost": "...",
"purchase_price": "...",
"stock": "...",
"description": "...",
"weight": "...",
"factory_code": "...",
"archived": "...",
"options": "...",
"category_fields": "...",
"sales_rates": "..."
}
],
"pack_items": [
{
"product_selection": "...",
"units": "..."
}
],
"stocks": [
{
"warehouse_id": "...",
"stock": "...",
"variant_id": "..."
}
],
"image": {}
}
],
"cursor": "string",
"has_more": false
}Success responses
200 List of all products application/json object items[] object[] id string
Unique identifier of the product
kind string
Type of item
Enum: simple variants lots serialnumbers pack name string
Name of the product
description string | null
Description of the product
type_id string | null
Identifier of the product type
price string | null
Sale price as a decimal string
taxes[] string[]
List of tax identifiers applied to the product
total string | null
Total price including taxes as a decimal string
has_stock boolean
Whether the product has stock tracking enabled
stock string
Current total stock across all warehouses as a decimal string
barcode string | null
Barcode value (EAN, UPC, etc.)
sku string | null
Stock Keeping Unit code
cost string | null
Cost price as a decimal string
purchase_price string | null
Purchase price as a decimal string
weight string | null
Weight in the account default unit as a decimal string
tags[] string[]
List of tags attached to the product
category_id string | null
Identifier of the product category
factory_code string | null
Manufacturer or factory reference code
for_sale boolean
Whether the product is available for sale
for_purchase boolean
Whether the product is available for purchase
sales_channel_id string | null
Identifier of the sales channel assigned to this product
exp_account_id string | null
Identifier of the expenses account
warehouse_id string | null
Identifier of the default warehouse
archived boolean
Whether the product is archived
purchase_taxes[] string[]
List of tax identifiers applied to purchases
min_stock string | null
Minimum stock threshold as a decimal string
min_stock_alarm boolean
Whether the minimum stock alarm is enabled
in_pos boolean
Whether the product is available in point of sale
supplier_id string | null
Identifier of the default supplier
translations[] object[]
Product name translations by locale
rates[] object[]
Price rates with different subtotals and taxes
attributes[] object[]
Product attributes
variants[] object[]
Variants of the product. Present for kinds: variants, lots, serialnumbers. Each item contains fields relevant to the kind.
pack_items[] object[] | null
Component items included in this pack product. Only present for pack products.
stocks[] object[]
Stock per warehouse. Each entry has warehouse_id and stock. Variant products also include variant_id.
image object
Main product image with its resolved URLs. Null when the product has no images.
cursor string | null
Opaque cursor to pass as the cursor query parameter to retrieve the next page. Null when there are no more results.
has_more boolean
Whether there are more results beyond this page.
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json