Get service job appointment slots

Learn how to retrieve current appointment availability, available resource capacity, and existing jobs.

Learn how to retrieve:

  • Current appointment availability, as determined by the Scheduling Widget presentation configurations
  • Available resource capacity
  • Existing jobs

To retrieve information about service job appointment slots, call the following operations:

  • getAppointmentSlots returns slots based on a service identifier (such as an ASIN) and the region ID (such as a storeID) for which service is offered by the seller.
  • getAppointmmentSlotsByJobId returns slots for the service associated with the job that the seller has received for fulfillment.

You can use the available appointments you receive as inputs for the addAppointmentForServiceJobByServiceJobId and rescheduleAppointmentForServiceJobByServiceJobId operations, and for analytics.

📘

Note

When you use available slots as operation inputs, the calls might fail because of availability changes that can occur after you receive availability.

Prerequisites

To complete this tutorial, you need:

  • Authorization from the seller for whom you are making calls. Refer to Authorizing Selling Partner Applications for more information.
  • The Professional Services role.
  • An ASIN that the service provider configures for fulfillment.
  • A Store ID for a store or coverage area where the provider can fulfill orders.
  • Time slots available for the ASIN and Store ID.

Get appointment slots by ASIN and store ID

The getAppointmentSlots operation returns the appointment slots associated with the scope of work, defined by an ASIN and the storeId that represents a region. The capacity of a slot represents the number of appointments you can reserve in the slot at the time you call the operation.

Get appointment slots by service job ID

The getAppointmmentSlotsByJobId operation returns the appointment slots for the scope of work, defined by a job ID and marketplace IDs. The response format is same as that of getAppointmentSlots.