Mindbody · Schema

CheckoutItemWrapper

Implementation of the 'CheckoutItemWrapper' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
Item	object	Information about an item in the cart.
SalesNotes	string	Sales Notes for the product
DiscountAmount	number	The amount the item is discounted. This parameter is ignored for packages.
AppointmentBookingRequests	array	A list of appointments to be booked then paid for by this item. This parameter applies only to pricing option items.
EnrollmentIds	array	A list of enrollment IDs that this item is to pay for. This parameter applies only to pricing option items.
ClassIds	array	A list of class IDs that this item is to pay for. This parameter applies only to pricing option items.
CourseIds	array	A list of course IDs that this item is to pay for. This parameter applies only to pricing option items.
VisitIds	array	A list of visit IDs that this item is to pay for. This parameter applies only to pricing option items.
AppointmentIds	array	A list of appointment IDs that this item is to reconcile.
Id	integer	The item’s unique ID within the cart.
Quantity	integer	The number of this item to be 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-checkout-item-wrapper-schema.json",
  "title": "CheckoutItemWrapper",
  "description": "Implementation of the 'CheckoutItemWrapper' model.",
  "type": "object",
  "properties": {
    "Item": {
      "$ref": "#/components/schemas/CheckoutItem",
      "description": "Information about an item in the cart."
    },
    "SalesNotes": {
      "type": "string",
      "description": "Sales Notes for the product",
      "example": "Example note for Mindbody Public API."
    },
    "DiscountAmount": {
      "type": "number",
      "format": "double",
      "description": "The amount the item is discounted. This parameter is ignored for packages.",
      "example": 49.99
    },
    "AppointmentBookingRequests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CheckoutAppointmentBookingRequest"
      },
      "description": "A list of appointments to be booked then paid for by this item. This parameter applies only to pricing option items.",
      "example": [
        {}
      ]
    },
    "EnrollmentIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of enrollment IDs that this item is to pay for. This parameter applies only to pricing option items.",
      "example": [
        1
      ]
    },
    "ClassIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of class IDs that this item is to pay for. This parameter applies only to pricing option items.",
      "example": [
        1
      ]
    },
    "CourseIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of course IDs that this item is to pay for. This parameter applies only to pricing option items.",
      "example": [
        1
      ]
    },
    "VisitIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of visit IDs that this item is to pay for. This parameter applies only to pricing option items.",
      "example": [
        1
      ]
    },
    "AppointmentIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "A list of appointment IDs that this item is to reconcile.",
      "example": [
        1
      ]
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The item\u2019s unique ID within the cart.",
      "example": 123456
    },
    "Quantity": {
      "type": "integer",
      "format": "int32",
      "description": "The number of this item to be purchased.",
      "example": 10
    }
  }
}