Services API v1 reference

Help service providers get and modify their service orders.

Overview

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

Version information

Version : v1

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getServiceJobByServiceJobId
cancelServiceJobByServiceJobId
completeServiceJobByServiceJobId
getServiceJobs
addAppointmentForServiceJobByServiceJobId
rescheduleAppointmentForServiceJobByServiceJobId
assignAppointmentResources
setAppointmentFulfillmentData
getRangeSlotCapacity
getFixedSlotCapacity
updateSchedule
createReservation
updateReservation
cancelReservation
getAppointmmentSlotsByJobId
getAppointmentSlots
createServiceDocumentUploadDestination

Paths

GET /service/v1/serviceJobs/{serviceJobId}

Operation: getServiceJobByServiceJobId

Description

Gets details of service job indicated by the provided serviceJobID.

Usage Plan:

Rate (requests per second)Burst
2040

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
A service job identifier.
minLength : 1
maxLength : 100
string

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
500An 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse

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

Operation: cancelServiceJobByServiceJobId

Description

Cancels the service job indicated by the service job identifier specified.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
An Amazon defined service job identifier.
minLength : 1
maxLength : 100
string
QuerycancellationReasonCode
required
A cancel reason code that specifies the reason for cancelling a service job.
minLength : 1
maxLength : 100
string

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelServiceJobByServiceJobIdResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelServiceJobByServiceJobIdResponse
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelServiceJobByServiceJobIdResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelServiceJobByServiceJobIdResponse
500An 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelServiceJobByServiceJobIdResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelServiceJobByServiceJobIdResponse

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

Operation: completeServiceJobByServiceJobId

Description

Completes the service job indicated by the service job identifier specified.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
An Amazon defined service job identifier.
minLength : 1
maxLength : 100
string

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CompleteServiceJobByServiceJobIdResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CompleteServiceJobByServiceJobIdResponse
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CompleteServiceJobByServiceJobIdResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CompleteServiceJobByServiceJobIdResponse
500An 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CompleteServiceJobByServiceJobIdResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CompleteServiceJobByServiceJobIdResponse

GET /service/v1/serviceJobs

Operation: getServiceJobs

Description

Gets service job details for the specified filter query.

Usage Plan:

Rate (requests per second)Burst
1040

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchemaDefault
QueryserviceOrderIds
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-
QueryserviceJobStatus
optional
A list of one or more job status by which to filter the list of jobs.< enum (ServiceJobStatus) > array-
QuerypageToken
optional
String returned in the response of your previous request.string-
QuerypageSize
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
integer20
QuerysortField
optional
Sort fields on which you want to sort the output.enum (SortField)-
QuerysortOrder
optional
Sort order for the query you want to perform.enum (SortOrder)-
QuerycreatedAfter
optional
A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error.string-
QuerycreatedBefore
optional
A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.string-
QuerylastUpdatedAfter
optional
A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if createdAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error.string-
QuerylastUpdatedBefore
optional
A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.string-
QueryscheduleStartDate
optional
A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.string-
QueryscheduleEndDate
optional
A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.string-
QuerymarketplaceIds
required
Used to select jobs that were placed in the specified marketplaces.
Max count : 1
< string > array-
Queryasins
optional
List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.

Min count : 1
Max count : 20
< string > array-
QueryrequiredSkills
optional
A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.

Min count : 1
Max count : 20
< string > array-
QuerystoreIds
optional
List of Amazon-defined identifiers for the region scope. Max values supported is 50.

Min count : 1
Max count : 50
< string > array-

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobsResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobsResponse
500An 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobsResponse

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

Operation: addAppointmentForServiceJobByServiceJobId

Description

Adds an appointment to the service job indicated by the service job identifier specified.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
An Amazon defined service job identifier.
minLength : 1
maxLength : 100
string
Bodybody
required
Add appointment operation input details.AddAppointmentRequest

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
500Encountered 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse

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

Operation: rescheduleAppointmentForServiceJobByServiceJobId

