Mindbody · Schema

Product

Implementation of the 'Product' model. Represents a product.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
ProductId	integer	The unique ID associated with product.
Id	string	The barcode number of the product. This is the `PurchasedItems[].BarcodeId` returned from GET Sales.
CategoryId	integer	The revenue category ID of the product. Use this ID when calling the GET Categories endpoint.
SubCategoryId	integer	The SubCategory ID of the product. Use this ID when calling the GET Categories endpoint.
SecondaryCategoryId	integer	The SecondaryCategory ID of the product. Use this ID when calling the GET Categories endpoint.
Price	number	The price of the product.
TaxIncluded	number	If tax inclusive-pricing is enabled, this field shows how much tax was added to the price. To fetch this value `LocationId` must be passed as a query parameter.
TaxRate	number	The tax rate that was applied to this purchase. To fetch this value `LocationId` must be passed as a query parameter.
GroupId	integer	The unique ID of the product group.
Name	string	The name of the product.
OnlinePrice	number	The online price of the product.
ShortDescription	string	A short text description of the product.
LongDescription	string	A long, more detailed text description of the product.
TypeGroup	integer	The Type group of the product.
SupplierId	integer	The unique ID of the supplier of product.
SupplierName	string	The Supplier Name of the product.
ImageURL	string	The URL of the image associated with this product.
Color	object	Contains information about color of the product.
Size	object	Contains information about the size of the product.
ManufacturerId	string	The ID number attributed to the product by the manufacturer.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-product-schema.json",
  "title": "Product",
  "description": "Implementation of the 'Product' model. Represents a product.",
  "type": "object",
  "properties": {
    "ProductId": {
      "type": "integer",
      "format": "int32",
      "description": "The unique ID associated with product.",
      "example": 123456
    },
    "Id": {
      "type": "string",
      "description": "The barcode number of the product. This is the `PurchasedItems[].BarcodeId` returned from GET Sales.",
      "example": "example-value"
    },
    "CategoryId": {
      "type": "integer",
      "format": "int32",
      "description": "The revenue category ID of the product. Use this ID when calling the GET Categories endpoint.",
      "example": 123456
    },
    "SubCategoryId": {
      "type": "integer",
      "format": "int32",
      "description": "The SubCategory ID of the product. Use this ID when calling the GET Categories endpoint.",
      "example": 123456
    },
    "SecondaryCategoryId": {
      "type": "integer",
      "format": "int32",
      "description": "The SecondaryCategory ID of the product. Use this ID when calling the GET Categories endpoint.",
      "example": 123456
    },
    "Price": {
      "type": "number",
      "format": "double",
      "description": "The price of the product.",
      "example": 49.99
    },
    "TaxIncluded": {
      "type": "number",
      "format": "double",
      "description": "If tax inclusive-pricing is enabled, this field shows how much tax was added to the price. To fetch this value `LocationId` must be passed as a query parameter.",
      "example": 1.0
    },
    "TaxRate": {
      "type": "number",
      "format": "double",
      "description": "The tax rate that was applied to this purchase. To fetch this value `LocationId` must be passed as a query parameter.",
      "example": 1.0
    },
    "GroupId": {
      "type": "integer",
      "format": "int32",
      "description": "The unique ID of the product group.",
      "example": 123456
    },
    "Name": {
      "type": "string",
      "description": "The name of the product.",
      "example": "Sunset Yoga Studio"
    },
    "OnlinePrice": {
      "type": "number",
      "format": "double",
      "description": "The online price of the product.",
      "example": 49.99
    },
    "ShortDescription": {
      "type": "string",
      "description": "A short text description of the product.",
      "example": "Example note for Mindbody Public API."
    },
    "LongDescription": {
      "type": "string",
      "description": "A long, more detailed text description of the product.",
      "example": "Example note for Mindbody Public API."
    },
    "TypeGroup": {
      "type": "integer",
      "format": "int32",
      "description": "The Type group of the product.",
      "example": 1
    },
    "SupplierId": {
      "type": "integer",
      "format": "int32",
      "description": "The unique ID of the supplier of product.",
      "example": 123456
    },
    "SupplierName": {
      "type": "string",
      "description": "The Supplier Name of the product.",
      "example": "example-value"
    },
    "ImageURL": {
      "type": "string",
      "description": "The URL of the image associated with this product.",
      "example": "example-value"
    },
    "Color": {
      "$ref": "#/components/schemas/Color",
      "description": "Contains information about color of the product."
    },
    "Size": {
      "$ref": "#/components/schemas/Size",
      "description": "Contains information about the size of the product."
    },
    "ManufacturerId": {
      "type": "string",
      "description": "The ID number attributed to the product by the manufacturer.",
      "example": "example-value"
    }
  }
}