getRangeSlotCapacity

post https://sellingpartnerapi-na.amazon.com/service/v1/serviceResources/{resourceId}/capacity/range

Provides capacity slots in a format similar to availability records.

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.

Path Params

resourceId

string

required

length between 1 and 100

Resource Identifier.

Query Params

marketplaceIds

array of strings

required

length ≤ 1

An identifier for the marketplace in which the resource operates.

marketplaceIds*

nextPageToken

string

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

Body Params

Request body.

capacityTypes

array of strings

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

Show Details

SCHEDULED_CAPACITY	This capacity represents the originally allocated capacity as per resource schedule.
AVAILABLE_CAPACITY	This capacity represents the capacity available for allocation to reservations.
ENCUMBERED_CAPACITY	This capacity represents the capacity allocated for Amazon Jobs/Appointments/Orders.
RESERVED_CAPACITY	This capacity represents the capacity made unavailable due to events like Breaks/Leaves/Lunch.

capacityTypes

startDateTime

date-time

required

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

endDateTime

date-time

required

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

Responses

Response body

object

resourceId

string

Resource Identifier.

capacities

array of objects

Array of range capacities where each entry is for a specific capacity type.

capacities

object

capacityType

string

Type of capacity

SCHEDULED_CAPACITY AVAILABLE_CAPACITY ENCUMBERED_CAPACITY RESERVED_CAPACITY

Show Details

SCHEDULED_CAPACITY	This capacity represents the originally allocated capacity as per resource schedule.
AVAILABLE_CAPACITY	This capacity represents the capacity available for allocation to reservations.
ENCUMBERED_CAPACITY	This capacity represents the capacity allocated for Amazon Jobs/Appointments/Orders.
RESERVED_CAPACITY	This capacity represents the capacity made unavailable due to events like Breaks/Leaves/Lunch.

slots

array of objects

Array of capacity slots in range slot format.

slots

object

startDateTime

date-time

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

endDateTime

date-time

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

capacity

int32

Capacity of the slot.

nextPageToken

string

Next page token, if there are more pages.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sellingpartnerapi-na.amazon.com/service/v1/serviceResources/resourceId/capacity/range \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
16
 
1
{
2
  "resourceId": "string",
3
  "capacities": [
4
    {
5
      "capacityType": "SCHEDULED_CAPACITY",
6
      "slots": [
7
        {
8
          "startDateTime": "2025-04-01T18:10:43.269Z",
9
          "endDateTime": "2025-04-01T18:10:43.269Z",
10
          "capacity": 0
11
        }
12
      ]
13
    }
14
  ],
15
  "nextPageToken": "string"
16
}

ERROR	Error
WARNING	Warning

ERROR	Error
WARNING	Warning

ERROR	Error
WARNING	Warning

ERROR	Error
WARNING	Warning

ERROR	Error
WARNING	Warning

200Success response.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.