API docs by Redocly

Selling Partner API for Services (v1)

Download OpenAPI specification:Download

URL: https://sellercentral.amazon.com/gp/mws/contactus.html

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

service

getServiceJobByServiceJobId

Gets details of service job indicated by the provided serviceJobID.

Usage Plan:

Rate (requests per second) Burst
20 40

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

A service job identifier.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

cancelServiceJobByServiceJobId

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

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

An Amazon defined service job identifier.

query Parameters
cancellationReasonCode
required
string [ 1 .. 100 ] characters ^[A-Z0-9_]*$

A cancel reason code that specifies the reason for cancelling a service job.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

completeServiceJobByServiceJobId

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

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

An Amazon defined service job identifier.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getServiceJobs

Gets service job details for the specified filter query.

Usage Plan:

Rate (requests per second) Burst
10 40

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.

query Parameters
serviceOrderIds
Array of strings [ 1 .. 20 ] items

List of service order ids for the query you want to perform.Max values supported 20.

serviceJobStatus
Array of strings
Items Enum: "NOT_SERVICED" "CANCELLED" "COMPLETED" "PENDING_SCHEDULE" "NOT_FULFILLABLE" "HOLD" "PAYMENT_DECLINED"

A list of one or more job status by which to filter the list of jobs.

pageToken
string

String returned in the response of your previous request.

pageSize
integer <int32> [ 1 .. 20 ]
Default: 20

A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.

sortField
string
Enum: "JOB_DATE" "JOB_STATUS"

Sort fields on which you want to sort the output.

sortOrder
string
Enum: "ASC" "DESC"

Sort order for the query you want to perform.

createdAfter
string

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.

createdBefore
string

A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.

lastUpdatedAfter
string

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.

lastUpdatedBefore
string

A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.

scheduleStartDate
string

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.

scheduleEndDate
string

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.

marketplaceIds
required
Array of strings <= 1 items

Used to select jobs that were placed in the specified marketplaces.

asins
Array of strings [ 1 .. 20 ] items [ items = 10 characters ]

List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.

requiredSkills
Array of strings [ 1 .. 20 ] items [ items [ 1 .. 50 ] characters ]

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.

storeIds
Array of strings [ 1 .. 50 ] items [ items [ 1 .. 100 ] characters ]

List of Amazon-defined identifiers for the region scope. Max values supported is 50.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

addAppointmentForServiceJobByServiceJobId

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

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

An Amazon defined service job identifier.

Request Body schema: application/json

Add appointment operation input details.

required
object (AppointmentTimeInput)

The input appointment time details.

Responses

Request samples

Content type
application/json
{
  • "appointmentTime": {
    }
}

Response samples

Content type
application/json
{
  • "appointmentId": "string",
  • "warnings": [
    ],
  • "errors": [
    ]
}

rescheduleAppointmentForServiceJobByServiceJobId

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

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

An Amazon defined service job identifier.

appointmentId
required
string [ 1 .. 100 ] characters

An existing appointment identifier for the Service Job.

Request Body schema: application/json

Reschedule appointment operation input details.

required
object (AppointmentTimeInput)

The input appointment time details.

rescheduleReasonCode
required
string

The appointment reschedule reason code.

Responses

Request samples

Content type
application/json
{
  • "appointmentTime": {
    },
  • "rescheduleReasonCode": "string"
}

Response samples

Content type
application/json
{
  • "appointmentId": "string",
  • "warnings": [
    ],
  • "errors": [
    ]
}

assignAppointmentResources

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

Usage Plan:

Rate (requests per second) Burst
1 2

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

An Amazon-defined service job identifier. Get this value by calling the getServiceJobs operation of the Services API.

appointmentId
required
string [ 1 .. 100 ] characters

An Amazon-defined identifier of active service job appointment.

Request Body schema: application/json
required
Array of objects (AppointmentResource)

List of resources that performs or performed job appointment fulfillment.

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

setAppointmentFulfillmentData

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

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

An Amazon-defined service job identifier. Get this value by calling the getServiceJobs operation of the Services API.

appointmentId
required
string [ 1 .. 100 ] characters

An Amazon-defined identifier of active service job appointment.

Request Body schema: application/json

Appointment fulfillment data collection details.

object (FulfillmentTime)

Input for fulfillment time details

Array of objects (AppointmentResource)

List of resources that performs or performed job appointment fulfillment.

Array of objects (FulfillmentDocument)

List of documents captured during service appointment fulfillment.

Responses

Request samples

Content type
application/json
{
  • "fulfillmentTime": {
    },
  • "appointmentResources": [
    ],
  • "fulfillmentDocuments": [
    ]
}

Response samples

Content type
application/json
""

getRangeSlotCapacity

Provides capacity slots in a format similar to availability records.

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
resourceId
required
string [ 1 .. 100 ] characters

Resource Identifier.

query Parameters
marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace in which the resource operates.

nextPageToken
string

Next page token returned in the response of your previous request.

Request Body schema: application/json

Request body.

capacityTypes
Array of strings (CapacityType)
Items Enum: "SCHEDULED_CAPACITY" "AVAILABLE_CAPACITY" "ENCUMBERED_CAPACITY" "RESERVED_CAPACITY"

An array of capacity types which are being requested. Default value is [SCHEDULED_CAPACITY].

startDateTime
required
string <date-time>

Start date time from which the capacity slots are being requested in ISO 8601 format.

endDateTime
required
string <date-time>

End date time up to which the capacity slots are being requested in ISO 8601 format.

Responses

Request samples

Content type
application/json
{
  • "capacityTypes": [
    ],
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "resourceId": "string",
  • "capacities": [
    ],
  • "nextPageToken": "string"
}

getFixedSlotCapacity

Provides capacity in fixed-size slots.

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
resourceId
required
string [ 1 .. 100 ] characters

Resource Identifier.

query Parameters
marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace in which the resource operates.

nextPageToken
string

Next page token returned in the response of your previous request.

Request Body schema: application/json

Request body.

capacityTypes
Array of strings (CapacityType)
Items Enum: "SCHEDULED_CAPACITY" "AVAILABLE_CAPACITY" "ENCUMBERED_CAPACITY" "RESERVED_CAPACITY"

An array of capacity types which are being requested. Default value is [SCHEDULED_CAPACITY].

slotDuration
integer <int32> multiple of 5

Size in which slots are being requested. This value should be a multiple of 5 and fall in the range: 5 <= slotDuration <= 360.

startDateTime
required
string <date-time>

Start date time from which the capacity slots are being requested in ISO 8601 format.

endDateTime
required
string <date-time>

End date time up to which the capacity slots are being requested in ISO 8601 format.

Responses

Request samples

Content type
application/json
{
  • "capacityTypes": [
    ],
  • "slotDuration": 0,
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "resourceId": "string",
  • "slotDuration": 0,
  • "capacities": [
    ],
  • "nextPageToken": "string"
}

updateSchedule

Update the schedule of the given resource.

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
resourceId
required
string [ 1 .. 100 ] characters

Resource (store) Identifier

query Parameters
marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace in which the resource operates.

Request Body schema: application/json

Schedule details

required
Array of objects (AvailabilityRecord)

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

Responses

Request samples

Content type
application/json
{
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "payload": [
    ],
  • "errors": [
    ]
}

createReservation

Create a reservation.

Usage Plan:

Rate (requests per second) Burst
5 20

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.

query Parameters
marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace in which the resource operates.

Request Body schema: application/json

Reservation details

resourceId
required
string

Resource (store) identifier.

required
object (Reservation)

Reservation object reduces the capacity of a resource.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "string",
  • "reservation": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

updateReservation

Update a reservation.

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
reservationId
required
string [ 1 .. 100 ] characters

Reservation Identifier

query Parameters
marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace in which the resource operates.

Request Body schema: application/json

Reservation details

resourceId
required
string

Resource (store) identifier.

required
object (Reservation)

Reservation object reduces the capacity of a resource.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "string",
  • "reservation": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

cancelReservation

Cancel a reservation.

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
reservationId
required
string [ 1 .. 100 ] characters

Reservation Identifier

query Parameters
marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace in which the resource operates.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getAppointmmentSlotsByJobId

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

Usage Plan:

Rate (requests per second) Burst
5 20

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.

path Parameters
serviceJobId
required
string [ 1 .. 100 ] characters

A service job identifier to retrive appointment slots for associated service.

query Parameters
marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace in which the resource operates.

startTime
string

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.

endTime
string

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.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

getAppointmentSlots

Gets appointment slots as per the service context specified.

Usage Plan:

Rate (requests per second) Burst
20 40

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.

query Parameters
asin
required
string

ASIN associated with the service.

storeId
required
string [ 1 .. 100 ] characters

Store identifier defining the region scope to retrive appointment slots.

marketplaceIds
required
Array of strings <= 1 items

An identifier for the marketplace for which appointment slots are queried

startTime
string

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.

endTime
string

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.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}

createServiceDocumentUploadDestination

Creates an upload destination.

Usage Plan:

Rate (requests per second) Burst
5 20

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.

Request Body schema: application/json

Upload document operation input details.

contentType
required
string (ContentType)
Enum: "TIFF" "JPG" "PNG" "JPEG" "GIF" "PDF"

The content type of the to-be-uploaded file

contentLength
required
integer <int64> [ 1 .. 5242880 ]

The content length of the to-be-uploaded file

contentMD5
string^[A-Za-z0-9\\+/]{22}={2}$

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.

Responses

Request samples

Content type
application/json
{
  • "contentType": "TIFF",
  • "contentLength": 1,
  • "contentMD5": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "errors": [
    ]
}