Mindbody · JSON Structure

Public Api V6 Checkout Appointment Booking Request Structure

Implementation of the 'CheckoutAppointmentBookingRequest' model.

Type: object Properties: 7
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

CheckoutAppointmentBookingRequest is a JSON Structure definition published by Mindbody, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

StaffId LocationId SessionTypeId Resources StartDateTime EndDateTime ProviderId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-checkout-appointment-booking-request-structure.json",
  "name": "CheckoutAppointmentBookingRequest",
  "description": "Implementation of the 'CheckoutAppointmentBookingRequest' model.",
  "type": "object",
  "properties": {
    "StaffId": {
      "type": "int32",
      "description": "The ID of the staff member who is to provide the service being booked.",
      "example": 123456
    },
    "LocationId": {
      "type": "int32",
      "description": "The ID of the location where the appointment is to take place.",
      "example": 123456
    },
    "SessionTypeId": {
      "type": "int32",
      "description": "The ID of the session type of this appointment.",
      "example": 123456
    },
    "Resources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ResourceSlim"
      },
      "description": "Contains information about the resources to be used for the appointment.",
      "example": [
        {}
      ]
    },
    "StartDateTime": {
      "type": "datetime",
      "description": "The date and time that the appointment is to start in the business\u2019 timezone. This value must be passed in the format yyyy-mm-ddThh:mm:ss.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EndDateTime": {
      "type": "datetime",
      "description": "The date and time that the appointment is to end in the business\u2019 timezone. This value must be passed in the format yyyy-mm-ddThh:mm:ss.",
      "example": "2026-05-28T14:30:00Z"
    },
    "ProviderId": {
      "type": "string",
      "description": "The National Provider Identifier (NPI) of the staff member who is to provide the service. For an explanation of Provider IDs, see [Provider IDs](https://support.mindbodyonline.com/s/article/204075743-Provide r-IDs?language=en_US).",
      "example": "example-value"
    }
  }
}