# Product Index Endpoint

#### Structure

See [<span class="s1">View Product Endpoint</span>](https://support.aerocommerce.com/books/api/page/view-product-endpoint) for the structure of the order payload inside the data array.

#### Scopes

<table border="1" id="bkmrk-name-description-exa" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Description**  
</td><td>**Example**  
</td></tr><tr><td>`active`</td><td>Only return active products</td><td>`?scope=active`</td></tr><tr><td>`inactive`</td><td>Only return inactive products</td><td>`?scope=inactive`</td></tr><tr><td>`visible`</td><td>Only return visible products</td><td>`?scope=visible`</td></tr><tr><td>`hidden`</td><td>Only return hidden products</td><td>`?scope=hidden`</td></tr><tr><td>`published`</td><td>Only return published products</td><td>`?scope=published`</td></tr><tr><td>`unpublished`</td><td>Only return unpublished products</td><td>`?scope=unpublished`</td></tr><tr><td>`scheduled`</td><td>Only return scheduled to be published products</td><td>`?scope=scheduled`</td></tr></tbody></table>

<p class="callout info">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](https://support.aerocommerce.com/books/api/page/product-search-endpoint).</p>

#### Filters

<table border="1" id="bkmrk-name-description-exa-1" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Description**  
</td><td>**Example**  
</td></tr><tr><td>`models`</td><td>Only return products with specific models (note: singular form `?model` not supported)</td><td>`?models=ABC,DEF`</td></tr><tr><td>`skus`</td><td>Only return products with variants that have specific SKUs</td><td>`?skus=ABC-123,DEF-456`</td></tr></tbody></table>

<p class="callout info">Plural filters can also be used in singular form (unless otherwise stated), e.g. `?sku=ABC-123` for `?skus=ABC-123`.</p>

#### Example Request

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

#### Example Response

```json
{
    "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
}
```