Tamio
Type to search all API docs, webhooks, and appendix pages
↑↓ Navigate ↵ Open Esc Close
Inventory API Products

List all products

GET https://api.tamio.com/v2/products/list

Returns a paginated list of products with extensive filtering, sorting, and data-inclusion options. Use the attributes array to control which extra data blocks (stock, gallery, variations, etc.) are included.

Query Parameters

page integer*

Page number for pagination

per_page integer*

Number of products per page

order string

Sort direction

ascdesc
sort_by string

Field to sort results by

namepricedatepostedstockweightlength
filter string

Text search against product names

type string

Filter by product type

physical_productsdigital_productsservicesbilling_plansphysical_servicesdigital_services
attributes array of string

Extra data blocks to include in each product object

from string

Start date filter (ISO format or Unix timestamp)

to string

End date filter (ISO format or Unix timestamp)

currency string

Filter by product currency (ISO 4217)

tax_classification string

Filter by tax classification category

site_id string

Filter by website/storefront UUID

category_id string

Filter by product category UUID

category_ids array of string

Filter by multiple category UUIDs

include_category_descendands boolean

Include products from descendant (child) categories

warehouse_id string

Filter by warehouse/fulfillment location UUID

teammate_id string

Filter by teammate (team member) UUID

discount_id string

Filter by discount code UUID

custom_attribute_id string

Filter by custom attribute UUID

direct_link_id string

Filter by direct link UUID

affiliate_program_id string

Filter by affiliate program UUID

automation_id string

Filter by automation rule UUID

related_product_id string

Filter products that are related to this product UUID

tax_id string

Filter by tax rule UUID

asset_id string

Filter by digital asset UUID

shown string

Filter by product visibility status

enableddisabled
on_sale string

Filter by on-sale status

enableddisabled
discounts string

Filter by whether discounts are allowed

enableddisabled
stock string

Filter by stock management status

enableddisabled
has_stock boolean

Filter by whether the product currently has stock available

minimum_price number

Minimum price filter (in major currency units)

maximum_price number

Maximum price filter (in major currency units)

delivery_type string

Filter digital products by delivery method

fileurl
license_type string

Filter digital products by license type

listautogeneratednone
billing_cycle string

Filter billing plans by billing cycle frequency

dayweekmonthyear
trial string

Filter billing plans by trial period availability

enableddisabled

Responses

200 Products retrieved successfully

Products retrieved successfully

status integer
total_results integer
products array of Product
id string

Unique product identifier

object string

Object type identifier

name string

Product name in the default language

description string

Short product description

seo_title string

SEO page title override

seo_description string

SEO meta description override

classification string

Tax category classification

is_moss_product boolean

Whether the product falls under EU MOSS/OSS digital taxation rules

created integer

Unix timestamp of creation

updated_unix integer

Unix timestamp of last update

currency string

Primary currency code (uppercase ISO 4217)

type string

Internal product type

physical_productdigital_productbilling_plandigital_servicephysical_service
pricing_model array of PricingModelEntry

Multi-currency pricing entries

id string

Pricing model entry UUID

currency string
price integer
acquisition_price integer

Cost/acquisition price for margin calculation (smallest unit)

recommended_seller_price integer

Recommended retail price (smallest unit)

billing_cycle string

Only present for billing plan products

dayweekmonthyear
interval integer

Only present for billing plan products

price integer

Price in the product's primary currency (smallest unit)

stock integer

Current stock level (null for unlimited)

has_variations boolean

Whether the product has variant options (size, color, etc.)

has_notes boolean

Whether the product has internal notes attached

sample boolean

Whether this product is a sample item. Included when additional_information attribute is requested.

release_date string

Product release date (ISO 8601). Included when additional_information attribute is requested.

release_date_unix integer

Unix timestamp of release date. Included when additional_information attribute is requested.

expiry_date string

Product expiry date (ISO 8601). Included when additional_information attribute is requested.

expiry_date_unix integer

