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.

Request

Path Params

serviceJobId

string

required

An Amazon defined service job identifier.

>= 1 characters<= 100 characters

Body Params application/json

Input for add appointment operation.

appointmentTime

object (AppointmentTimeInput)

required

The input appointment time details.

startTime

string <date-time>

required

The date, time in UTC for the start time of an appointment in ISO 8601 format.

durationInMinutes

integer

optional

The duration of an appointment in minutes.

Example

{
    "appointmentTime": {
        "startTime": "2019-08-24T14:15:22Z",
        "durationInMinutes": 0
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 `addAppointmentForServiceJobByServiceJobId` and `rescheduleAppointmentForServiceJobByServiceJobId` operations.

appointmentId

string

optional

The appointment identifier.

>= 5 characters<= 100 characters

warnings

array[object (Warning) {3}]

optional

A list of warnings returned in the sucessful execution response of an API request.

code

string

required

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

message

string

required

A message that describes the warning condition in a human-readable form.

details

string

optional

Additional details that can help the caller understand or address the warning.

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

{
    "appointmentId": "string",
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠422Parameter Error

🟠429429

🔴500Server Error

🔴503Service Unavailable