Sale Service Web Service

Sale Service

Click here for a complete list of operations.

CheckoutShoppingCart

Validates and completes a sale by processing all items added to a shopping cart.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /0_5/SaleService.asmx HTTP/1.1
Host: api.mindbodyonline.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://clients.mindbodyonline.com/api/0_5/CheckoutShoppingCart"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CheckoutShoppingCart xmlns="http://clients.mindbodyonline.com/api/0_5">
      <Request>
        <CartID>string</CartID>
        <ClientID>string</ClientID>
        <Test>boolean</Test>
        <CartItems>
          <CartItem>
            <Item xsi:nil="true" />
            <DiscountAmount>decimal</DiscountAmount>
            <Appointments xsi:nil="true" />
            <EnrollmentIDs xsi:nil="true" />
            <ClassIDs xsi:nil="true" />
            <CourseIDs xsi:nil="true" />
            <VisitIDs xsi:nil="true" />
            <AppointmentIDs xsi:nil="true" />
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>int</ID>
            <Quantity>int</Quantity>
          </CartItem>
          <CartItem>
            <Item xsi:nil="true" />
            <DiscountAmount>decimal</DiscountAmount>
            <Appointments xsi:nil="true" />
            <EnrollmentIDs xsi:nil="true" />
            <ClassIDs xsi:nil="true" />
            <CourseIDs xsi:nil="true" />
            <VisitIDs xsi:nil="true" />
            <AppointmentIDs xsi:nil="true" />
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>int</ID>
            <Quantity>int</Quantity>
          </CartItem>
        </CartItems>
        <InStore>boolean</InStore>
        <CalculateTax>boolean</CalculateTax>
        <PromotionCode>string</PromotionCode>
        <Payments>
          <PaymentInfo>
            <Name>string</Name>
          </PaymentInfo>
          <PaymentInfo>
            <Name>string</Name>
          </PaymentInfo>
        </Payments>
        <SendEmail>boolean</SendEmail>
        <LocationID>int</LocationID>
        <Image>base64Binary</Image>
        <ImageFileName>string</ImageFileName>
      </Request>
    </CheckoutShoppingCart>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CheckoutShoppingCartResponse xmlns="http://clients.mindbodyonline.com/api/0_5">
      <CheckoutShoppingCartResult>
        <ShoppingCart>
          <AuthCode>string</AuthCode>
          <Action>None or Added or Updated or Failed or Removed</Action>
          <ID>string</ID>
          <CartItems>
            <CartItem xsi:nil="true" />
            <CartItem xsi:nil="true" />
          </CartItems>
          <SubTotal>double</SubTotal>
          <DiscountTotal>double</DiscountTotal>
          <TaxTotal>double</TaxTotal>
          <GrandTotal>double</GrandTotal>
        </ShoppingCart>
        <Classes>
          <Class>
            <ClassScheduleID>int</ClassScheduleID>
            <Visits xsi:nil="true" />
            <Clients xsi:nil="true" />
            <Location xsi:nil="true" />
            <Resource xsi:nil="true" />
            <MaxCapacity>int</MaxCapacity>
            <WebCapacity>int</WebCapacity>
            <TotalBooked>int</TotalBooked>
            <TotalBookedWaitlist>int</TotalBookedWaitlist>
            <WebBooked>int</WebBooked>
            <SemesterID>int</SemesterID>
            <IsCanceled>boolean</IsCanceled>
            <Substitute>boolean</Substitute>
            <Active>boolean</Active>
            <IsWaitlistAvailable>boolean</IsWaitlistAvailable>
            <IsEnrolled>boolean</IsEnrolled>
            <HideCancel>boolean</HideCancel>
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>int</ID>
            <IsAvailable>boolean</IsAvailable>
            <StartDateTime>dateTime</StartDateTime>
            <EndDateTime>dateTime</EndDateTime>
            <ClassDescription xsi:nil="true" />
            <Staff xsi:nil="true" />
          </Class>
          <Class>
            <ClassScheduleID>int</ClassScheduleID>
            <Visits xsi:nil="true" />
            <Clients xsi:nil="true" />
            <Location xsi:nil="true" />
            <Resource xsi:nil="true" />
            <MaxCapacity>int</MaxCapacity>
            <WebCapacity>int</WebCapacity>
            <TotalBooked>int</TotalBooked>
            <TotalBookedWaitlist>int</TotalBookedWaitlist>
            <WebBooked>int</WebBooked>
            <SemesterID>int</SemesterID>
            <IsCanceled>boolean</IsCanceled>
            <Substitute>boolean</Substitute>
            <Active>boolean</Active>
            <IsWaitlistAvailable>boolean</IsWaitlistAvailable>
            <IsEnrolled>boolean</IsEnrolled>
            <HideCancel>boolean</HideCancel>
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>int</ID>
            <IsAvailable>boolean</IsAvailable>
            <StartDateTime>dateTime</StartDateTime>
            <EndDateTime>dateTime</EndDateTime>
            <ClassDescription xsi:nil="true" />
            <Staff xsi:nil="true" />
          </Class>
        </Classes>
        <Appointments>
          <Appointment>
            <GenderPreference>string</GenderPreference>
            <Duration>int</Duration>
            <ProviderID>string</ProviderID>
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>long</ID>
            <Status>Booked or Completed or Confirmed or Arrived or NoShow or Cancelled or LateCancelled</Status>
            <StartDateTime>dateTime</StartDateTime>
            <EndDateTime>dateTime</EndDateTime>
            <Notes>string</Notes>
            <StaffRequested>boolean</StaffRequested>
            <Program xsi:nil="true" />
            <SessionType xsi:nil="true" />
            <Location xsi:nil="true" />
            <Staff xsi:nil="true" />
            <Client xsi:nil="true" />
            <FirstAppointment>boolean</FirstAppointment>
            <ClientService xsi:nil="true" />
            <Resources xsi:nil="true" />
          </Appointment>
          <Appointment>
            <GenderPreference>string</GenderPreference>
            <Duration>int</Duration>
            <ProviderID>string</ProviderID>
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>long</ID>
            <Status>Booked or Completed or Confirmed or Arrived or NoShow or Cancelled or LateCancelled</Status>
            <StartDateTime>dateTime</StartDateTime>
            <EndDateTime>dateTime</EndDateTime>
            <Notes>string</Notes>
            <StaffRequested>boolean</StaffRequested>
            <Program xsi:nil="true" />
            <SessionType xsi:nil="true" />
            <Location xsi:nil="true" />
            <Staff xsi:nil="true" />
            <Client xsi:nil="true" />
            <FirstAppointment>boolean</FirstAppointment>
            <ClientService xsi:nil="true" />
            <Resources xsi:nil="true" />
          </Appointment>
        </Appointments>
        <Enrollments>
          <ClassSchedule>
            <Classes xsi:nil="true" />
            <Clients xsi:nil="true" />
            <Course xsi:nil="true" />
            <SemesterID>int</SemesterID>
            <IsAvailable>boolean</IsAvailable>
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>int</ID>
            <ClassDescription xsi:nil="true" />
            <DaySunday>boolean</DaySunday>
            <DayMonday>boolean</DayMonday>
            <DayTuesday>boolean</DayTuesday>
            <DayWednesday>boolean</DayWednesday>
            <DayThursday>boolean</DayThursday>
            <DayFriday>boolean</DayFriday>
            <DaySaturday>boolean</DaySaturday>
            <AllowOpenEnrollment>boolean</AllowOpenEnrollment>
            <AllowDateForwardEnrollment>boolean</AllowDateForwardEnrollment>
            <StartTime>dateTime</StartTime>
            <EndTime>dateTime</EndTime>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Staff xsi:nil="true" />
            <Location xsi:nil="true" />
          </ClassSchedule>
          <ClassSchedule>
            <Classes xsi:nil="true" />
            <Clients xsi:nil="true" />
            <Course xsi:nil="true" />
            <SemesterID>int</SemesterID>
            <IsAvailable>boolean</IsAvailable>
            <Action>None or Added or Updated or Failed or Removed</Action>
            <ID>int</ID>
            <ClassDescription xsi:nil="true" />
            <DaySunday>boolean</DaySunday>
            <DayMonday>boolean</DayMonday>
            <DayTuesday>boolean</DayTuesday>
            <DayWednesday>boolean</DayWednesday>
            <DayThursday>boolean</DayThursday>
            <DayFriday>boolean</DayFriday>
            <DaySaturday>boolean</DaySaturday>
            <AllowOpenEnrollment>boolean</AllowOpenEnrollment>
            <AllowDateForwardEnrollment>boolean</AllowDateForwardEnrollment>
            <StartTime>dateTime</StartTime>
            <EndTime>dateTime</EndTime>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Staff xsi:nil="true" />
            <Location xsi:nil="true" />
          </ClassSchedule>
        </Enrollments>
      </CheckoutShoppingCartResult>
    </CheckoutShoppingCartResponse>
  </soap:Body>
</soap:Envelope>