Description

Reschedules an appointment for the service job indicated by the service job identifier specified.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
An Amazon defined service job identifier.
minLength : 1
maxLength : 100
string
PathappointmentId
required
An existing appointment identifier for the Service Job.
minLength : 1
maxLength : 100
string
Bodybody
required
Reschedule appointment operation input details.RescheduleAppointmentRequest

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
500Encountered 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse

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

Operation: assignAppointmentResources

Description

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

Usage Plan:

Rate (requests per second)Burst
12

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
An Amazon-defined service job identifier. Get this value by calling the getServiceJobs operation of the Services API.
minLength : 1
maxLength : 100
string
PathappointmentId
required
An Amazon-defined identifier of active service job appointment.
minLength : 1
maxLength : 100
string
Bodybody
required
Request schema for the assignAppointmentResources operation.AssignAppointmentResourcesRequest

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse
500An 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse

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

Operation: setAppointmentFulfillmentData

Description

Updates the appointment fulfillment data related to a given jobID and appointmentID.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
An Amazon-defined service job identifier. Get this value by calling the getServiceJobs operation of the Services API.
minLength : 1
maxLength : 100
string
PathappointmentId
required
An Amazon-defined identifier of active service job appointment.
minLength : 1
maxLength : 100
string
Bodybody
required
Appointment fulfillment data collection details.SetAppointmentFulfillmentDataRequest

Responses

HTTP CodeDescriptionSchema
204Success 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
400Request 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
403403 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
ErrorList
415The 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
ErrorList
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
ErrorList
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
ErrorList
500Encountered 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
ErrorList
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
ErrorList

POST /service/v1/serviceResources/{resourceId}/capacity/range

Operation: getRangeSlotCapacity

Description

Provides capacity slots in a format similar to availability records.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathresourceId
required
Resource Identifier.
minLength : 1
maxLength : 100
string
Bodybody
required
Request body.RangeSlotCapacityQuery
QuerymarketplaceIds
required
An identifier for the marketplace in which the resource operates.
Max count : 1
< string > array
QuerynextPageToken
optional
Next page token returned in the response of your previous request.string

Responses

HTTP CodeDescriptionSchema
200Success response.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
RangeSlotCapacity
400Request 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.
RangeSlotCapacityErrors
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
RangeSlotCapacityErrors
403Indicates 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.
RangeSlotCapacityErrors
404The 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.
RangeSlotCapacityErrors
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
RangeSlotCapacityErrors
415The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
RangeSlotCapacityErrors
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
RangeSlotCapacityErrors
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
RangeSlotCapacityErrors
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
RangeSlotCapacityErrors

POST /service/v1/serviceResources/{resourceId}/capacity/fixed

Operation: getFixedSlotCapacity

Description

Provides capacity in fixed-size slots.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathresourceId
required
Resource Identifier.
minLength : 1
maxLength : 100
string
Bodybody
required
Request body.FixedSlotCapacityQuery
QuerymarketplaceIds
required
An identifier for the marketplace in which the resource operates.
Max count : 1
< string > array
QuerynextPageToken
optional
Next page token returned in the response of your previous request.string

Responses

HTTP CodeDescriptionSchema
200Success response.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
FixedSlotCapacity
400Request 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.
FixedSlotCapacityErrors
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
FixedSlotCapacityErrors
403Indicates 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.
FixedSlotCapacityErrors
404The 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.
FixedSlotCapacityErrors
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
FixedSlotCapacityErrors
415The request payload is in an unsupported format.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
FixedSlotCapacityErrors
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
FixedSlotCapacityErrors
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
FixedSlotCapacityErrors
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
FixedSlotCapacityErrors

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

Operation: updateSchedule

Description

Update the schedule of the given resource.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathresourceId
required
Resource (store) Identifier
minLength : 1
maxLength : 100
string
Bodybody
required
Schedule detailsUpdateScheduleRequest
QuerymarketplaceIds
required
An identifier for the marketplace in which the resource operates.
Max count : 1
< string > array

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateScheduleResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateScheduleResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateScheduleResponse
500Encountered 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateScheduleResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateScheduleResponse

