Skip to main content

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.

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. 
Authorization: Bearer <access_token>
Version: 2021-07-28
See OAuth 2.0 for details on obtaining an access token.

​
OAuth scopes

Products API endpoints support both Location-Access and Company-Access schemes where noted.
ScopeAccess
products.readonlyRead products
products.writeCreate, update, and delete products
products/prices.readonlyRead product prices
products/prices.writeCreate, update, and delete product prices
products/collection.readonlyRead product collections
products/collection.writeCreate, update, and delete product collections

​
Quick start

Create a new product in a location: 
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

MethodPathDescription
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-updateBulk Update Products
POST/products/bulk-update/inventoryBulk Update Inventory
POST/products/bulk-update/editBulk Edit Products and Prices
POST/products/{productId}/priceCreate Price for a Product
GET/products/{productId}/priceList 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/inventoryList Inventory
POST/products/inventoryUpdate Inventory
GET/products/store/{storeId}/statsFetch Product Store Stats
POST/products/store/{storeId}Action to include/exclude the product in store
POST/products/store/{storeId}/priorityUpdate product display priorities in store
GET/products/collectionsFetch Product Collections
POST/products/collectionsCreate 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}/productsGet collection products
GET/products/reviewsFetch Product Reviews
GET/products/reviews/countFetch Review Count as per status
PUT/products/reviews/{reviewId}Update Product Reviews
DELETE/products/reviews/{reviewId}Delete Product Review
POST/products/reviews/bulk-updateUpdate Product Reviews
  • Store API — Configure shipping zones and store settings for your product catalog
  • Payments API — Process orders and payments for products
  • Invoices API — Generate invoices tied to product purchases
Last modified on March 5, 2026