| AddAppointmentRequest |
Input for add appointment operation.
|
| Address |
The shipping address for the service job.
|
| Appointment |
The details of an appointment.
|
| Appointment.AppointmentStatusEnum.Adapter |
|
| AppointmentResource |
The resource that performs or performed appointment fulfillment.
|
| AppointmentResources |
List of resources that performs or performed job appointment fulfillment.
|
| AppointmentSlot |
A time window along with associated capacity in which the service can be performed.
|
| AppointmentSlotReport |
Availability information as per the service context queried.
|
| AppointmentSlotReport.SchedulingTypeEnum.Adapter |
|
| AppointmentTime |
The time of the appointment window.
|
| AppointmentTimeInput |
The input appointment time details.
|
| AssignAppointmentResourcesRequest |
Request schema for the `assignAppointmentResources` operation.
|
| AssignAppointmentResourcesResponse |
Response schema for the `assignAppointmentResources` operation.
|
| AssignAppointmentResourcesResponsePayload |
The payload for the `assignAppointmentResource` operation.
|
| AssociatedItem |
Information about an item associated with the service job.
|
| AssociatedItem.ItemStatusEnum.Adapter |
|
| AvailabilityRecord |
`AvailabilityRecord` to represent the capacity of a resource over a time range.
|
| AvailabilityRecords |
List of `AvailabilityRecord`s to represent the capacity of a resource over a time range.
|
| Buyer |
Information about the buyer.
|
| CancelReservationResponse |
Response schema for the `cancelReservation` operation.
|
| CancelServiceJobByServiceJobIdResponse |
Response schema for the `cancelServiceJobByServiceJobId` operation.
|
| CapacityType.Adapter |
|
| CompleteServiceJobByServiceJobIdResponse |
Response schema for the `completeServiceJobByServiceJobId` operation.
|
| CreateReservationRecord |
`CreateReservationRecord` entity contains the `Reservation` if there is an error/warning while performing the requested operation on it, otherwise it will contain the new `reservationId`.
|
| CreateReservationRequest |
Request schema for the `createReservation` operation.
|
| CreateReservationResponse |
Response schema for the `createReservation` operation.
|
| CreateServiceDocumentUploadDestination |
The response schema for the `createServiceDocumentUploadDestination` operation.
|
| DayOfWeek.Adapter |
|
| EncryptionDetails |
Encryption details for required client-side encryption and decryption of document contents.
|
| EncryptionDetails.StandardEnum.Adapter |
|
| Error |
Error response returned when the request is unsuccessful.
|
| Error.ErrorLevelEnum.Adapter |
|
| ErrorList |
A list of error responses returned when a request is unsuccessful.
|
| FixedSlot |
In this slot format each slot only has the requested capacity types.
|
| FixedSlotCapacity |
Response schema for the `getFixedSlotCapacity` operation.
|
| FixedSlotCapacityErrors |
The error response schema for the `getFixedSlotCapacity` operation.
|
| FixedSlotCapacityQuery |
Request schema for the `getFixedSlotCapacity` operation.
|
| FulfillmentDocument |
Document that captured during service appointment fulfillment that portrays proof of completion
|
| FulfillmentDocuments |
List of documents captured during service appointment fulfillment.
|
| FulfillmentTime |
Input for fulfillment time details
|
| GetAppointmentSlotsResponse |
The response of fetching appointment slots based on service context.
|
| GetServiceJobByServiceJobIdResponse |
The response schema for the `getServiceJobByServiceJobId` operation.
|
| GetServiceJobsResponse |
Response schema for the `getServiceJobs` operation.
|
| ItemDelivery |
Delivery information for the item.
|
| ItemDeliveryPromise |
Promised delivery information for the item.
|
| JobListing |
The payload for the `getServiceJobs` operation.
|
| Poa |
Proof of Appointment (POA) details.
|
| Poa.PoaTypeEnum.Adapter |
|
| RangeCapacity |
Range capacity entity where each entry has a capacity type and corresponding slots.
|
| RangeSlot |
Capacity slots represented in a format similar to availability rules.
|
| RangeSlotCapacity |
Response schema for the `getRangeSlotCapacity` operation.
|
| RangeSlotCapacityErrors |
The error response schema for the `getRangeSlotCapacity` operation.
|
| RangeSlotCapacityQuery |
Request schema for the `getRangeSlotCapacity` operation.
|
| Recurrence |
Repeated occurrence of an event in a time range.
|
| RescheduleAppointmentRequest |
Input for rescheduled appointment operation.
|
| Reservation |
Reservation object reduces the capacity of a resource.
|
| Reservation.TypeEnum.Adapter |
|
| ScopeOfWork |
The scope of work for the order.
|
| Seller |
Information about the seller of the service job.
|
| ServiceDocumentUploadDestination |
Information about an upload destination.
|
| ServiceJob |
The job details of a service.
|
| ServiceJob.ServiceJobStatusEnum.Adapter |
|
| ServiceJobProvider |
Information about the service job provider.
|
| ServiceLocation |
Information about the location of the service job.
|
| ServiceLocation.ServiceLocationTypeEnum.Adapter |
|
| ServiceUploadDocument |
Input for to be uploaded document.
|
| ServiceUploadDocument.ContentTypeEnum.Adapter |
|
| SetAppointmentFulfillmentDataRequest |
Input for set appointment fulfillment data operation.
|
| SetAppointmentResponse |
Response schema for the `addAppointmentForServiceJobByServiceJobId` and `rescheduleAppointmentForServiceJobByServiceJobId` operations.
|
| Technician |
A technician who is assigned to perform the service job in part or in full.
|
| UpdateReservationRecord |
`UpdateReservationRecord` entity contains the `Reservation` if there is an error/warning while performing the requested operation on it, otherwise it will contain the new `reservationId`.
|
| UpdateReservationRequest |
Request schema for the `updateReservation` operation.
|
| UpdateReservationResponse |
Response schema for the `updateReservation` operation.
|
| UpdateScheduleRecord |
`UpdateScheduleRecord` entity contains the `AvailabilityRecord` if there is an error/warning while performing the requested operation on it.
|
| UpdateScheduleRequest |
Request schema for the `updateSchedule` operation.
|
| UpdateScheduleResponse |
Response schema for the `updateSchedule` operation.
|
| Warning |
Warning returned when the request is successful, but there are important callouts based on which API clients should take defined actions.
|
| WarningList |
A list of warnings returned in the sucessful execution response of an API request.
|