Overview

With the Services API, you can build applications that help service providers get and modify their service orders.

Version information

Version : v1

Operations

getServiceJobByServiceJobId
cancelServiceJobByServiceJobId
completeServiceJobByServiceJobId
getServiceJobs
addAppointmentForServiceJobByServiceJobId
rescheduleAppointmentForServiceJobByServiceJobId
assignAppointmentResources
setAppointmentFulfillmentData
updateSchedule
createReservation
updateReservation
cancelReservation
createServiceDocumentUploadDestination

Paths

getServiceJobByServiceJobId

GET /service/v1/serviceJobs/{serviceJobId}

Description

Gets service job details for the service job indicated by the service job identifier you specify.

Usage Plan:

Rate (requests per second)	Burst
20	40

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	serviceJobId required	A service job identifier. minLength : 1 maxLength : 100	string

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
422	Unprocessable Entity. Unable to process the contained instructions. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobByServiceJobIdResponse

cancelServiceJobByServiceJobId

PUT /service/v1/serviceJobs/{serviceJobId}/cancellations

Description

Cancels the service job indicated by the service job identifier you specify.

Usage Plan:

Rate (requests per second)	Burst
5	20

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	serviceJobId required	An Amazon defined service job identifier. minLength : 1 maxLength : 100	string
Query	cancellationReasonCode required	A cancel reason code that specifies the reason for cancelling a service job. minLength : 1 maxLength : 100	string

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
422	Unprocessable Entity. Unable to process the contained instructions Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelServiceJobByServiceJobIdResponse

completeServiceJobByServiceJobId

PUT /service/v1/serviceJobs/{serviceJobId}/completions

Description

Completes the service job indicated by the service job identifier you specify.

Usage Plan:

Rate (requests per second)	Burst
5	20

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	serviceJobId required	An Amazon defined service job identifier. minLength : 1 maxLength : 100	string

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
422	Unprocessable Entity. Unable to process the contained instructions Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CompleteServiceJobByServiceJobIdResponse

getServiceJobs

GET /service/v1/serviceJobs

Description

Gets service job details for the specified filter query.

Usage Plan:

Rate (requests per second)	Burst
10	40

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema	Default
Query	serviceOrderIds optional	List of service order ids for the query you want to perform.Max values supported 20. Min count : 1 Max count : 20	< string > array	-
Query	serviceJobStatus optional	A list of one or more job status by which to filter the list of jobs.	< enum (ServiceJobStatus) > array	-
Query	pageToken optional	String returned in the response of your previous request.	string	-
Query	pageSize optional	A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20. Minimum : 1 Maximum : 20	integer	20
Query	sortField optional	Sort fields on which you want to sort the output.	enum (SortField)	-
Query	sortOrder optional	Sort order for the query you want to perform.	enum (SortOrder)	-
Query	createdAfter optional	A date used for selecting jobs created after (or at) a specified time must be in ISO 8601 format. Required if LastUpdatedAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.	string	-
Query	createdBefore optional	A date used for selecting jobs created before (or at) a specified time must be in ISO 8601 format.	string	-
Query	lastUpdatedAfter optional	A date used for selecting jobs updated after (or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter returns an error.	string	-
Query	lastUpdatedBefore optional	A date used for selecting jobs updated before (or at) a specified time must be in ISO 8601 format.	string	-
Query	scheduleStartDate optional	A date used for filtering jobs schedule after (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.	string	-
Query	scheduleEndDate optional	A date used for filtering jobs schedule before (or at) a specified time must be in ISO 8601 format. schedule end date should not be earlier than schedule start date.	string	-
Query	marketplaceIds required	Used to select jobs that were placed in the specified marketplaces. Max count : 1	< string > array	-

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetServiceJobsResponse

addAppointmentForServiceJobByServiceJobId

POST /service/v1/serviceJobs/{serviceJobId}/appointments

Description

Adds an appointment to the service job indicated by the service job identifier you specify.

Usage Plan:

Rate (requests per second)	Burst
5	20

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	serviceJobId required	An Amazon defined service job identifier. minLength : 1 maxLength : 100	string
Body	body required	Add appointment operation input details.	AddAppointmentRequest

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
422	Unprocessable Entity. Unable to process the contained instructions Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
500	Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse

rescheduleAppointmentForServiceJobByServiceJobId

POST /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}

Description

Reschedules an appointment for the service job indicated by the service job identifier you specify.

Usage Plan:

Rate (requests per second)	Burst
5	20

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	serviceJobId required	An Amazon defined service job identifier. minLength : 1 maxLength : 100	string
Path	appointmentId required	An existing appointment identifier for the Service Job. minLength : 1 maxLength : 100	string
Body	body required	Reschedule appointment operation input details.	RescheduleAppointmentRequest

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
422	Unprocessable Entity. Unable to process the contained instructions Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
500	Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SetAppointmentResponse

assignAppointmentResources

PUT /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/resources

Description

Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment.

Usage Plan:

Rate (requests per second)	Burst
1	2

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	serviceJobId required	An Amazon-defined service job identifier. Get this value by calling getServiceJobs operation of the services API. minLength : 1 maxLength : 100	string
Path	appointmentId required	An Amazon-defined identifier of active service job appointment. minLength : 1 maxLength : 100	string
Body	body required	Request schema for AssignAppointmentResources operation.	AssignAppointmentResourcesRequest

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
422	Unprocessable Entity. Unable to process the contained instructions Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	AssignAppointmentResourcesResponse

setAppointmentFulfillmentData

PUT /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/fulfillment

Description

Captures the appointment fulfillment data.

Parameters

Type	Name	Description	Schema
Path	serviceJobId required	An Amazon-defined service job identifier. Get this value by calling getServiceJobs operation of the services API. minLength : 1 maxLength : 100	string
Path	appointmentId required	An Amazon-defined identifier of active service job appointment. minLength : 1 maxLength : 100	string
Body	body required	Appointment fulfillment data collection details.	SetAppointmentFulfillmentDataRequest

Responses

HTTP Code	Description	Schema
204	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	string
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	ErrorList
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : x-amzn-RequestId (string) : Unique request reference id.	ErrorList
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	ErrorList
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	ErrorList
415	The entity of the request is in a format not supported by the requested resource. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	ErrorList
422	Unprocessable Entity. Unable to process the contained instructions Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	ErrorList
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	ErrorList
500	Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	ErrorList
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	ErrorList

updateSchedule

PUT /service/v1/serviceResources/{resourceId}/schedules

Description

Update a schedule

Parameters

Type	Name	Description	Schema
Path	resourceId required	Resource (store) Identifier minLength : 1 maxLength : 100	string
Body	body required	Schedule details	UpdateScheduleRequest
Query	marketplaceIds required	An identifier for the marketplace in which the resource operates Max count : 1	< string > array

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
500	Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateScheduleResponse

createReservation

POST /service/v1/reservation

Description

Create a reservation

Parameters

Type	Name	Description	Schema
Body	body required	Reservation details	CreateReservationRequest
Query	marketplaceIds required	An identifier for the marketplace in which the resource operates Max count : 1	< string > array

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
500	Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReservationResponse

updateReservation

PUT /service/v1/reservation/{reservationId}

Description

Update a reservation

Parameters

Type	Name	Description	Schema
Path	reservationId required	Reservation Identifier minLength : 1 maxLength : 100	string
Body	body required	Reservation details	UpdateReservationRequest
Query	marketplaceIds required	An identifier for the marketplace in which the resource operates Max count : 1	< string > array

Responses

HTTP Code	Description	Schema
200	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
404	The reservation specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
415	The request payload is in an unsupported format. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
500	Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	UpdateReservationResponse

cancelReservation

DELETE /service/v1/reservation/{reservationId}

Description

Cancel a reservation

Parameters

Type	Name	Description	Schema
Path	reservationId required	Reservation Identifier minLength : 1 maxLength : 100	string
Query	marketplaceIds required	An identifier for the marketplace in which the resource operates Max count : 1	< string > array

Responses

HTTP Code	Description	Schema
204	Success response Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
404	The reservation specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
415	The entity of the request is in a format not supported by the requested resource. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
500	Encountered an unexpected condition which prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CancelReservationResponse

createServiceDocumentUploadDestination

POST /service/v1/documents

Description

Creates an upload destination.

Parameters

Type	Name	Description	Schema
Body	body required	upload document operation input details.	ServiceUploadDocument

Responses

HTTP Code	Description	Schema
200	Successfully created an upload destination for the given resource. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-requestId (string) : Unique request reference identifier.	CreateServiceDocumentUploadDestination
400	Request has missing or invalid parameters and cannot be parsed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CreateServiceDocumentUploadDestination
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers : x-amzn-RequestId (string) : Unique request reference identifier.	CreateServiceDocumentUploadDestination
404	The resource specified does not exist. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CreateServiceDocumentUploadDestination
413	The request size exceeded the maximum accepted size. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CreateServiceDocumentUploadDestination
415	The request's Content-Type header is invalid. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-requestid (string) : Unique request reference identifier.	CreateServiceDocumentUploadDestination
422	Unprocessable Entity. Unable to process the contained instructions Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateServiceDocumentUploadDestination
429	The frequency of requests was greater than allowed. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-requestid (string) : Unique request reference ID.	CreateServiceDocumentUploadDestination
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateServiceDocumentUploadDestination
503	Temporary overloading or maintenance of the server. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference id.	CreateServiceDocumentUploadDestination

Definitions

GetServiceJobByServiceJobIdResponse

The response schema for the GetServiceJobByServiceJobId operation.

Name	Description	Schema
payload optional	The payload for the GetServiceJobByServiceJobId operation.	ServiceJob
errors optional	An unexpected condition occurred during the GetServiceJobByServiceJobId operation.	ErrorList

CancelServiceJobByServiceJobIdResponse

Response schema for CancelServiceJobByServiceJobId operation.

Name	Description	Schema
errors optional	Encountered errors for the CancelServiceJobByServiceJobId operation.	ErrorList

CompleteServiceJobByServiceJobIdResponse

Response schema for CompleteServiceJobByServiceJobId operation.

Name	Description	Schema
errors optional	Encountered errors for the CompleteServiceJobByServiceJobId operation.	ErrorList

GetServiceJobsResponse

Response schema for GetJobs operation.

Name	Description	Schema
payload optional	The payload for the GetJobs operation.	JobListing
errors optional	An unexpected condition occurred during the GetServiceJobs operation.	ErrorList

SetAppointmentResponse

Response schema for add or reschedule appointment operation.

Name	Description	Schema
appointmentId optional	New appointment id generated during add or reschedule appointment operation.	AppointmentId
warnings optional	Warnings generated during add or reschedule appointment operation.	WarningList
errors optional	Errors occurred during during add or reschedule appointment operation.	ErrorList

AssignAppointmentResourcesResponse

Response schema for AssignAppointmentResources operation.

Name	Description	Schema
payload optional	The payload for the Assign Appointment Resource operation.	payload
errors optional	Errors occurred during during assign appointment resources operation.	ErrorList

payload

Name	Description	Schema
warnings optional	Warnings generated during assign appointment resources operation.	WarningList

AssignAppointmentResourcesRequest

Request schema for AssignAppointmentResources operation.

Name	Description	Schema
resources required	List of resource objects to be assigned.	AppointmentResources

JobListing

The payload for the GetJobs operation.

Name	Description	Schema
totalResultSize optional	Total result size of the query result.	integer
nextPageToken optional	A generated string used to pass information to your next request. If nextPageToken is returned, pass the value of nextPageToken to the pageToken to get next results.	string
previousPageToken optional	A generated string used to pass information to your next request. If previousPageToken is returned, pass the value of previousPageToken to the pageToken to get previous page results.	string
jobs optional	List of job details for the given input.	< ServiceJob > array

ServiceJob

The job details of a service.

Name	Description	Schema
createTime optional	The date and time of the creation of the job, in ISO 8601 format.	string (date-time)
serviceJobId optional	The service job identifier.	ServiceJobId
serviceJobStatus optional	The status of the service job.	enum (ServiceJobStatus)
scopeOfWork optional	The scope of work for the order.	ScopeOfWork
seller optional	Information about the seller of the service job.	Seller
serviceJobProvider optional	Information about the service job provider.	ServiceJobProvider
preferredAppointmentTimes optional	A list of appointment windows preferred by the buyer. Included only if the buyer selected appointment windows when creating the order.	< AppointmentTime > array
appointments optional	A list of appointments.	< Appointment > array
serviceOrderId optional	The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format.	OrderId
marketplaceId optional	The marketplace identifier. Pattern : "^[A-Z0-9]<li>$"	string
buyer optional	Information about the buyer.	Buyer
associatedItems optional	A list of items associated with the service job.	< AssociatedItem > array
serviceLocation optional	Information about the location of the service job.	ServiceLocation

ServiceJobId

Amazon identifier for the service job.

Type : string

minLength : 1
maxLength : 100

OrderId

The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format.

Type : string

minLength : 5
maxLength : 20

ScopeOfWork

The scope of work for the order.

Name	Description	Schema
asin optional	The Amazon Standard Identification Number (ASIN) of the service job.	string
title optional	The title of the service job.	string
quantity optional	The number of service jobs.	integer
requiredSkills optional	A list of skills required to perform the job.	< string > array

Seller

Information about the seller of the service job.

Name	Description	Schema
sellerId optional	The identifier of the seller of the service job. Pattern : "^[A-Z0-9]<li>$"	string

ServiceJobProvider

Information about the service job provider.

Name	Description	Schema
serviceJobProviderId optional	The identifier of the service job provider. Pattern : "^[A-Z0-9]<li>$"	string

Buyer

Information about the buyer.

Name	Description	Schema
buyerId optional	The identifier of the buyer. Pattern : "^[A-Z0-9]<li>$"	string
name optional	The name of the buyer.	string
phone optional	The phone number of the buyer.	string
isPrimeMember optional	When true, the service is for an Amazon Prime buyer.	boolean

AppointmentTime

The time of the appointment window.

Name	Description	Schema
startTime required	The date and time of the start of the appointment window, in ISO 8601 format.	string (date-time)
durationInMinutes required	The duration of the appointment window, in minutes. Minimum value : 1	integer

AppointmentId

The appointment identifier.

Type : string

minLength : 5
maxLength : 100

Appointment

The details of an appointment.

Name	Description	Schema
appointmentId optional	The appointment identifier.	AppointmentId
appointmentStatus optional	The status of the appointment.	enum (AppointmentStatus)
appointmentTime optional	The time of the appointment window.	AppointmentTime
assignedTechnicians optional	A list of technicians assigned to the service job.	< Technician > array
rescheduledAppointmentId optional	The identifier of a rescheduled appointment.	AppointmentId
poa optional	Proof of Appointment (POA) details.	Poa

Technician

A technician who is assigned to perform the service job in part or in full.

Name	Description	Schema
technicianId optional	The technician identifier. minLength : 1 maxLength : 50	string
name optional	The name of the technician.	string

Poa

Proof of Appointment (POA) details.

Name	Description	Schema
appointmentTime optional	The time of the appointment window.	AppointmentTime
technicians optional	A list of technicians.	< Technician > array
uploadingTechnician optional	The identifier of the technician who uploaded the POA. Pattern : "^[A-Z0-9]<li>$"	string
uploadTime optional	The date and time when the POA was uploaded, in ISO 8601 format.	string (date-time)
poaType optional	The type of POA uploaded.	enum (PoaType)

AssociatedItem

Information about an item associated with the service job.

Name	Description	Schema
asin optional	The Amazon Standard Identification Number (ASIN) of the item.	string
title optional	The title of the item.	string
quantity optional	The total number of items included in the order.	integer
orderId optional	The Amazon-defined identifier for an order placed by the buyer, in 3-7-7 format.	OrderId
itemStatus optional	The status of the item.	enum (ItemStatus)
brandName optional	The brand name of the item.	string
itemDelivery optional	Delivery information for the item.	ItemDelivery

ItemDelivery

Delivery information for the item.

Name	Description	Schema
estimatedDeliveryDate optional	The date and time of the latest Estimated Delivery Date (EDD) of all the items with an EDD. In ISO 8601 format.	string (date-time)
itemDeliveryPromise optional	Promised delivery information for the item.	ItemDeliveryPromise

ItemDeliveryPromise

Promised delivery information for the item.

Name	Description	Schema
startTime optional	The date and time of the start of the promised delivery window, in ISO 8601 format.	string (date-time)
endTime optional	The date and time of the end of the promised delivery window, in ISO 8601 format.	string (date-time)

ServiceLocation

Information about the location of the service job.

Name	Description	Schema
serviceLocationType optional	The location of the service job.	enum (ServiceLocationType)
address optional	The shipping address for the service job.	Address

Address

The shipping address for the service job.

Name	Description	Schema
name required	The name of the person, business, or institution.	string
addressLine1 required	The first line of the address.	string
addressLine2 optional	Additional address information, if required.	string
addressLine3 optional	Additional address information, if required.	string
city optional	The city.	string
county optional	The county.	string
district optional	The district.	string
stateOrRegion optional	The state or region.	string
postalCode optional	The postal code. This can contain letters, digits, spaces, and/or punctuation.	string
countryCode optional	The two digit country code, in ISO 3166-1 alpha-2 format.	string
phone optional	The phone number.	string

AddAppointmentRequest

Input for add appointment operation.

Name	Description	Schema
appointmentTime required	Input appointment time details.	AppointmentTimeInput

RescheduleAppointmentRequest

Input for rescheduled appointment operation.

Name	Description	Schema
appointmentTime required	Input appointment time details.	AppointmentTimeInput
rescheduleReasonCode required	Input appointment reschedule reason.	RescheduleReasonCode

AppointmentTimeInput

The input appointment time details.

Name	Description	Schema
startTime required	The date, time in UTC for the start time of an appointment in ISO 8601 format.	string (date-time)
durationInMinutes optional	The duration of an appointment in minutes.	integer

RescheduleReasonCode

Appointment reschedule reason code.

Type : string

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
code required	An error code that identifies the type of error that occurred.	string
message required	A message that describes the error condition in a human-readable form.	string
details optional	Additional details that can help the caller understand or fix the issue.	string
errorLevel optional	The type of error.	enum (ErrorLevel)

WarningList

A list of warnings returned in the sucessful execution response of an API request.

Type : < Warning > array

Warning

Warning returned when the request is successful but execution have some important callouts on basis of which API clients should take defined actions.

Name	Description	Schema
code required	An warning code that identifies the type of warning that occurred.	string
message required	A message that describes the warning condition in a human-readable form.	string
details optional	Additional details that can help the caller understand or address the warning.	string

UpdateScheduleResponse

Response schema for UpdateSchedule operation.

Name	Description	Schema
payload optional	Contains the UpdateScheduleRecords for which the error/warning has occurred.	< UpdateScheduleRecord > array
errors optional	Errors encountered, if any.	ErrorList

SetAppointmentFulfillmentDataRequest

Input for set appointment fulfillment data operation.

Name	Description	Schema
fulfillmentTime optional	Input appointment time details.	FulfillmentTime
appointmentResources optional	Resources involved in appointment fulfillment.	AppointmentResources
fulfillmentDocuments optional	Documents specific to appointment fulfillment.	FulfillmentDocuments

FulfillmentTime

Input for fulfillment time details

Name	Description	Schema
startTime optional	The date, time in UTC of the fulfillment start time in ISO 8601 format.	string (date-time)
endTime optional	The date, time in UTC of the fulfillment end time in ISO 8601 format.	string (date-time)

FulfillmentDocuments

List of documents captured during service appointment fulfillment.

Type : < FulfillmentDocument > array

FulfillmentDocument

Document that captured during service appointment fulfillment that portrays proof of completion

Name	Description	Schema
uploadDestinationId optional	The identifier of the upload destination. Get this value by calling the createServiceDocumentUploadDestination operation of the services API.	string
contentSha256 optional	Sha256 hash of the file content. This value is used to determine if the file has been corrupted or tampered with during transit.	string

AppointmentResources

List of resources that performs or performed job appointment fulfillment.

Type : < AppointmentResource > array

AppointmentResource

The resource that performs or performed appointment fulfillment.

Name	Description	Schema
resourceId optional	The resource identifier.	string

CreateReservationResponse

Response schema for CreateReservation operation.

Name	Description	Schema
payload optional	CreateReservationRecord contains only the new reservationId if the operation was successful. Otherwise it would contain the Reservation entity with warnings/errors.	CreateReservationRecord
errors optional	Errors encountered, if any.	ErrorList

UpdateReservationResponse

Response schema for the UpdateReservation operation.

Name	Description	Schema
payload optional	UpdateReservationRecord contains only the new reservationId if the operation was successful. Otherwise it would contain the Reservation entity with warnings/errors.	UpdateReservationRecord
errors optional	Errors encountered, if any.	ErrorList

CancelReservationResponse

Response schema for CancelReservation operation.

Name	Description	Schema
errors optional	Errors encountered, if any	ErrorList

DayOfWeek

The day of the week.

Type : enum

Value	Description
MONDAY	Monday
TUESDAY	Tuesday
WEDNESDAY	Wednesday
THURSDAY	Thursday
FRIDAY	Friday
SATURDAY	Saturday
SUNDAY	Sunday

Recurrence

Repeated occurrence of an event in a time range.

Name	Description	Schema
endTime required	End time of the recurrence.	string (date-time)
daysOfWeek optional	Days of the week when recurrence is valid. If the schedule is valid every Monday, input will contain a single item in the list - "MONDAY".	< DayOfWeek > array
daysOfMonth optional	Days of the month when recurrence is valid.	< integer > array

AvailabilityRecord

AvailabilityRecord to represent the capacity of a resource over a time range.

Name	Description	Schema
startTime required	Denotes the time from when the resource is available in a day, ISO-8601 format is followed.	string (date-time)
endTime required	Denotes the time till when the resource is available in a day, ISO-8601 format is followed.	string (date-time)
recurrence optional	Recurrence object containing the recurrence pattern of schedule.	Recurrence
capacity optional	Signifies the capacity of a resource which is available. Minimum value : 1	integer

AvailabilityRecords

List of AvailabilityRecords to represent the capacity of a resource over a time range.

Type : < AvailabilityRecord > array

Reservation

Reservation object reduces the capacity of a resource.

Name	Description	Schema
reservationId optional	Unique identifier for a reservation. If present, we treat it as an update reservation request and update the corresponding reservation. Otherwise, it's a new create reservation request.	string
type required	Type of reservation.	enum (Type)
availability required	AvailabilityRecord to represent the capacity of a resource over a time range.	AvailabilityRecord

Reservations

List of reservations.

Type : < Reservation > array

UpdateScheduleRecord

UpdateScheduleRecord entity contains the AvailabilityRecord if there is an error/warning while performing the requested operation on it.

Name	Description	Schema
availability optional	Availability record if the operation failed.	AvailabilityRecord
warnings optional	Warnings encountered, if any.	WarningList
errors optional	Errors encountered, if any.	ErrorList

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.

Name	Description	Schema
reservation optional	Reservation record if the operation failed. It will only contain the new reservationId if the operation is successful.	Reservation
warnings optional	Warnings encountered, if any.	WarningList
errors optional	Errors encountered, if any.	ErrorList

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.

Name	Description	Schema
reservation optional	Reservation record if the operation failed. It will only contain the new reservationId if the operation is successful.	Reservation
warnings optional	Warnings encountered, if any.	WarningList
errors optional	Errors encountered, if any.	ErrorList

UpdateScheduleRequest

Request schema for updateSchedule operation.

Name	Description	Schema
schedules required	List of schedule objects to define the normal working hours of a resource.	AvailabilityRecords

CreateReservationRequest

Request schema for CreateReservation operation.

Name	Description	Schema
resourceId required	Resource (store) Identifier.	string
reservation required	Reservation object to reduce the capacity of a resource.	Reservation

UpdateReservationRequest

Request schema for UpdateReservation operation.

Name	Description	Schema
resourceId required	Resource (store) Identifier.	string
reservation required	Reservation object to reduce the capacity of a resource.	Reservation

ServiceUploadDocument

Input for to be uploaded document.

Name	Description	Schema
contentType required	The content type of the to-be-uploaded file	enum (ContentType)
contentLength required	The content length of the to-be-uploaded file Minimum value : 1 Maximum value : 5242880	number (int64)
contentMD5 optional	An MD5 hash of the content to be submitted to the upload destination. This value is used to determine if the data has been corrupted or tampered with during transit. Pattern : "^[A-Za-z0-9\\\\+/]{22}={2}$"	string

CreateServiceDocumentUploadDestination

The response schema for the createServiceDocumentUploadDestination operation.

Name	Description	Schema
payload optional	Information about an upload destination.	ServiceDocumentUploadDestination
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

ServiceDocumentUploadDestination

Information about an upload destination.

Name	Description	Schema
uploadDestinationId required	The unique identifier to be used by APIs that reference the upload destination.	string
url required	The URL to which to upload the file.	string
encryptionDetails required	Encryption details for required client-side encryption and decryption of document contents.	EncryptionDetails
headers optional	The headers to include in the upload request.	object

EncryptionDetails

Encryption details for required client-side encryption and decryption of document contents.

Name	Description	Schema
standard required	The encryption standard required to encrypt or decrypt the document contents.	enum (Standard)
initializationVector required	The vector to encrypt or decrypt the document contents using Cipher Block Chaining (CBC).	string
key required	The encryption key used to encrypt or decrypt the document contents.	string

ServiceLocationType

The location of the service job.

Type : enum

Value	Description
IN_HOME	Indicates the service for the service job is performed at the customers home address.
IN_STORE	Indicates the service for the service job is performed at the service providers store.
ONLINE	Indicates the service for the service job is performed remotely.

ItemStatus

The status of the item.

Type : enum

Value	Description
ACTIVE	Indicates the item is yet to be shipped.
CANCELLED	Indicates the item has been cancelled.
SHIPPED	Indicates the item is shipped but not delivered.
DELIVERED	Indicates the item is delivered.

Type

Type of reservation.

Type : enum

Value	Description
APPOINTMENT	Reduce resource(store) capacity because of an appointment.
TRAVEL	Reduce resource(store) capacity because technician(s) are travelling.
VACATION	Reduce resource(store) capacity because technician(s) are on vacation.
BREAK	Reduce resource(store) capacity because technician(s) are on break.
TRAINING	Reduce resource(store) capacity because technician(s) are in training.

ContentType

The content type of the to-be-uploaded file

Type : enum

Value	Description
TIFF	To be uploaded POA is of type image/tiff.
JPG	To be uploaded POA is of type image/jpg.
PNG	To be uploaded POA is of type image/png.
JPEG	To be uploaded POA is of type image/jpeg.
GIF	To be uploaded POA is of type image/gif.
PDF	To be uploaded POA is of type application/pdf.

PoaType

The type of POA uploaded.

Type : enum

Value	Description
NO_SIGNATURE_DUMMY_POS	Indicates that the type of proof of appointment uploaded is a dummy signature.
CUSTOMER_SIGNATURE	Indicates that the type of proof of appointment uploaded is a customer signature.
DUMMY_RECEIPT	Indicates that the type of proof of appointment uploaded is a dummy receipt.
POA_RECEIPT	Indicates that the type of proof of appointment is a receipt.

SortOrder

Sort order for the query you want to perform.

Type : enum

Value	Description
ASC	Sort in ascending order.
DESC	Sort in descending order.

ErrorLevel

The type of error.

Type : enum

Value	Description
ERROR	Error
WARNING	Warning

SortField

Sort fields on which you want to sort the output.

Type : enum

Value	Description
JOB_DATE	Sort on job date.
JOB_STATUS	Sort on job status.

Standard

The encryption standard required to encrypt or decrypt the document contents.

Type : enum

Value	Description
AES	The Advanced Encryption Standard (AES).

AppointmentStatus

The status of the appointment.

Type : enum

Value	Description
ACTIVE	Indicates that an appointment is scheduled.
CANCELLED	Indicates that the appointment is cancelled.
COMPLETED	Indicates that the appointment is completed.

ServiceJobStatus

Type : enum

For use with the definition(s): ServiceJob The status of the service job.

Value	Description
NOT_SERVICED	Indicates that the service for the service job is not complete.
CANCELLED	Indicates that the service job is cancelled.
COMPLETED	Indicates that the service is performed and the service job is closed successfully.
PENDING_SCHEDULE	Indicates that an appointment for the service job has not been scheduled.
NOT_FULFILLABLE	Indicates that the service job is not actionable due to an unexpected exception.
HOLD	Indicates that the appointment time preference given by customer cannot be serviced by the service provider.
PAYMENT_DECLINED	Indicates that the customer payment has been declined.

For use with the operation(s): getServiceJobs

Value	Description
NOT_SERVICED	Jobs which are not serviced.
CANCELLED	Jobs which are cancelled.
COMPLETED	Jobs successfully completed.
PENDING_SCHEDULE	Jobs which are pending schedule.
NOT_FULFILLABLE	Jobs which are not fulfillable.
HOLD	Jobs which are on hold.
PAYMENT_DECLINED	Jobs for which payment was declined.