Unix timestamp of expiry date. Included when additional_information attribute is requested.

new_from string

Start date for 'new' badge display. Included when additional_information attribute is requested.

new_from_unix integer

Unix timestamp of new_from. Included when additional_information attribute is requested.

new_to string

End date for 'new' badge display. Included when additional_information attribute is requested.

new_to_unix integer

Unix timestamp of new_to. Included when additional_information attribute is requested.

exclude_from_feed boolean

Whether to exclude from product feeds. Included when additional_information attribute is requested.

google_category integer

Google product category ID. Included when additional_information attribute is requested.

in_stock boolean

Whether the product currently has stock available. Included when stock attribute is requested.

unlimited_stock boolean

Whether stock is unlimited. Included when stock attribute is requested.

min_units integer

Minimum order quantity. Included when stock attribute is requested.

max_units integer

Maximum order quantity. Included when stock attribute is requested.

stock_limit_warning integer

Low stock warning threshold. Included when stock attribute is requested.

allow_negative_stock boolean

Whether orders are accepted even when stock is zero. Included when stock attribute is requested.

on_sale boolean

Whether the product is currently on sale. Included when availability attribute is requested.

discount_allowed boolean

Whether discount codes can be applied. Included when availability attribute is requested.

reviews_allowed boolean

Whether customer reviews are enabled. Included when availability attribute is requested.

hide_if_no_stock boolean

Whether to hide product when out of stock. Included when availability attribute is requested.

shown boolean

Whether the product is visible in the storefront. Included when availability attribute is requested.

buyable boolean

Whether the product can be purchased. Included when availability attribute is requested.

custom_fields array of object

Custom checkout fields defined for this product. Included when availability attribute is requested.

whitelist array of string

Whitelisted email addresses that can purchase. Included when availability attribute is requested.

additional_information object

Physical product identifiers and metadata. Populated when type_data attribute is requested for physical products.

brand string

Product brand

model string

Product model name

asin string

Amazon Standard Identification Number

upc string

Universal Product Code

mpn string

Manufacturer Part Number

isbn string

International Standard Book Number

ean string

European Article Number

gtin string

Global Trade Item Number

sku string

Stock Keeping Unit

hscode string

Harmonized System tariff code

condition string

Product condition

country_of_origin string

Country of manufacture (ISO 3166-1 alpha-2)

packaging_type string

Packaging type for shipping

boxpalletenvelope
detailed_description string

Detailed product description for customs/shipping

nshift_parcel_amount integer

Number of parcels for nShift shipping integration

nshift_quick_id string

nShift quick shipping profile ID

parcels object

Parcel configuration for shipping integrations

weight number

Product weight in kg. Included when type_data attribute is requested for physical products.

net_weight number

Net weight without packaging in kg. Included when type_data attribute is requested for physical products.

dimensions object

Product dimensions. Included when type_data attribute is requested for physical products.

length number

Length in cm

width number

Width in cm

height number

Height in cm

packs array of object

Product pack/bundle configurations. Included when type_data attribute is requested for physical products.

id string

Pack UUID

label object

Multilingual pack labels

stock integer

Pack stock quantity

multiples boolean

Whether multiple packs can be ordered

stock_breakdown array of object

Per-warehouse stock breakdown. Included when type_data attribute is requested for physical products.

warehouse string

Warehouse UUID

stock integer

Stock quantity at this warehouse

delivery_type string

Delivery method for digital products. Included when type_data attribute is requested for digital products.

fileurl
license_type string

License key delivery method. Included when type_data attribute is requested for digital products.

listautogeneratednone
delivery_url string

URL for URL-based delivery. Included when type_data attribute is requested for digital products.

number_of_downloads integer

Maximum allowed downloads per purchase. Included when type_data attribute is requested for digital products.

licenses array of string

Available license keys. Included when type_data attribute is requested for digital products.

digital_files array of string

UUIDs of attached digital files. Included when type_data attribute is requested for digital products.

billing_cycle string

