HighLevel: Products schemas

← Products operations · All schemas

Action to include exclude the product in store — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	Action to include or exclude the product from the store One of: include, exclude
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
productIds	array	Required within parent	Array of product IDs
productIds[]	string	Each item

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 — 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

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 Update Products — 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
availability	boolean	Optional	New availability status
collectionIds	array	Optional	Array of collection IDs
collectionIds[]	string	Each item
compareAtPrice	JSON	Optional	Compare at price update configuration
compareAtPrice (allOf 1)	Model	All variants apply	Expand Bulk Update Products — request body — body price round To Whole, type, value
currency	string	Optional	Currency code
filters	JSON	Optional	Filters to apply when selectAll is true
filters (allOf 1)	Model	All variants apply	Expand Bulk Update Products — request body — body filters available In Store, collection Ids, product Type, search
price	JSON	Optional	Price update configuration
price (allOf 1)	Model	All variants apply	Expand Bulk Update Products — request body — body price round To Whole, type, value
productIds	array	Required within parent	Array of product IDs
productIds[]	string	Each item
type	string	Required within parent	Type of bulk update operation One of: bulk-update-price, bulk-update-availability, bulk-update-product-collection, bulk-delete-products, bulk-update-currency

Referenced models: Bulk Update Products — request body — body filters available In Store, collection Ids, product Type, search, Bulk Update Products — request body — body price round To Whole, type, value

Bulk Update Products — request body — body filters available In Store, collection Ids, product Type, search

Field	Type	Presence	Description and constraints
$	object	Root
availableInStore	boolean	Optional	Filter by availability status
collectionIds	array	Optional	Filter by collection IDs
collectionIds[]	string	Each item
productType	string	Optional	Filter by product type
search	string	Optional	Filter by search term

Bulk Update Products — request body — body price round To Whole, type, value

Field	Type	Presence	Description and constraints
$	object	Root
roundToWhole	boolean	Optional	Round to nearest whole number
type	string	Required within parent	Type of price update One of: INCREASE_BY_AMOUNT, REDUCE_BY_AMOUNT, SET_NEW_PRICE, INCREASE_BY_PERCENTAGE, REDUCE_BY_PERCENTAGE
value	number	Required within parent	Value to update (amount or percentage based on type)

Create Price for a Product — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
allowOutOfStockPurchases	boolean	Optional	Continue selling when out of stock
amount	number	Required within parent	The amount of the price. ( min: 0 )
availableQuantity	number	Optional	Available inventory stock quantity
compareAtPrice	number	Optional	The compare at price for the price.
currency	string	Required within parent	The currency of the price.
description	string	Optional	A brief description of the price.
digitalDelivery	array	Optional	Digital delivery options
digitalDelivery[]	string	Each item
isDigitalProduct	boolean	Optional	Is the product a digital product
locationId	string	Required within parent	The unique identifier of the location associated with the price.
membershipOffers	array	Optional	An array of membership offers associated with the price.
membershipOffers[]	Model	Each item	Expand Create Price for a Product — response body — membership Offers item
meta	JSON	Optional	Additional metadata associated with the price.
meta (allOf 1)	Model	All variants apply	Expand Create Price for a Product — request body — body / meta / internalSource: agency plan, funnel, membership, communities, gokollab, calendar, source: stripe, woocommerce, shopify
name	string	Required within parent	The name of the price.
recurring	JSON	Optional	The recurring details of the price (if type is recurring).
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	The setup fee for the price.
shippingOptions	JSON	Optional	Shipping options of the Price
shippingOptions (allOf 1)	Model	All variants apply	Expand Create Price for a Product — request body — body shipping Options dimensions, weight
sku	string	Optional	The unique identifier of the SKU associated with the price
totalCycles	number	Optional	The total number of billing cycles for the price. ( min: 1 )
trackInventory	boolean	Optional	Need to track inventory stock quantity
trialPeriod	number	Optional	The trial period duration in days (if applicable).
type	string	Required within parent	The type of the price. One of: one_time, recurring
userId	string	Optional	The unique identifier of the user who created the price.
variantOptionIds	array	Optional	An array of variant option IDs associated with the price.
variantOptionIds[]	string	Each item

