HighLevel: List Products

← Products operations · Get started

Operation gohighlevel.products_list_invoices

Provider route: GET /products/. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["products"]["listInvoices"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.products.listInvoices(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.products.list_invoices(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.limit	number	Optional	Default: 0
query.offset	number	Optional	Default: 0
query.locationId	string	Required within parent
query.search	string	Optional
query.collectionIds	string	Optional
query.collectionSlug	string	Optional
query.expand	array	Optional
query.expand[]	string	Each item
query.productIds	array	Optional
query.productIds[]	string	Each item
query.storeId	string	Optional
query.includedInStore	boolean	Optional
query.availableInStore	boolean	Optional
query.sortOrder	string	Optional	One of: asc, desc

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List Products — response body

Referenced models: List Products — response body

Schemas

List Products — response body

Field	Type	Presence	Description and constraints
$	object	Root
products	array	Required within parent	An array of products
products[]	Model	Each item	Expand Create Product — response body
total	array	Required within parent	list products status
total[]	Model	Each item	Expand List Products — response body — total item

Referenced models: Create Product — response body, List Products — response body — total item

Create Product — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the product.
automaticTaxCategoryId	string	Optional	Tax category ID for Automatic taxes calculation.
availableInStore	boolean	Optional	Indicates whether the product is available in-store.
collectionIds	array	Optional	An array of category Ids for the product
collectionIds[]	string	Each item
createdAt	string	Required within parent	The creation timestamp of the product. Format: date-time
description	string	Optional	product description
image	string	Optional	The URL for the product image.
isTaxesEnabled	boolean	Optional	The field indicates whether taxes are enabled for the product or not. Default: false
label	JSON	Optional	The Product label details
label (allOf 1)	Model	All variants apply	Expand Create Product — response body — label end Date, start Date, title
locationId	string	Required within parent	The unique identifier for the location.
name	string	Required within parent	The name of the product.
productType	string	Required within parent	The type of the product (e.g., PHYSICAL).
slug	string	Optional	The slug of the product by which the product will be navigated
statementDescriptor	string	Optional	The statement descriptor for the product.
taxes	array	Optional	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.
taxes[]	string	Each item
updatedAt	string	Required within parent	The last update timestamp of the product. Format: date-time
variants	array	Optional	An array of variants for the product.
variants[]	Model	Each item	Expand Create Product — response body — variants item

Referenced models: Create Product — response body — label end Date, start Date, title, Create Product — response body — variants item

List Products — response body — total item

Field	Type	Presence	Description and constraints
$	object	Root
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of products
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Product — response body — label end Date, start Date, title

Field	Type	Presence	Description and constraints
$	object	Root
endDate	string	Optional	Start date in YYYY-MM-DDTHH:mm:ssZ format
startDate	string	Optional	Start date in YYYY-MM-DDTHH:mm:ssZ format
title	string	Required within parent	The content for the product label.

Create Product — response body — variants item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	A unique identifier for the variant.
name	string	Required within parent	The name of the variant.
options	array	Required within parent	An array of options for the variant.
options[]	Model	Each item	Expand Create Product — response body — variants item options item

Referenced models: Create Product — response body — variants item options item

Create Product — response body — variants item options item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the option.
name	string	Required within parent	The name of the option.

Policy, approvals and errors

SDK function policy ID: gohighlevel.products_list_invoices. Catalog operation: products.list-invoices. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["products.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source