Billing frequency. Included when type_data attribute is requested for billing plans.

dayweekmonthyear
interval integer

Number of billing cycle units between charges. Included when type_data attribute is requested for billing plans.

trial_period integer

Trial period in days. Included when type_data attribute is requested for billing plans.

descriptor string

Payment descriptor shown on customer bank statements. Included when type_data attribute is requested for billing plans.

retries integer

Number of payment retry attempts on failure. Included when type_data attribute is requested for billing plans.

cancel_action string

Action taken when subscription is cancelled. Included when type_data attribute is requested for billing plans.

cancelpause
cancel_behaviour string

When cancellation takes effect. Included when type_data attribute is requested for billing plans.

immediateend_of_period
has_stripe_price boolean

Whether the billing plan has a linked Stripe price. Included when type_data attribute is requested for billing plans.

charge_shipping_during_trial boolean

Whether shipping is charged during trial period. Included when type_data attribute is requested for billing plans.

is_customer_product boolean

Whether this billing plan is a customer-specific product. Included when type_data attribute is requested for billing plans.

clients array of object

Clients assigned to this custom billing plan. Included when type_data attribute is requested for customer-specific billing plans.

id string

Client UUID

name string

Client name

email string

Client email address

gallery array of object

Product image gallery. Included when gallery attribute is requested.

public_url string

Public CDN URL of the image

alt_text string

Image alt text for accessibility

asset_id string

Asset UUID

has_image boolean

Whether the product has at least one gallery image. Included when gallery attribute is requested.

languages object

Multi-language product content keyed by locale code. Included when content attribute is requested.

variations object

Variation configuration and individual variants. Included when variations attribute is requested.

options array of object

Variation option definitions (e.g. Size, Color)

name string
values array of string
variants array of object

Individual variant records

id string

Variant UUID

stock integer

Variant stock quantity

options object

Variant option selections keyed by language

stock_breakdown array of object

Per-warehouse stock for this variant

warehouse string
stock integer
invoices integer

Total number of paid invoices for this product. Included when statistics attribute is requested.

customers integer

Number of distinct customers who purchased. Included when statistics attribute is requested.

subscriptions integer

Number of active subscriptions. Included when statistics attribute is requested.

lifetime_revenue integer

Total lifetime revenue converted to merchant's primary currency (smallest unit). Included when statistics attribute is requested.

related_products array of string

UUIDs of related/cross-sell products. Included when related_products attribute is requested.

