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.

Request

Query Params

serviceOrderIds

array[string]

optional

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

>= 1 items<= 20 items

serviceJobStatus

array[string]

optional

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

Allowed values:

NOT_SERVICEDCANCELLEDCOMPLETEDPENDING_SCHEDULENOT_FULFILLABLEHOLDPAYMENT_DECLINED

pageToken

string

optional

String returned in the response of your previous request.

pageSize

integer

optional

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

>= 1<= 20

Default:

sortField

enum<string>

optional

Sort fields on which you want to sort the output.

Allowed values:

JOB_DATEJOB_STATUS

sortOrder

enum<string>

optional

Sort order for the query you want to perform.

Allowed values:

ASCDESC

createdAfter

string

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.

createdBefore

string

optional

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

lastUpdatedAfter

string

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.

lastUpdatedBefore

string

optional

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

scheduleStartDate

string

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.

scheduleEndDate

string

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.

marketplaceIds

array[string]

required

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

<= 1 items

asins

array[string]

optional

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

>= 1 items<= 20 items

requiredSkills

array[string]

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.

>= 1 items<= 20 items

storeIds

array[string]

optional

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

>= 1 items<= 50 items

Responses

🟢200OK

application/json

Success response.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Response schema for the `getServiceJobs` operation.

payload

object (JobListing)

optional

The payload for the getServiceJobs operation.

totalResultSize

integer

optional

Total result size of the query result.

nextPageToken

string

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.

previousPageToken

string

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.

jobs

array[object (ServiceJob) {14}]

optional

List of job details for the given input.

errors

array[object (Error) {3}]

optional

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

code

string

required

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

message

string

required

A message that describes the error condition.

details

string

optional

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

Example

{
    "payload": {
        "totalResultSize": 0,
        "nextPageToken": "string",
        "previousPageToken": "string",
        "jobs": [
            {
                "createTime": "2019-08-24T14:15:22Z",
                "serviceJobId": "string",
                "serviceJobStatus": "NOT_SERVICED",
                "scopeOfWork": {
                    "asin": "string",
                    "title": "string",
                    "quantity": 0,
                    "requiredSkills": [
                        "string"
                    ]
                },
                "seller": {
                    "sellerId": "string"
                },
                "serviceJobProvider": {
                    "serviceJobProviderId": "string"
                },
                "preferredAppointmentTimes": [
                    {
                        "startTime": "2019-08-24T14:15:22Z",
                        "durationInMinutes": 1
                    }
                ],
                "appointments": [
                    {
                        "appointmentId": "string",
                        "appointmentStatus": "ACTIVE",
                        "appointmentTime": {
                            "startTime": "2019-08-24T14:15:22Z",
                            "durationInMinutes": 1
                        },
                        "assignedTechnicians": [
                            {
                                "technicianId": "string",
                                "name": "string"
                            }
                        ],
                        "rescheduledAppointmentId": "string",
                        "poa": {
                            "appointmentTime": {
                                "startTime": "2019-08-24T14:15:22Z",
                                "durationInMinutes": 1
                            },
                            "technicians": [
                                {
                                    "technicianId": "string",
                                    "name": "string"
                                }
                            ],
                            "uploadingTechnician": "string",
                            "uploadTime": "2019-08-24T14:15:22Z",
                            "poaType": "NO_SIGNATURE_DUMMY_POS"
                        }
                    }
                ],
                "serviceOrderId": "string",
                "marketplaceId": "string",
                "storeId": "string",
                "buyer": {
                    "buyerId": "string",
                    "name": "string",
                    "phone": "string",
                    "isPrimeMember": true
                },
                "associatedItems": [
                    {
                        "asin": "string",
                        "title": "string",
                        "quantity": 0,
                        "orderId": "string",
                        "itemStatus": "ACTIVE",
                        "brandName": "string",
                        "itemDelivery": {
                            "estimatedDeliveryDate": "2019-08-24T14:15:22Z",
                            "itemDeliveryPromise": {
                                "startTime": "2019-08-24T14:15:22Z",
                                "endTime": "2019-08-24T14:15:22Z"
                            }
                        }
                    }
                ],
                "serviceLocation": {
                    "serviceLocationType": "IN_HOME",
                    "address": {
                        "addressLine1": "address_1",
                        "addressLine2": "address_2",
                        "addressLine3": "address_3",
                        "city": "Seattle",
                        "countryCode": "US",
                        "county": "Washington",
                        "district": "District1",
                        "name": "address_name",
                        "phoneNumber": "+14155552671",
                        "postalCode": "123456",
                        "stateOrRegion": "Washington"
                    }
                }
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses