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.

Request

Path Params

serviceJobId

string

required

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

>= 1 characters<= 100 characters

Query Params

marketplaceIds

array[string]

required

An identifier for the marketplace in which the resource operates.

<= 1 items

startTime

string

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.

endTime

string

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.

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 of fetching appointment slots based on service context.

payload

object (AppointmentSlotReport)

optional

Availability information as per the service context queried.

schedulingType

enum<string>

optional

Defines the type of slots.

Allowed values:

REAL_TIME_SCHEDULINGNON_REAL_TIME_SCHEDULING

startTime

string <date-time>

optional

Start Time from which the appointment slots are generated in ISO 8601 format.

endTime

string <date-time>

optional

End Time up to which the appointment slots are generated in ISO 8601 format.

appointmentSlots

array[object (AppointmentSlot) {2}]

optional

A list of time windows along with associated capacity in which the service can be performed.

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": {
        "schedulingType": "REAL_TIME_SCHEDULING",
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "appointmentSlots": [
            {
                "slotId": "stringstringstringstringstringstringst",
                "slotTime": {
                    "endTime": "2019-08-24T14:15:22Z",
                    "startTime": "2019-08-24T14:15:22Z"
                }
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠422Parameter Error

🟠429429

🔴500Server Error

🔴503Service Unavailable

getAppointmmentSlotsByJobId

Request

Request samples

Responses