HighLevel: Bulk Edit Products and Prices

← Products operations · Get started

Operation gohighlevel.bulkedit

Provider route: POST /products/bulk-update/edit. 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"]["bulkEdit"]>[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.bulkEdit(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.bulk_edit(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Bulk Edit Products and Prices — request body — body

Referenced models: Bulk Edit Products and Prices — request body — body

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 Bulk Edit Products and Prices — response body

Referenced models: Bulk Edit Products and Prices — response body

Schemas

Bulk Edit Products and Prices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
products	array	Required within parent	Array of products to update. Note: The total count includes all prices within each product.
products[]	Model	Each item	Expand Bulk Edit Products and Prices — request body — body products item

Referenced models: Bulk Edit Products and Prices — request body — body products item

Bulk Edit Products and Prices — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Success message
status	boolean	Required within parent	Operation status
updatedCount	JSON	Required within parent
updatedCount (anyOf 1)	number	Alternative	Number of products updated
updatedCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Bulk Edit Products and Prices — request body — body products item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Product ID
automaticTaxCategoryId	string	Optional	Automatic tax category ID
availableInStore	boolean	Optional	Product availability in store
collectionIds	array	Optional	Collection IDs
collectionIds[]	string	Each item
description	string	Optional	Product description
image	string	Optional	Product image
isLabelEnabled	boolean	Optional	Enable product label
isTaxesEnabled	boolean	Optional	Enable taxes
label	object	Optional	Product label
medias	array	Optional	Product media
medias[]	object	Each item
name	string	Optional	Product name
prices	array	Optional	Array of price variants for the product
prices[]	Model	Each item	Expand Bulk Edit Products and Prices — request body — body products item prices item
seo	JSON	Optional	SEO metadata for the product
seo (allOf 1)	Model	All variants apply	Expand Create Product — request body — body seo description, title
slug	string	Optional	Product URL slug
taxInclusive	boolean	Optional	Tax inclusive pricing
taxes	array	Optional	Product taxes
taxes[]	object	Each item

Referenced models: Bulk Edit Products and Prices — request body — body products item prices item, Create Product — request body — body seo description, title

Bulk Edit Products and Prices — request body — body products item prices item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Price ID
allowOutOfStockPurchases	boolean	Optional	Allow out of stock purchases
amount	number	Optional	Price amount
availableQuantity	number	Optional	Available quantity
compareAtPrice	number	Optional	Compare at price
currency	string	Optional	Price currency
name	string	Optional	Price name
recurring	JSON	Optional	Recurring details
recurring (allOf 1)	Model	All variants apply	Expand Create Price for a Product — request body — body / recurring / interval: day, month, week, year
setupFee	number	Optional	Setup fee
shippingOptions	JSON	Optional	Shipping options
shippingOptions (allOf 1)	Model	All variants apply	Expand Create Price for a Product — request body — body shipping Options dimensions, weight
sku	string	Optional	SKU
totalCycles	number	Optional	Total billing cycles
trackInventory	boolean	Optional	Track inventory
trialPeriod	number	Optional	Trial period in days

Referenced models: Create Price for a Product — request body — body / recurring / interval: day, month, week, year, Create Price for a Product — request body — body shipping Options dimensions, weight

Create Product — request body — body seo description, title

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	SEO description
title	string	Optional	SEO title

Create Price for a Product — request body — body / recurring / interval: day, month, week, year

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	The interval at which the recurring event occurs. One of: day, month, week, year
intervalCount	number	Required within parent	The number of intervals between each occurrence of the event.

Create Price for a Product — request body — body shipping Options dimensions, weight

Field	Type	Presence	Description and constraints
$	object	Root
dimensions	JSON	Optional	Dimensions of the product
dimensions (allOf 1)	Model	All variants apply	Expand Create Price for a Product — request body — body / shippingOptions / dimensions, weight / dimensions / unit: cm, in, m
weight	JSON	Optional	Weight options of the product
weight (allOf 1)	Model	All variants apply	Expand Create Price for a Product — request body — body / shippingOptions / dimensions, weight / weight / unit: kg, lb, g, oz

Referenced models: Create Price for a Product — request body — body / shippingOptions / dimensions, weight / dimensions / unit: cm, in, m, Create Price for a Product — request body — body / shippingOptions / dimensions, weight / weight / unit: kg, lb, g, oz

Create Price for a Product — request body — body / shippingOptions / dimensions, weight / dimensions / unit: cm, in, m

Field	Type	Presence	Description and constraints
$	object	Root
height	number	Required within parent	Height of the price
length	number	Required within parent	Length of the price
unit	string	Required within parent	Unit of the price dimensions One of: cm, in, m
width	number	Required within parent	Width of the price

Create Price for a Product — request body — body / shippingOptions / dimensions, weight / weight / unit: kg, lb, g, oz

Field	Type	Presence	Description and constraints
$	object	Root
unit	string	Required within parent	Weight unit of the product One of: kg, lb, g, oz
value	number	Required within parent	Actual weight of the product

Policy, approvals and errors

SDK function policy ID: gohighlevel.bulkedit. Catalog operation: bulkEdit. 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.

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

Official provider source