Salesforce Scheduler Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Salesforce Scheduler
Set Up Salesforce Scheduler
Salesforce Scheduler Data Model Overview
Salesforce Scheduler Standard Objects
Salesforce Scheduler Custom Objects
Salesforce Scheduler Platform Events
Salesforce Scheduler Metadata API Types
Authenticate Salesforce Scheduler APIs
Translate SOQL Query Results
Salesforce Scheduler Business APIs
Salesforce Scheduler Apex Classes
Build Custom Appointment Booking Experiences Using Salesforce Scheduler APIs
Schedule an Anonymous Appointment
Schedule Anonymous Appointments with Appointment Distribution
Schedule Appointments by Selecting Location First
Modify an Anonymous Appointment
Create a Single-Resource Appointment
Modify a Service Appointment
Authenticate with a Connected App
Get Service Appointments
Get Service Appointment Details
Change Appointment Details
Update Service Appointments
Create a Multi-Resource Appointment
Modify a Multi-Resource Service Appointment
Create a Concurrent Appointment
Schedule Appointments by Using Sharing Availability
Schedule Appointments with a Dummy Resource and Reassign to Actual Resources
Integrate Salesforce Scheduler with External Calendars
PDF

Get Service Appointment Details

A service appointment represents an appointment booked through Salesforce Scheduler.
  1. Create a page to show the details of a service appointment record that the user selects.
  2. Make a GET request on the ServiceAppointment object.
    Sample Request

    Here’s a sample GET request to retrieve the service appointment details.

    https://yourInstance.salesforce.com/services/data/v63.0/sobjects/ServiceAppointment/08pS7000000019BIAQ
    Sample Response

    The method returns the service appointment details.

    {
  "attributes": {
    "type": "ServiceAppointment",
    "url": "/services/data/v57.0/sobjects/ServiceAppointment/08pS7000000019BIAQ"
  },
  "Id": "08pS7000000019BIAQ",
  "OwnerId": "005S7000000Ipe4IAC",
  "IsDeleted": false,
  "AppointmentNumber": "SA-0004",
  "CreatedDate": "2023-03-13T17:31:23.000+0000",
  "CreatedById": "005S7000000Ipe4IAC",
  "LastModifiedDate": "2023-03-13T17:31:23.000+0000",
  "LastModifiedById": "005S7000000Ipe4IAC",
  "SystemModstamp": "2023-03-13T17:31:28.000+0000",
  "LastViewedDate": "2023-03-13T17:31:23.000+0000",
  "LastReferencedDate": "2023-03-13T17:31:23.000+0000",
  "ParentRecordId": "001S7000001pFlJIAU",
  "ParentRecordType": "Account",
  "AccountId": "001S7000001pFlJIAU",
  "WorkTypeId": "08qS70000004DQsIAM",
  "ContactId": null,
  "Street": "121 Spear Street",
  "City": "Charlotte",
  "State": "VT",
  "PostalCode": "05445",
  "Country": "United States",
  "Latitude": 44.356843,
  "Longitude": -73.194897,
  "GeocodeAccuracy": "Block",
  "Address": {
    "city": "Charlotte",
    "country": "United States",
    "geocodeAccuracy": "Block",
    "latitude": 44.356843,
    "longitude": -73.194897,
    "postalCode": "05445",
    "state": "VT",
    "street": "121 Spear Street"
  },
  "Description": null,
  "EarliestStartTime": "2023-03-13T17:31:23.000+0000",
  "DueDate": "2023-03-20T17:31:23.000+0000",
  "Duration": null,
  "ArrivalWindowStartTime": "2023-03-15T18:00:00.000+0000",
  "ArrivalWindowEndTime": "2023-03-15T19:00:00.000+0000",
  "Status": "Scheduled",
  "SchedStartTime": "2023-03-15T18:00:00.000+0000",
  "SchedEndTime": "2023-03-15T19:00:00.000+0000",
  "ActualStartTime": null,
  "ActualEndTime": null,
  "ActualDuration": null,
  "DurationType": "Hours",
  "DurationInMinutes": null,
  "ServiceTerritoryId": "0HhS700000001DYKAY",
  "Subject": null,
  "ParentRecordStatusCategory": null,
  "StatusCategory": "Scheduled",
  "ServiceNote": null,
  "AppointmentType": null,
  "Email": null,
  "Phone": null,
  "CancellationReason": null,
  "AdditionalInformation": null,
  "Comments": null,
  "IsAnonymousBooking": false,
  "IsOffsiteAppointment": false,
  "ApptBookingInfoUrl": null,
  "AppointmentInvitationId": null,
  "EngagementChannelTypeId": "0eFS70000004CG5MAM"
}
  3. Parse the JSON response, and show the service appointments details on the page that you created.
On the next page, you can let users to modify an engagement channel type, a service resource, or a time slot depending on what the user chooses to change.