HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

getServiceJobs

get https://sellingpartnerapi-na.amazon.com/service/v1/serviceJobs

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.

Query Params
serviceOrderIds
array of strings
length between 1 and 20

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

serviceOrderIds
serviceJobStatus
array of strings

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

Show Details
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.
serviceJobStatus
string

String returned in the response of your previous request.

integer
1 to 20
Defaults to 20

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

string

Sort fields on which you want to sort the output.

string

Sort order for the query you want to perform.

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.

string

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

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.

string

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

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.

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
array of strings
required
length ≤ 1

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

marketplaceIds*
asins
array of strings
length between 1 and 20

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

asins
requiredSkills
array of strings
length between 1 and 20

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.

requiredSkills
storeIds
array of strings
length between 1 and 50

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

storeIds
Responses

Response body
object
payload
object

The payload for the getServiceJobs operation.

integer

Total result size of the query result.

string

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

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.

jobs
array of objects

List of job details for the given input.

jobs
object
date-time

The date and time of the creation of the job in ISO 8601 format.

string
length between 1 and 100

Amazon identifier for the service job.

string

The status of the service job.

NOT_SERVICED CANCELLED COMPLETED PENDING_SCHEDULE NOT_FULFILLABLE HOLD PAYMENT_DECLINED

Show Details
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.
scopeOfWork
object

The scope of work for the order.

seller
object

Information about the seller of the service job.

serviceJobProvider
object

Information about the service job provider.

preferredAppointmentTimes
array of objects

A list of appointment windows preferred by the buyer. Included only if the buyer selected appointment windows when creating the order.

preferredAppointmentTimes
object
date-time
required

The date and time of the start of the appointment window in ISO 8601 format.

integer
required
≥ 1

The duration of the appointment window, in minutes.

appointments
array of objects

A list of appointments.

appointments
object
string
length between 5 and 100

The appointment identifier.

string

The status of the appointment.

ACTIVE CANCELLED COMPLETED

Show Details
ACTIVEIndicates that an appointment is scheduled.
CANCELLEDIndicates that the appointment is cancelled.
COMPLETEDIndicates that the appointment is completed.
appointmentTime
object

The time of the appointment window.

assignedTechnicians
array of objects
length ≥ 1

A list of technicians assigned to the service job.

assignedTechnicians
object
string
length between 1 and 50

The technician identifier.

string

The name of the technician.

string
length between 5 and 100

The appointment identifier.

poa
object

Proof of Appointment (POA) details.

string
length between 5 and 20

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

string

The marketplace identifier.

string
length between 1 and 100

The Amazon-defined identifier for the region scope.

buyer
object

Information about the buyer.

associatedItems
array of objects

A list of items associated with the service job.

associatedItems
object
string

The Amazon Standard Identification Number (ASIN) of the item.

string

The title of the item.

integer

The total number of items included in the order.

string
length between 5 and 20

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

string

The status of the item.

ACTIVE CANCELLED SHIPPED DELIVERED

Show Details
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.
string

The brand name of the item.

itemDelivery
object

Delivery information for the item.

serviceLocation
object

Information about the location of the service job.

errors
array of objects

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

errors
object
string
required

An error code that identifies the type of error that occurred.

string
required

A message that describes the error condition.

string

Additional details that can help the caller understand or fix the issue.

string

The type of error.

ERROR WARNING

Show Details
ERRORError
WARNINGWarning
Headers
object
string

Your rate limit (requests per second) for this operation.

string

Unique request reference identifier.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?