updateSchedule - Amazon SP API

Update the schedule of the given resource.

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

resourceId

string

required

Resource (store) Identifier

>= 1 characters<= 100 characters

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

schedules

array[object (AvailabilityRecord) {4}]

required

List of AvailabilityRecords to represent the capacity of a resource over a time range.

startTime

string <date-time>

required

Denotes the time from when the resource is available in a day in ISO-8601 format.

endTime

string <date-time>

required

Denotes the time till when the resource is available in a day in ISO-8601 format.

recurrence

object (Recurrence)

optional

Repeated occurrence of an event in a time range.

capacity

integer

optional

Signifies the capacity of a resource which is available.

>= 1

Example

{
    "schedules": [
        {
            "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 `updateSchedule` operation.

payload

array[object (UpdateScheduleRecord) {3}]

optional

Contains the UpdateScheduleRecords for which the error/warning has occurred.

availability

object (AvailabilityRecord)

optional

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

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