> ## Documentation Index
> Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Products Overview

> Create, list, update, delete, and manage products, prices, collections, inventory, and reviews through the HoopAI Platform REST API.

The HoopAI Platform Products API provides complete lifecycle management for your e-commerce catalog. Use it to create and update product listings, define and manage price variants, organise products into collections, control per-store visibility and display priorities, perform bulk edits and inventory updates, and moderate customer reviews — giving you full programmatic control over the HoopAI storefront experience.

## Base URL

```
https://services.leadconnectorhq.com
```

## Authentication

Every request must include a Bearer token and the API version header.

```bash theme={null}
Authorization: Bearer <access_token>
Version: 2021-07-28
```

See [OAuth 2.0](/api-reference/oauth/overview) for details on obtaining an access token.

## OAuth scopes

Products API endpoints support both `Location-Access` and `Company-Access` schemes where noted.

| Scope                          | Access                                         |
| ------------------------------ | ---------------------------------------------- |
| `products.readonly`            | Read products                                  |
| `products.write`               | Create, update, and delete products            |
| `products/prices.readonly`     | Read product prices                            |
| `products/prices.write`        | Create, update, and delete product prices      |
| `products/collection.readonly` | Read product collections                       |
| `products/collection.write`    | Create, update, and delete product collections |

## Quick start

Create a new product in a location:

```bash theme={null}
curl -X POST "https://services.leadconnectorhq.com/products/" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "locationId": "<locationId>",
    "name": "Training Programme",
    "description": "12-week basketball training programme",
    "productType": "DIGITAL"
  }'
```

## Endpoints

| Method   | Path                                            | Description                                     |
| -------- | ----------------------------------------------- | ----------------------------------------------- |
| `POST`   | `/products/`                                    | Create Product                                  |
| `GET`    | `/products/`                                    | List Products                                   |
| `GET`    | `/products/{productId}`                         | Get Product by ID                               |
| `PUT`    | `/products/{productId}`                         | Update Product by ID                            |
| `DELETE` | `/products/{productId}`                         | Delete Product by ID                            |
| `POST`   | `/products/bulk-update`                         | Bulk Update Products                            |
| `POST`   | `/products/bulk-update/inventory`               | Bulk Update Inventory                           |
| `POST`   | `/products/bulk-update/edit`                    | Bulk Edit Products and Prices                   |
| `POST`   | `/products/{productId}/price`                   | Create Price for a Product                      |
| `GET`    | `/products/{productId}/price`                   | List Prices for a Product                       |
| `GET`    | `/products/{productId}/price/{priceId}`         | Get Price by ID for a Product                   |
| `PUT`    | `/products/{productId}/price/{priceId}`         | Update Price by ID for a Product                |
| `DELETE` | `/products/{productId}/price/{priceId}`         | Delete Price by ID for a Product                |
| `GET`    | `/products/inventory`                           | List Inventory                                  |
| `POST`   | `/products/inventory`                           | Update Inventory                                |
| `GET`    | `/products/store/{storeId}/stats`               | Fetch Product Store Stats                       |
| `POST`   | `/products/store/{storeId}`                     | Action to include/exclude the product in store  |
| `POST`   | `/products/store/{storeId}/priority`            | Update product display priorities in store      |
| `GET`    | `/products/collections`                         | Fetch Product Collections                       |
| `POST`   | `/products/collections`                         | Create Product Collection                       |
| `GET`    | `/products/collections/{collectionId}`          | Get Details about individual product collection |
| `PUT`    | `/products/collections/{collectionId}`          | Update Product Collection                       |
| `DELETE` | `/products/collections/{collectionId}`          | Delete Product Collection                       |
| `GET`    | `/products/collections/{collectionId}/products` | Get collection products                         |
| `GET`    | `/products/reviews`                             | Fetch Product Reviews                           |
| `GET`    | `/products/reviews/count`                       | Fetch Review Count as per status                |
| `PUT`    | `/products/reviews/{reviewId}`                  | Update Product Reviews                          |
| `DELETE` | `/products/reviews/{reviewId}`                  | Delete Product Review                           |
| `POST`   | `/products/reviews/bulk-update`                 | Update Product Reviews                          |

## Related

* [Store API](/api-reference/store/overview) — Configure shipping zones and store settings for your product catalog
* [Payments API](/api-reference/payments/overview) — Process orders and payments for products
* [Invoices API](/api-reference/invoices/overview) — Generate invoices tied to product purchases