getFixedSlotCapacity - Amazon SP API

Provides capacity in fixed-size slots.

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 Identifier.

>= 1 characters<= 100 characters

Query Params

marketplaceIds

array[string]

required

An identifier for the marketplace in which the resource operates.

<= 1 items

nextPageToken

string

optional

Next page token returned in the response of your previous request.

Body Params application/json

Request schema for the `getFixedSlotCapacity` operation. This schema is used to define the time range, capacity types and slot duration which are being queried.

capacityTypes

array[string]

optional

An array of capacity types which are being requested. Default value is [SCHEDULED_CAPACITY].

Allowed values:

SCHEDULED_CAPACITYAVAILABLE_CAPACITYENCUMBERED_CAPACITYRESERVED_CAPACITY

slotDuration

number <int32>

optional

Size in which slots are being requested. This value should be a multiple of 5 and fall in the range: 5 <= slotDuration <= 360.

Multiple of:

startDateTime

string <date-time>

required

Start date time from which the capacity slots are being requested in ISO 8601 format.

endDateTime

string <date-time>

required

End date time up to which the capacity slots are being requested in ISO 8601 format.

Example

{
    "capacityTypes": [
        "SCHEDULED_CAPACITY"
    ],
    "slotDuration": 0,
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z"
}

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

resourceId

string

optional

Resource Identifier.

slotDuration

number <int32>

optional

The duration of each slot which is returned. This value will be a multiple of 5 and fall in the following range: 5 <= slotDuration <= 360.

Multiple of:

capacities

array[object (FixedSlot) {5}]

optional

Array of capacity slots in fixed slot format.

startDateTime

string <date-time>

optional

Start date time of slot in ISO 8601 format with precision of seconds.

scheduledCapacity

integer <int32>

optional

Scheduled capacity corresponding to the slot. This capacity represents the originally allocated capacity as per resource schedule.

availableCapacity

integer <int32>

optional

Available capacity corresponding to the slot. This capacity represents the capacity available for allocation to reservations.

encumberedCapacity

integer <int32>

optional

Encumbered capacity corresponding to the slot. This capacity represents the capacity allocated for Amazon Jobs/Appointments/Orders.

reservedCapacity

integer <int32>

optional

Reserved capacity corresponding to the slot. This capacity represents the capacity made unavailable due to events like Breaks/Leaves/Lunch.

nextPageToken

string

optional

Next page token, if there are more pages.

Example

{
    "resourceId": "string",
    "slotDuration": 0,
    "capacities": [
        {
            "startDateTime": "2019-08-24T14:15:22Z",
            "scheduledCapacity": 0,
            "availableCapacity": 0,
            "encumberedCapacity": 0,
            "reservedCapacity": 0
        }
    ],
    "nextPageToken": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable