Skip to main content

Business product model

The Product resource belongs to a business category and describes an item that can be displayed or ordered.

Core operations​

ActionMethodResource
ListGET/business/{business_id}/categories/{category_id}/products
FindGET/business/{business_id}/categories/{category_id}/products/{product_id}
CreatePOST/business/{business_id}/categories/{category_id}/products
UpdatePOST/business/{business_id}/categories/{category_id}/products/{product_id}
DeleteDELETE/business/{business_id}/categories/{category_id}/products/{product_id}

Create, update, and delete require administrator or business-manager authentication and business/category ownership context.

Representative fields​

GroupRepresentative fields
Identity and contentid, category_id, name, description, slug, sku, external_id
Price and offerprice, in_offer, offer_price, offer_rate, offer_rate_type, offer_include_options
Availabilityenabled, inventoried, quantity, minimum_per_order, maximum_per_order, snooze_until
Presentationimages, featured, rank, upselling, hide_special_instructions
Catalog and complianceextras, tax_id, fee_id, allergens, dietary_tags, calories, weight, weight_unit

Field presence in the model does not make it valid in every request or response.

inventoried and quantity represent inventory-related behavior. Minimum/maximum-per-order fields constrain cart quantities where supported. Offer fields describe operation-specific offer projections.

The upselling flag supports presenting a product as an additional suggestion. Options or extras can require further selection before the item is added.

For gallery-specific fields, see the Product Gallery model.