Product Index Endpoint

Structure

See View Product Endpoint for the structure of the order payload inside the data array.

Scopes

Name	Description	Example
`active`	Only return active products	`?scope=active`
`inactive`	Only return inactive products	`?scope=inactive`
`visible`	Only return visible products	`?scope=visible`
`hidden`	Only return hidden products	`?scope=hidden`
`published`	Only return published products	`?scope=published`
`unpublished`	Only return unpublished products	`?scope=unpublished`
`scheduled`	Only return scheduled to be published products	`?scope=scheduled`

These scopes are applied at database level and may not always reflect real-time search index data. For precise filtering use the Product Search Endpoint.

Filters

Name	Description	Example
`models`	Only return products with specific models (note: singular form `?model` not supported)	`?models=ABC,DEF`
`skus`	Only return products with variants that have specific SKUs	`?skus=ABC-123,DEF-456`

Plural filters can also be used in singular form (unless otherwise stated), e.g. ?sku=ABC-123 for ?skus=ABC-123.

Example Request

GET /api/products?per_page=2&min_updated_at=2023-08-30%2010:36:23

Example Response

{
    "current_page": 1,
    "data": [
      //...
    ],
    "first_page_url": "http://aero.test/api/products?page=1",
    "from": 1,
    "last_page": 16,
    "last_page_url": "http://aero.test/api/products?page=16",
    "next_page_url": "http://aero.test/api/products?page=2",
    "path": "http://aero.test/api/products",
    "per_page": 2,
    "prev_page_url": null,
    "to": 2,
    "total": 32
}