Mindbody · Schema

CartItem

Implementation of the 'CartItem' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
Item	object	A purchased item; either a pricing option or a retail product.
SalesNotes	string	Sales Notes for the Product Purcahsed
DiscountAmount	number	The amount of the discount applied to the item.
VisitIds	array	The IDs of the booked classes, enrollments, or courses that were reconciled by this cart item. This list is only returned if a valid visit ID was passed in the request’s `VisitIds` list.
AppointmentIds	array	Gets or sets the item.
Appointments	array	The IDs of the appointments that were reconciled by this cart item. This list is only returned if a valid appointment ID was passed in the request’s `AppointmentIds` list.
Id	integer	The item’s ID in the current cart.
Quantity	integer	The quantity of the item being purchased.

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-cart-item-schema.json",
  "title": "CartItem",
  "description": "Implementation of the 'CartItem' model.",
  "type": "object",
  "properties": {
    "Item": {
      "$ref": "#/components/schemas/Any",
      "description": "A purchased item; either a pricing option or a retail product."
    },
    "SalesNotes": {
      "type": "string",
      "description": "Sales Notes for the Product Purcahsed",
      "example": "Example note for Mindbody Public API."
    },
    "DiscountAmount": {
      "type": "number",
      "format": "double",
      "description": "The amount of the discount applied to the item.",
      "example": 49.99
    },
    "VisitIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "The IDs of the booked classes, enrollments, or courses that were reconciled by this cart item. This list is only returned if a valid visit ID was passed in the request\u2019s `VisitIds` list.",
      "example": [
        1
      ]
    },
    "AppointmentIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Gets or sets the item.",
      "example": [
        1
      ]
    },
    "Appointments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Appointment"
      },
      "description": "The IDs of the appointments that were reconciled by this cart item. This list is only returned if a valid appointment ID was passed in the request\u2019s `AppointmentIds` list.",
      "example": [
        {}
      ]
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The item\u2019s ID in the current cart.",
      "example": 123456
    },
    "Quantity": {
      "type": "integer",
      "format": "int32",
      "description": "The quantity of the item being purchased.",
      "example": 10
    }
  }
}