POST /service/v1/reservation

Operation: createReservation

Description

Create a reservation.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
Bodybody
required
Reservation detailsCreateReservationRequest
QuerymarketplaceIds
required
An identifier for the marketplace in which the resource operates.
Max count : 1
< string > array

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReservationResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReservationResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReservationResponse
500Encountered 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReservationResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReservationResponse

PUT /service/v1/reservation/{reservationId}

Operation: updateReservation

Description

Update a reservation.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathreservationId
required
Reservation Identifier
minLength : 1
maxLength : 100
string
Bodybody
required
Reservation detailsUpdateReservationRequest
QuerymarketplaceIds
required
An identifier for the marketplace in which the resource operates.
Max count : 1
< string > array

Responses

HTTP CodeDescriptionSchema
200Success 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateReservationResponse
415The request payload is in an unsupported format.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateReservationResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateReservationResponse
500Encountered 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateReservationResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateReservationResponse

DELETE /service/v1/reservation/{reservationId}

Operation: cancelReservation

Description

Cancel a reservation.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathreservationId
required
Reservation Identifier
minLength : 1
maxLength : 100
string
QuerymarketplaceIds
required
An identifier for the marketplace in which the resource operates.
Max count : 1
< string > array

Responses

HTTP CodeDescriptionSchema
204Success 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
400Request 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
403403 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse
415The 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse
500Encountered 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse

GET /service/v1/serviceJobs/{serviceJobId}/appointmentSlots

Operation: getAppointmmentSlotsByJobId

Description

Gets appointment slots for the service associated with the service job id specified.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathserviceJobId
required
A service job identifier to retrive appointment slots for associated service.
minLength : 1
maxLength : 100
string
QuerymarketplaceIds
required
An identifier for the marketplace in which the resource operates.
Max count : 1
< string > array
QuerystartTime
optional
A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If startTime is provided, endTime should also be provided. Default value is as per business configuration.string
QueryendTime
optional
A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If endTime is provided, startTime should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.string

Responses

HTTP CodeDescriptionSchema
200Success response.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAppointmentSlotsResponse
400Request 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.
GetAppointmentSlotsResponse
403Indicates 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.
GetAppointmentSlotsResponse
404The 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.
GetAppointmentSlotsResponse
415The 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.
GetAppointmentSlotsResponse
422Unprocessable 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.
GetAppointmentSlotsResponse
429The 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.
GetAppointmentSlotsResponse
500An 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.
GetAppointmentSlotsResponse
503Temporary 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.
GetAppointmentSlotsResponse

GET /service/v1/appointmentSlots

Operation: getAppointmentSlots

Description

Gets appointment slots as per the service context specified.

Usage Plan:

Rate (requests per second)Burst
2040

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
Queryasin
required
ASIN associated with the service.string
QuerystoreId
required
Store identifier defining the region scope to retrive appointment slots.
minLength : 1
maxLength : 100
string
QuerymarketplaceIds
required
An identifier for the marketplace for which appointment slots are queried
Max count : 1
< string > array
QuerystartTime
optional
A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If startTime is provided, endTime should also be provided. Default value is as per business configuration.string
QueryendTime
optional
A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If endTime is provided, startTime should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.string

Responses

HTTP CodeDescriptionSchema
200Success response.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetAppointmentSlotsResponse
400Request 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.
GetAppointmentSlotsResponse
403Indicates 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.
GetAppointmentSlotsResponse
404The 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.
GetAppointmentSlotsResponse
415The 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.
GetAppointmentSlotsResponse
422Unprocessable 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.
GetAppointmentSlotsResponse
429The 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.
GetAppointmentSlotsResponse
500An 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.
GetAppointmentSlotsResponse
503Temporary 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.
GetAppointmentSlotsResponse

POST /service/v1/documents