400 Bad request (schema validation error)
401 Missing or invalid API key
Next
Retrieve a product
/products/list 
1const response = await fetch("https://api.tamio.com/v2/products/list", {
2  headers: {
3    "Authorization": "Bearer YOUR_API_KEY",
4    "Accept": "application/json"
5  }
6});
7const data = await response.json();
Responses 
{
  "status": 200,
  "total_results": 142,
  "products": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "object": "product",
      "name": "Premium Widget",
      "description": "High-quality premium widget with advanced features",
      "seo_title": "Premium Widget | Buy Online",
      "seo_description": "Shop the Premium Widget — built to last with advanced features.",
      "classification": "Tangible Goods",
      "is_moss_product": false,
      "created": 1700000000,
      "updated_unix": 1700100000,
      "currency": "EUR",
      "type": "physical_product",
      "pricing_model": [
        {
          "id": "660e8400-e29b-41d4-a716-446655440001",
          "currency": "EUR",
          "price": 2999,
          "acquisition_price": 1200,
          "recommended_seller_price": 3499,
          "billing_cycle": "month",
          "interval": 1
        }
      ],
      "price": 2999,
      "stock": 150,
      "has_variations": true,
      "has_notes": false,
      "sample": false,
      "release_date": "2024-06-01T00:00:00Z",
      "release_date_unix": 1717200000,
      "expiry_date": "2025-12-31T23:59:59Z",
      "expiry_date_unix": 1767225599,
      "new_from": "2024-06-01T00:00:00Z",
      "new_from_unix": 1717200000,
      "new_to": "2024-09-01T00:00:00Z",
      "new_to_unix": 1725148800,
      "exclude_from_feed": false,
      "google_category": 5322,
      "in_stock": true,
      "unlimited_stock": false,
      "min_units": 1,
      "max_units": 100,
      "stock_limit_warning": 10,
      "allow_negative_stock": false,
      "on_sale": true,
      "discount_allowed": true,
      "reviews_allowed": true,
      "hide_if_no_stock": false,
      "shown": true,
      "buyable": true,
      "custom_fields": [],
      "whitelist": [
        "[email protected]"
      ],
      "additional_information": {
        "brand": "WidgetCorp",
        "model": "WX-3000",
        "asin": "B09V3KXJPB",
        "upc": "012345678905",
        "mpn": "WX3K-BLK",
        "isbn": "978-3-16-148410-0",
        "ean": "4006381333931",
        "gtin": "00012345678905",
        "sku": "WDG-PRM-001",
        "hscode": "8471.30",
        "condition": "new",
        "country_of_origin": "DE",
        "packaging_type": "box",
        "detailed_description": "string",
        "nshift_parcel_amount": 1,
        "nshift_quick_id": "string",
        "parcels": {}
      },
      "weight": 2.5,
      "net_weight": 2.1,
      "dimensions": {
        "length": 30,
        "width": 20,
        "height": 10
      },
      "packs": [
        {
          "id": "770e8400-e29b-41d4-a716-446655440002",
          "label": {
            "en": "6-Pack",
            "de": "6er-Pack"
          },
          "stock": 50,
          "multiples": true
        }
      ],
      "stock_breakdown": [
        {
          "warehouse": "880e8400-e29b-41d4-a716-446655440003",
          "stock": 75
        }
      ],
      "delivery_type": "file",
      "license_type": "autogenerated",
      "delivery_url": "https://downloads.example.com/premium-widget",
      "number_of_downloads": 5,
      "licenses": [
        "XXXX-YYYY-ZZZZ-1111",
        "XXXX-YYYY-ZZZZ-2222"
      ],
      "digital_files": [],
      "billing_cycle": "month",
      "interval": 1,
      "trial_period": 14,
      "descriptor": "ACME PREMIUM",
      "retries": 2,
      "cancel_action": "cancel",
      "cancel_behaviour": "end_of_period",
      "has_stripe_price": true,
      "charge_shipping_during_trial": false,
      "is_customer_product": false,
      "clients": [
        {
          "id": "990e8400-e29b-41d4-a716-446655440004",
          "name": "Acme Corp",
          "email": "[email protected]"
        }
      ],
      "gallery": [
        {
          "public_url": "https://pub.ox31.com/uploads/product-image-abc123.jpg",
          "alt_text": "Premium Widget front view",
          "asset_id": "aa0e8400-e29b-41d4-a716-446655440005"
        }
      ],
      "has_image": true,
      "languages": {
        "en": {
          "title": "Premium Widget",
          "description": "High-quality premium widget",
          "slug": "premium-widget"
        },
        "de": {
          "title": "Premium-Widget",
          "description": "Hochwertiges Premium-Widget",
          "slug": "premium-widget"
        }
      },
      "variations": {
        "options": [
          {
            "name": "Size",
            "values": [
              "Small",
              "Medium",
              "Large"
            ]
          }
        ],
        "variants": [
          {
            "id": "bb0e8400-e29b-41d4-a716-446655440006",
            "stock": 25,
            "options": {
              "en": {
                "size": "Large",
                "color": "Blue"
              }
            },
            "stock_breakdown": []
          }
        ]
      },
      "invoices": 342,
      "customers": 198,
      "subscriptions": 45,
      "lifetime_revenue": 1025000,
      "related_products": [
        "cc0e8400-e29b-41d4-a716-446655440007",
        "dd0e8400-e29b-41d4-a716-446655440008"
      ]
    }
  ]
}