> ## Documentation Index
> Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Products
> The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. Th
The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information.
```http theme={null}
GET https://services.leadconnectorhq.com/products/
```
## Autorización
Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
Versión de la API.
## Query parameters
The maximum number of items to be included in a single page of results
The starting index of the page, indicating the position from which the results should be retrieved.
LocationId is the id of the account
The name of the product for searching.
Filter by product category Ids. Supports comma separated values
The slug value of the collection by which the collection would be searched
Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes
List of product ids to be fetched.
fetch and project products based on the storeId
Separate products by which are included in the store and which are not
If the product is included in the online store
The order of sort which should be applied for the date
## Respuestas
An array of products
The unique identifier for the product.
product description
An array of variants for the product.
A unique identifier for the variant.
The name of the variant.
An array of options for the variant.
The unique identifier for the option.
The name of the option.
The unique identifier for the account.
The name of the product.
The type of the product (e.g., PHYSICAL).
Indicates whether the product is available in-store.
The creation timestamp of the product.
The last update timestamp of the product.
The statement descriptor for the product.
The URL for the product image.
An array of category Ids for the product
The field indicates whether taxes are enabled for the product or not.
An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.
Tax category ID for Automatic taxes calculation.
The Product label details
The slug of the product by which the product will be navigated
list products status
Total number of products
```json theme={null}
{
"products": [
{
"_id": "655b33a82209e60b6adb87a5",
"description": "This is a really awesome product",
"variants": [
{}
],
"locationId": "3SwdhCsvxI8Au3KsPJt6",
"name": "Awesome Product",
"productType": "PHYSICAL",
"availableInStore": true,
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"statementDescriptor": "abcde",
"image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",
"collectionIds": [
"65d71377c326ea78e1c47df5",
"65d71377c326ea78e1c47d34"
],
"isTaxesEnabled": true,
"taxes": [
"654492a4e6bef380114de15a"
],
"automaticTaxCategoryId": "65d71377c326ea78e1c47df5",
"slug": "washing-machine"
}
],
"total": [
{
"total": 20
}
]
}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
```json theme={null}
{}
```
## Ejemplo
```bash cURL theme={null}
curl -X GET 'https://services.leadconnectorhq.com/products/' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
```
```javascript Node.js theme={null}
const response = await fetch('https://services.leadconnectorhq.com/products/', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
```
```python Python theme={null}
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/products/',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
```
```php PHP theme={null}
true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);
```