Operation: createServiceDocumentUploadDestination

Description

Creates an upload destination.

Usage Plan:

Rate (requests per second)Burst
520

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
Bodybody
required
Upload document operation input details.ServiceUploadDocument

Responses

HTTP CodeDescriptionSchema
200Successfully 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
400Request 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
403Indicates 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
404The 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
413The request size exceeded the maximum accepted size.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CreateServiceDocumentUploadDestination
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-requestid (string) : Unique request reference identifier.
CreateServiceDocumentUploadDestination
422Unprocessable Entity. Unable to process the contained instructions.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateServiceDocumentUploadDestination
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-requestid (string) : Unique request reference ID.
CreateServiceDocumentUploadDestination
500An 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.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateServiceDocumentUploadDestination
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CreateServiceDocumentUploadDestination

Definitions

GetServiceJobByServiceJobIdResponse

The response schema for the getServiceJobByServiceJobId operation.

NameDescriptionSchema
payload
optional
The payload for the getServiceJobByServiceJobId operation.ServiceJob
errors
optional
An unexpected condition occurred during the getServiceJobByServiceJobId operation.ErrorList

CancelServiceJobByServiceJobIdResponse

Response schema for the cancelServiceJobByServiceJobId operation.

NameDescriptionSchema
errors
optional
Encountered errors for the cancelServiceJobByServiceJobId operation.ErrorList

CompleteServiceJobByServiceJobIdResponse

Response schema for the completeServiceJobByServiceJobId operation.

NameDescriptionSchema
errors
optional
Encountered errors for the completeServiceJobByServiceJobId operation.ErrorList

GetServiceJobsResponse

Response schema for the getServiceJobs operation.

NameDescriptionSchema
payload
optional
The payload for the getServiceJobs operation.JobListing
errors
optional
An unexpected condition occurred during the getServiceJobs operation.ErrorList

SetAppointmentResponse

Response schema for the addAppointmentForServiceJobByServiceJobId and rescheduleAppointmentForServiceJobByServiceJobId operations.

NameDescriptionSchema
appointmentId
optional
New appointment identifier generated during the addAppointmentForServiceJobByServiceJobId or rescheduleAppointmentForServiceJobByServiceJobId operations.AppointmentId
warnings
optional
Warnings generated during the addAppointmentForServiceJobByServiceJobId or rescheduleAppointmentForServiceJobByServiceJobId operations.WarningList
errors
optional
Errors occurred during during the addAppointmentForServiceJobByServiceJobId or rescheduleAppointmentForServiceJobByServiceJobId operations.ErrorList

AssignAppointmentResourcesResponse

Response schema for the assignAppointmentResources operation.

NameDescriptionSchema
payload
optional
The payload for the assignAppointmentResource operation.payload
errors
optional
Errors occurred during during the assignAppointmentResources operation.ErrorList


payload

NameDescriptionSchema
warnings
optional
Warnings generated during the assignAppointmentResources operation.WarningList

AssignAppointmentResourcesRequest

Request schema for the assignAppointmentResources operation.

NameDescriptionSchema
resources
required
List of resource objects to be assigned.AppointmentResources

JobListing

The payload for the getServiceJobs operation.

NameDescriptionSchema
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.

NameDescriptionSchema
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
storeId
optional
The Amazon-defined identifier for the region scope.
minLength : 1
maxLength : 100
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.

NameDescriptionSchema
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.

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

ServiceJobProvider

Information about the service job provider.

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

Buyer

Information about the buyer.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
technicianId
optional
The technician identifier.
minLength : 1
maxLength : 50
string
name
optional
The name of the technician.string

Poa

Proof of Appointment (POA) details.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
appointmentTime
required
Input appointment time details.AppointmentTimeInput

RescheduleAppointmentRequest

Input for rescheduled appointment operation.

NameDescriptionSchema
appointmentTime
required
Input appointment time details.AppointmentTimeInput
rescheduleReasonCode
required
Input appointment reschedule reason.RescheduleReasonCode

AppointmentTimeInput

The input appointment time details.

NameDescriptionSchema
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

The 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.

NameDescriptionSchema
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 there are important callouts based on which API clients should take defined actions.

NameDescriptionSchema
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

RangeSlotCapacityErrors

The error response schema for the getRangeSlotCapacity operation.

NameDescriptionSchema
errors
optional
Errors encountered during the getRangeSlotCapacity operation.ErrorList

RangeSlotCapacity

Response schema for the getRangeSlotCapacity operation.

NameDescriptionSchema
resourceId
optional
Resource Identifier.string
capacities
optional
Array of range capacities where each entry is for a specific capacity type.< RangeCapacity > array
nextPageToken
optional
Next page token, if there are more pages.string

RangeCapacity

Range capacity entity where each entry has a capacity type and corresponding slots.

NameDescriptionSchema
capacityType
optional
Capacity type corresponding to the slots.CapacityType
slots
optional
Array of capacity slots in range slot format.< RangeSlot > array

RangeSlot

Capacity slots represented in a format similar to availability rules.

NameDescriptionSchema
startDateTime
optional
Start date time of slot in ISO 8601 format with precision of seconds.string (date-time)
endDateTime
optional
End date time of slot in ISO 8601 format with precision of seconds.string (date-time)
capacity
optional
Capacity of the slot.integer (int32)

FixedSlotCapacityErrors

The error response schema for the getFixedSlotCapacity operation.

NameDescriptionSchema
errors
optional
Errors encountered during the getFixedSlotCapacity operation.ErrorList

FixedSlotCapacity

Response schema for the getFixedSlotCapacity operation.

NameDescriptionSchema
resourceId
optional
Resource Identifier.string
slotDuration
optional
The duration of each slot which is returned. This value will be a multiple of 5 and fall in the following range: 5 <= slotDuration <= 360.number (int32)
capacities
optional
Array of capacity slots in fixed slot format.< FixedSlot > array
nextPageToken
optional
Next page token, if there are more pages.string

FixedSlot

In this slot format each slot only has the requested capacity types. This slot size is as specified by slot duration.

NameDescriptionSchema
startDateTime
optional
Start date time of slot in ISO 8601 format with precision of seconds.string (date-time)
scheduledCapacity
optional
Scheduled capacity corresponding to the slot. This capacity represents the originally allocated capacity as per resource schedule.integer (int32)
availableCapacity
optional
Available capacity corresponding to the slot. This capacity represents the capacity available for allocation to reservations.integer (int32)
encumberedCapacity
optional
Encumbered capacity corresponding to the slot. This capacity represents the capacity allocated for Amazon Jobs/Appointments/Orders.integer (int32)
reservedCapacity
optional
Reserved capacity corresponding to the slot. This capacity represents the capacity made unavailable due to events like Breaks/Leaves/Lunch.integer (int32)

UpdateScheduleResponse

Response schema for the updateSchedule operation.

NameDescriptionSchema
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.

NameDescriptionSchema
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

NameDescriptionSchema
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

NameDescriptionSchema
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.

NameDescriptionSchema
resourceId
optional
The resource identifier.string

CreateReservationResponse

Response schema for the createReservation operation.

NameDescriptionSchema
payload
optional
CreateReservationRecord contains only the new reservationId if the operation was successful. Otherwise it will contain the reservation entity with warnings/errors.CreateReservationRecord
errors
optional
Errors encountered, if any.ErrorList

UpdateReservationResponse

Response schema for the updateReservation operation.

NameDescriptionSchema
payload
optional
UpdateReservationRecord contains only the new reservationId if the operation was successful. Otherwise it will contain the reservation entity with warnings/errors.UpdateReservationRecord
errors
optional
Errors encountered, if any.ErrorList

CancelReservationResponse

Response schema for the cancelReservation operation.

NameDescriptionSchema
errors
optional
Errors encountered, if anyErrorList

DayOfWeek

The day of the week.

Type : enum

ValueDescription
MONDAYMonday.
TUESDAYTuesday.
WEDNESDAYWednesday.
THURSDAYThursday.
FRIDAYFriday.
SATURDAYSaturday.
SUNDAYSunday.

Recurrence

Repeated occurrence of an event in a time range.

NameDescriptionSchema
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 only contain MONDAY in the list.< 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.

NameDescriptionSchema
startTime
required
Denotes the time from when the resource is available in a day in ISO-8601 format.string (date-time)
endTime
required
Denotes the time till when the resource is available in a day in ISO-8601 format.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.

NameDescriptionSchema
reservationId
optional
Unique identifier for a reservation. If present, it is treated as an update reservation request and will update the corresponding reservation. Otherwise, it is treated as 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

UpdateScheduleRecord

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

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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

RangeSlotCapacityQuery

Request schema for the getRangeSlotCapacity operation. This schema is used to define the time range and capacity types that are being queried.

NameDescriptionSchema
capacityTypes
optional
An array of capacity types which are being requested. Default value is [SCHEDULED_CAPACITY].< CapacityType > array
startDateTime
required
Start date time from which the capacity slots are being requested in ISO 8601 format.string (date-time)
endDateTime
required
End date time up to which the capacity slots are being requested in ISO 8601 format.string (date-time)

FixedSlotCapacityQuery

Request schema for the getFixedSlotCapacity operation. This schema is used to define the time range, capacity types and slot duration which are being queried.

NameDescriptionSchema
capacityTypes
optional
An array of capacity types which are being requested. Default value is [SCHEDULED_CAPACITY].< CapacityType > array
slotDuration
optional
Size in which slots are being requested. This value should be a multiple of 5 and fall in the range: 5 <= slotDuration <= 360.number (int32)
startDateTime
required
Start date time from which the capacity slots are being requested in ISO 8601 format.string (date-time)
endDateTime
required
End date time up to which the capacity slots are being requested in ISO 8601 format.string (date-time)

UpdateScheduleRequest

Request schema for the updateSchedule operation.

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

CapacityType

Type of capacity

Type : enum

ValueDescription
SCHEDULED_CAPACITYThis capacity represents the originally allocated capacity as per resource schedule.
AVAILABLE_CAPACITYThis capacity represents the capacity available for allocation to reservations.
ENCUMBERED_CAPACITYThis capacity represents the capacity allocated for Amazon Jobs/Appointments/Orders.
RESERVED_CAPACITYThis capacity represents the capacity made unavailable due to events like Breaks/Leaves/Lunch.

CreateReservationRequest

Request schema for the createReservation operation.

NameDescriptionSchema
resourceId
required
Resource (store) identifier.string
reservation
required
Reservation object to reduce the capacity of a resource.Reservation

UpdateReservationRequest

Request schema for the updateReservation operation.

NameDescriptionSchema
resourceId
required
Resource (store) identifier.string
reservation
required
Reservation object to reduce the capacity of a resource.Reservation

GetAppointmentSlotsResponse

The response of fetching appointment slots based on service context.

NameDescriptionSchema
payload
optional
The appointment slots fetched based on service context.AppointmentSlotReport
errors
optional
Errors occurred in getting schedule.ErrorList

AppointmentSlotReport

Availability information as per the service context queried.

NameDescriptionSchema
schedulingType
optional
Defines the type of slots.enum (SchedulingType)
startTime
optional
Start Time from which the appointment slots are generated in ISO 8601 format.string (date-time)
endTime
optional
End Time up to which the appointment slots are generated in ISO 8601 format.string (date-time)
appointmentSlots
optional
A list of time windows along with associated capacity in which the service can be performed.< AppointmentSlot > array

AppointmentSlot

A time window along with associated capacity in which the service can be performed.

NameDescriptionSchema
startTime
optional
Time window start time in ISO 8601 format.string (date-time)
endTime
optional
Time window end time in ISO 8601 format.string (date-time)
capacity
optional
Number of resources for which a slot can be reserved.
Minimum value : 0
integer

