createReservation - Amazon SP API

Create a reservation.

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

Query Params

marketplaceIds

array[string]

required

An identifier for the marketplace in which the resource operates.

<= 1 items

Body Params application/json

Request schema for the `createReservation` operation.

resourceId

string

required

Resource (store) identifier.

reservation

object (Reservation)

required

Reservation object reduces the capacity of a resource.

reservationId

string

optional

Unique identifier for a reservation. If present, it is treated as an update reservation request and will update the corresponding reservation. Otherwise, it is treated as a new create reservation request.

type

enum<string>

required

Type of reservation.

Allowed values:

APPOINTMENTTRAVELVACATIONBREAKTRAINING

availability

object (AvailabilityRecord)

required

AvailabilityRecord to represent the capacity of a resource over a time range.

Example

{
    "resourceId": "string",
    "reservation": {
        "reservationId": "string",
        "type": "APPOINTMENT",
        "availability": {
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "recurrence": {
                "endTime": "2019-08-24T14:15:22Z",
                "daysOfWeek": [
                    "MONDAY"
                ],
                "daysOfMonth": [
                    1
                ]
            },
            "capacity": 1
        }
    }
}

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 `createReservation` operation.

payload

object (CreateReservationRecord)

optional

CreateReservationRecord entity contains the Reservation if there is an error/warning while performing the requested operation on it, otherwise it will contain the new reservationId.

reservation

object (Reservation)

optional

Reservation object reduces the capacity of a resource.

warnings

array[object (Warning) {3}]

optional

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

errors

array[object (Error) {3}]

optional

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

errors

array[object (Error) {3}]

optional

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

Example

{
    "payload": {
        "reservation": {
            "reservationId": "string",
            "type": "APPOINTMENT",
            "availability": {
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "recurrence": {
                    "endTime": "2019-08-24T14:15:22Z",
                    "daysOfWeek": [
                        "MONDAY"
                    ],
                    "daysOfMonth": [
                        1
                    ]
                },
                "capacity": 1
            }
        },
        "warnings": [
            {
                "code": "string",
                "message": "string",
                "details": "string"
            }
        ],
        "errors": [
            {
                "code": "string",
                "message": "string",
                "details": "string"
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable