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.

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

The response schema for the `getServiceJobByServiceJobId` operation.

payload

object (ServiceJob)

optional

The job details of a service.

createTime

string <date-time>

optional

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

serviceJobId

string

optional

Amazon identifier for the service job.

>= 1 characters<= 100 characters

serviceJobStatus

enum<string>

optional

The status of the service job.

Allowed values:

NOT_SERVICEDCANCELLEDCOMPLETEDPENDING_SCHEDULENOT_FULFILLABLEHOLDPAYMENT_DECLINED

scopeOfWork

object (ScopeOfWork)

optional

The scope of work for the order.

seller

object (Seller)

optional

Information about the seller of the service job.

serviceJobProvider

object (ServiceJobProvider)

optional

Information about the service job provider.

preferredAppointmentTimes

array[object (AppointmentTime) {2}]

optional

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

appointments

array[object (Appointment) {6}]

optional

A list of appointments.

serviceOrderId

string

optional

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

>= 5 characters<= 20 characters

marketplaceId

string

optional

The marketplace identifier.

Match pattern:

^[A-Z0-9]*$

storeId

string

optional

The Amazon-defined identifier for the region scope.

>= 1 characters<= 100 characters

buyer

object (Buyer)

optional

Information about the buyer.

associatedItems

array[object (AssociatedItem) {7}]

optional

A list of items associated with the service job.

serviceLocation

object (ServiceLocation)

optional

Information about the location of the service job.

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": {
        "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

🟠422Parameter Error

🟠429429

🔴500Server Error

🔴503Service Unavailable

getServiceJobByServiceJobId

Request

Request samples

Responses