ServiceUploadDocument

Input for to be uploaded document.

NameDescriptionSchema
contentType
required
The content type of the to-be-uploaded fileenum (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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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

ValueDescription
IN_HOMEIndicates the service for the service job is performed at the customers home address.
IN_STOREIndicates the service for the service job is performed at the service providers store.
ONLINEIndicates the service for the service job is performed remotely.

ItemStatus

The status of the item.

Type : enum

ValueDescription
ACTIVEIndicates the item is yet to be shipped.
CANCELLEDIndicates the item has been cancelled.
SHIPPEDIndicates the item is shipped but not delivered.
DELIVEREDIndicates the item is delivered.

Type

Type of reservation.

Type : enum

ValueDescription
APPOINTMENTReduce resource (store) capacity because of an appointment.
TRAVELReduce resource (store) capacity because technician(s) are travelling.
VACATIONReduce resource (store) capacity because technician(s) are on vacation.
BREAKReduce resource (store) capacity because technician(s) are on break.
TRAININGReduce resource (store) capacity because technician(s) are in training.

ContentType

The content type of the to-be-uploaded file

Type : enum

ValueDescription
TIFFTo be uploaded POA is of type image/tiff.
JPGTo be uploaded POA is of type image/jpg.
PNGTo be uploaded POA is of type image/png.
JPEGTo be uploaded POA is of type image/jpeg.
GIFTo be uploaded POA is of type image/gif.
PDFTo be uploaded POA is of type application/pdf.

PoaType

The type of POA uploaded.

Type : enum

ValueDescription
NO_SIGNATURE_DUMMY_POSIndicates that the type of proof of appointment uploaded is a dummy signature.
CUSTOMER_SIGNATUREIndicates that the type of proof of appointment uploaded is a customer signature.
DUMMY_RECEIPTIndicates that the type of proof of appointment uploaded is a dummy receipt.
POA_RECEIPTIndicates that the type of proof of appointment is a receipt.

SchedulingType

Defines the type of slots.

Type : enum

ValueDescription
REAL_TIME_SCHEDULINGThe slots provided are backed by inventory in inventory management system.
NON_REAL_TIME_SCHEDULINGThe slots provided are based on working hours defined in seller management system.

SortOrder

Sort order for the query you want to perform.

Type : enum

ValueDescription
ASCSort in ascending order.
DESCSort in descending order.

ErrorLevel

The type of error.

Type : enum

ValueDescription
ERRORError
WARNINGWarning

SortField

Sort fields on which you want to sort the output.

Type : enum

ValueDescription
JOB_DATESort on job date.
JOB_STATUSSort on job status.

Standard

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

Type : enum

ValueDescription
AESThe Advanced Encryption Standard (AES).

AppointmentStatus

The status of the appointment.

Type : enum

ValueDescription
ACTIVEIndicates that an appointment is scheduled.
CANCELLEDIndicates that the appointment is cancelled.
COMPLETEDIndicates that the appointment is completed.

ServiceJobStatus

Type : enum

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

ValueDescription
NOT_SERVICEDIndicates that the service for the service job is not complete.
CANCELLEDIndicates that the service job is cancelled.
COMPLETEDIndicates that the service is performed and the service job is closed successfully.
PENDING_SCHEDULEIndicates that an appointment for the service job has not been scheduled.
NOT_FULFILLABLEIndicates that the service job is not actionable due to an unexpected exception.
HOLDIndicates that the appointment time preference given by customer cannot be serviced by the service provider.
PAYMENT_DECLINEDIndicates that the customer payment has been declined.

For use with the operation(s): getServiceJobs

ValueDescription
NOT_SERVICEDJobs which are not serviced.
CANCELLEDJobs which are cancelled.
COMPLETEDJobs successfully completed.
PENDING_SCHEDULEJobs which are pending schedule.
NOT_FULFILLABLEJobs which are not fulfillable.
HOLDJobs which are on hold.
PAYMENT_DECLINEDJobs for which payment was declined.

Did this page help you?