HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

getAppointmentSlots

get https://sellingpartnerapi-na.amazon.com/service/v1/appointmentSlots

Gets appointment slots as per the service context specified.

Usage Plan:

Rate (requests per second)Burst
2040

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.

Query Params
string
required

ASIN associated with the service.

string
required
length between 1 and 100

Store identifier defining the region scope to retrive appointment slots.

marketplaceIds
array of strings
required
length ≤ 1

An identifier for the marketplace for which appointment slots are queried

marketplaceIds*
string

A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If startTime is provided, endTime should also be provided. Default value is as per business configuration.

string

A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If endTime is provided, startTime should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.

Responses

Response body
object
payload
object

Availability information as per the service context queried.

string

Defines the type of slots.

REAL_TIME_SCHEDULING NON_REAL_TIME_SCHEDULING

Show Details
REAL_TIME_SCHEDULINGThe slots provided are backed by inventory in inventory management system.
NON_REAL_TIME_SCHEDULINGThe slots provided are based on working hours defined in seller management system.
date-time

Start Time from which the appointment slots are generated in ISO 8601 format.

date-time

End Time up to which the appointment slots are generated in ISO 8601 format.

appointmentSlots
array of objects

A list of time windows along with associated capacity in which the service can be performed.

appointmentSlots
object
date-time

Time window start time in ISO 8601 format.

date-time

Time window end time in ISO 8601 format.

integer
≥ 0

Number of resources for which a slot can be reserved.

errors
array of objects

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

errors
object
string
required

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

string
required

A message that describes the error condition.

string

Additional details that can help the caller understand or fix the issue.

string

The type of error.

ERROR WARNING

Show Details
ERRORError
WARNINGWarning
Headers
object
string

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

string

Unique request reference identifier.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?