Referenced models: Create Price for a Product — response body — membership Offers item, Create Price for a Product — request body — body / meta / internalSource: agency plan, funnel, membership, communities, gokollab, calendar, source: stripe, woocommerce, shopify, 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 Price for a Product — request body — body / meta / internalSource: agency plan, funnel, membership, communities, gokollab, calendar, source: stripe, woocommerce, shopify

Field	Type	Presence	Description and constraints
$	object	Root
internalSource	string	Required within parent	The internal source of the price. One of: agency_plan, funnel, membership, communities, gokollab, calendar
source	string	Required within parent	The source of the price. One of: stripe, woocommerce, shopify
sourceId	string	Optional	The id of the source of the price from where it is imported
stripePriceId	string	Required within parent	The Stripe price ID associated with the price.

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 / 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

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 — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the price.
allowOutOfStockPurchases	boolean	Optional	Continue selling when out of stock
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	The amount of the price.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
availableQuantity	JSON	Optional
availableQuantity (anyOf 1)	number	Alternative	Available inventory stock quantity
availableQuantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
compareAtPrice	JSON	Optional
compareAtPrice (anyOf 1)	number	Alternative	The compare-at price for comparison purposes.
compareAtPrice (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Optional	The creation timestamp of the price. Format: date-time
currency	string	Required within parent	The currency code for the price.
locationId	string	Optional	The unique identifier for the location.
membershipOffers	array	Optional	An array of membership offers associated with the price.
membershipOffers[]	Model	Each item	Expand Create Price for a Product — response body — membership Offers item
name	string	Required within parent	The name of the price.
product	string	Optional	The unique identifier for the associated product.
recurring	JSON	Optional	The recurring details of the price (if type is recurring).
recurring (allOf 1)	Model	All variants apply	Expand Create Price for a Product — response body — recurring / interval: day, month, week, year
trackInventory	boolean	Optional	Indicates whether inventory tracking is enabled.
type	string	Required within parent	The type of the price (e.g., one_time). Known values: one_time, recurring
updatedAt	string	Optional	The last update timestamp of the price. Format: date-time
userId	string	Optional	The unique identifier for the user.
variantOptionIds	array	Optional	An array of variant option IDs associated with the price.
variantOptionIds[]	string	Each item

Referenced models: Create Price for a Product — response body — membership Offers item, Create Price for a Product — response body — recurring / interval: day, month, week, year

Create Price for a Product — response body — membership Offers item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the membership offer.
label	string	Required within parent	Membership offer label
value	string	Required within parent	Membership offer label

Create Price for a Product — response 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. Known values: day, month, week, year
intervalCount	JSON	Required within parent
intervalCount (anyOf 1)	number	Alternative	The number of intervals between each occurrence of the event.
intervalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Product Collection — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	The type of alt. For now it is only LOCATION One of: location
collectionId	string	Optional	Unique Identifier of the Product Collection, Mongo Id
image	string	Optional	The URL of the image that is going to be displayed as the collection Thumbnail
name	string	Required within parent	Name of the Product Collection
seo	JSON	Optional	The metadata information which will be displayed in SEO previews
seo (allOf 1)	Model	All variants apply	Expand Create Product Collection — request body — body seo description, title
slug	string	Required within parent	Slug of the Product Collection which helps in navigation

Referenced models: Create Product Collection — request body — body seo description, title

Create Product Collection — request body — body seo description, title

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	The description which would be displayed in preview purposes
title	string	Optional	The title which will be displayed as an SEO format

Create Product Collection — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	created Collection
data (allOf 1)	Model	All variants apply	Expand Create Product Collection — response body — data id, alt Id, created At, image, name, seo, slug

Referenced models: Create Product Collection — response body — data id, alt Id, created At, image, name, seo, slug

Create Product Collection — response body — data id, alt Id, created At, image, name, seo, slug

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the collection
altId	string	Required within parent	Location Id to which the collection is associated
createdAt	string	Required within parent	Date at which the collection was created
image	string	Required within parent	The URL of the image that is going to be displayed as the collection Thumbnail
name	string	Required within parent	Name of the collection
seo	JSON	Required within parent	The information which will be displayed in SEO previews
seo (allOf 1)	Model	All variants apply	Expand Create Product Collection — request body — body seo description, title
slug	string	Required within parent	Slug of the collection with which navigation is established. Special Characters and spacing is not allowed and should be unique

Referenced models: Create Product Collection — request body — body seo description, title

Create Product — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
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
description	string	Optional	A brief description of the product.
image	string	Optional	The URL for the product image.
isLabelEnabled	boolean	Optional	Is the product label enabled. If this is true, label object cannot be empty. Default: false
isTaxesEnabled	boolean	Optional	Are there any taxes attached to the product. If this is true, taxes array cannot be empty. Default: false
label	JSON	Optional	Details for Product Label
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.
medias	array	Optional	An array of medias for the product.
medias[]	Model	Each item	Expand Create Product — request body — body medias item
name	string	Required within parent	The name of the product.
productType	string	Required within parent	One of: DIGITAL, PHYSICAL, SERVICE, PHYSICAL/DIGITAL
seo	JSON	Optional	SEO data for the product that will be displayed in the preview
seo (allOf 1)	Model	All variants apply	Expand Create Product — request body — body seo description, title
slug	string	Optional	The slug using which the product navigation will be handled
statementDescriptor	string	Optional	The statement descriptor for the product.
taxInclusive	boolean	Optional	Whether the taxes should be included in the purchase price Default: false
taxes	array	Optional	List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
taxes[]	string	Each item
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, Create Product — request body — body medias item, Create Product — request body — body seo description, title

Create Product — request body — body medias item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the media.
isFeatured	boolean	Optional	Indicates whether the media is featured.
priceIds	array	Optional	Mongo ObjectIds of the prices for which the media is assigned
priceIds[]	array	Each item
title	string	Optional	The title of the media file.
type	string	Required within parent	The type of the media file (e.g., image, video will be supporting soon). One of: image, video
url	string	Required within parent	The URL where the media file is stored.

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 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

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.

Delete Price by ID for a Product — response body

Field	Type	Presence	Description and constraints
$	object	Root
status	boolean	Required within parent	returns true if the price is successfully deleted

Delete Product by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
status	boolean	Required within parent	returns true if the product is successfully deleted

Fetch Product Reviews — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	Array of Collections
data[]	array	Each item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	The total count of the collections present, which is useful to calculate the pagination
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch Product Store Stats — response body

Field	Type	Presence	Description and constraints
$	object	Root
excludedFromStore	JSON	Required within parent
excludedFromStore (anyOf 1)	number	Alternative	Number of products excluded from the store
excludedFromStore (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
includedInStore	JSON	Required within parent
includedInStore (anyOf 1)	number	Alternative	Number of products included in the store
includedInStore (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalProducts	JSON	Required within parent
totalProducts (anyOf 1)	number	Alternative	Total number of products
totalProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch Review Count as per status — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	Array of review status counts
data[]	array	Each item

Get Details about individual product collection — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Collection Data
data (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
status	boolean	Required within parent	Status of the operation

Referenced models: Delete Event — request body — body

List Inventory — response body

Field	Type	Presence	Description and constraints
$	object	Root
inventory	array	Required within parent	List of inventory items
inventory[]	Model	Each item	Expand List Inventory — response body — inventory item
total	object	Required within parent	Total count of inventory items

Referenced models: List Inventory — response body — inventory item

List Inventory — response body — inventory item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the price
allowOutOfStockPurchases	boolean	Required within parent	Whether out of stock purchases are allowed
availableQuantity	JSON	Required within parent
availableQuantity (anyOf 1)	number	Alternative	Available quantity in inventory
availableQuantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
image	string	Optional	Product image URL
name	string	Required within parent	Name of the price/variant
product	string	Required within parent	Product ID this price belongs to
productName	string	Optional	Product name
sku	string	Required within parent	SKU for the product variant
updatedAt	string	Required within parent	Last update timestamp

List Prices for a Product — response body

Field	Type	Presence	Description and constraints
$	object	Root
prices	array	Required within parent	An array of prices
prices[]	Model	Each item	Expand Create Price for a Product — response body
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Default: Total number of prices available
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create Price for a Product — response body

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

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]+)?$

Update Inventory — 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
items	array	Required within parent	Array of items to update in the inventory.
items[]	Model	Each item	Expand Update Inventory — request body — body items item

Referenced models: Update Inventory — request body — body items item

Update Inventory — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
allowOutOfStockPurchases	boolean	Optional	Whether to continue selling the item when out of stock.
availableQuantity	number	Optional	The available quantity of the item.
priceId	string	Required within parent	The unique identifier for the price, in MongoDB ID format.

Update Inventory — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	Success message
status	boolean	Required within parent	Status of api action

Update Product Collection — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	The type of alt. For now it is only LOCATION One of: location
image	string	Optional	The URL of the image that is going to be displayed as the collection Thumbnail
name	string	Optional	Name of the Product Collection
seo	JSON	Optional	The metadata information which will be displayed in SEO previews
seo (allOf 1)	Model	All variants apply	Expand Create Product Collection — request body — body seo description, title
slug	string	Optional	Slug of the Product Collection which helps in navigation

Referenced models: Create Product Collection — request body — body seo description, title

Update Product Reviews — products bulk Update Product Review — 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
reviews	array	Required within parent	Array of Product Reviews
reviews[]	Model	Each item	Expand Update Product Reviews — products bulk Update Product Review — request body — body reviews item
status	object	Required within parent	Status of the review

Referenced models: Update Product Reviews — products bulk Update Product Review — request body — body reviews item

Update Product Reviews — products bulk Update Product Review — request body — body reviews item

Field	Type	Presence	Description and constraints
$	object	Root
productId	string	Required within parent	Product Id
reviewId	string	Required within parent	Review Id
storeId	string	Required within parent	Store Id

Update Product Reviews — products update Product Review — 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
detail	string	Optional	Detailed Review of the product
headline	string	Optional	Headline of the Review
productId	string	Required within parent	Product Id
rating	number	Optional	Rating of the product
reply	array	Optional	Reply of the review
reply[]	Model	Each item	Expand Update Product Reviews — products update Product Review — request body — body reply item
status	string	Required within parent	Status of the review

Referenced models: Update Product Reviews — products update Product Review — request body — body reply item

Update Product Reviews — products update Product Review — request body — body reply item

Field	Type	Presence	Description and constraints
$	object	Root
comment	string	Required within parent	Detailed Review of the product Maximum length: 5000 Minimum length: 0
headline	string	Required within parent	Headline of the Review Maximum length: 200 Minimum length: 0
user	JSON	Required within parent	User who is giving the review/reply
user (allOf 1)	Model	All variants apply	Expand Update Product Reviews — products update Product Review — request body — body reply item user email, is Customer, name, phone

Referenced models: Update Product Reviews — products update Product Review — request body — body reply item user email, is Customer, name, phone

Update Product Reviews — products update Product Review — request body — body reply item user email, is Customer, name, phone

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	Email of the customer
isCustomer	boolean	Optional	Is the person an admin or customer
name	string	Required within parent	Name of the customer Maximum length: 100 Minimum length: 1
phone	string	Optional	Phone no of the customer

Update Product by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
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
description	string	Optional	A brief description of the product.
image	string	Optional	The URL for the product image.
isLabelEnabled	boolean	Optional	Is the product label enabled. If this is true, label object cannot be empty. Default: false
isTaxesEnabled	boolean	Optional	Are there any taxes attached to the product. If this is true, taxes array cannot be empty. Default: false
label	JSON	Optional	Details for Product Label
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.
medias	array	Optional	An array of medias for the product.
medias[]	Model	Each item	Expand Create Product — request body — body medias item
name	string	Required within parent	The name of the product.
prices	array	Optional	The prices of the product
prices[]	string	Each item
productType	string	Required within parent	One of: DIGITAL, PHYSICAL, SERVICE, PHYSICAL/DIGITAL
seo	JSON	Optional	SEO data for the product that will be displayed in the preview
seo (allOf 1)	Model	All variants apply	Expand Create Product — request body — body seo description, title
slug	string	Optional	The slug using which the product navigation will be handled
statementDescriptor	string	Optional	The statement descriptor for the product.
taxInclusive	boolean	Optional	Whether the taxes should be included in the purchase price Default: false
taxes	array	Optional	List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
taxes[]	string	Each item
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, Create Product — request body — body medias item, Create Product — request body — body seo description, title

Update product display priorities in store — 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 with their display priorities
products[]	array	Each item