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

listPlacementOptions

get https://sellingpartnerapi-na.amazon.com/inbound/fba/2024-03-20/inboundPlans//placementOptions

Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.

Usage Plan:

Rate (requests per second)Burst
26

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Path Params
string
required
length between 38 and 38

Identifier of an inbound plan.

Query Params
integer
1 to 20
Defaults to 10

The number of placement options to return in the response matching the given query.

string
length between 0 and 1024

A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the pagination returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.

Responses

Response body
object
pagination
object

Contains tokens to fetch from a certain page.

string
length between 1 and 1024

When present, pass this string token in the next request to return the next response page.

placementOptions
array of objects
required

Placement options generated for the inbound plan.

placementOptions*
object
discounts
array of objects
required

Discount for the offered option.

discounts*
object
string
required
length between 1 and 1024

Description of the incentive.

string
required
length between 1 and 1024

Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'.

string
required
length between 1 and 1024

Type of incentive. Possible values: FEE, DISCOUNT.

value
object
required

The type and amount of currency.

date-time

The expiration date of the placement option. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ss.sssZ.

fees
array of objects
required

The fee for the offered option.

fees*
object
string
required
length between 1 and 1024

Description of the incentive.

string
required
length between 1 and 1024

Target of the incentive. Possible values: 'Placement Services', 'Fulfillment Fee Discount'.

string
required
length between 1 and 1024

Type of incentive. Possible values: FEE, DISCOUNT.

value
object
required

The type and amount of currency.

string
required
length between 38 and 38

The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.

shipmentIds
array of strings
required

Shipment ids.

shipmentIds*
string
required
length between 1 and 1024

The status of a placement option. Possible values: OFFERED, ACCEPTED, EXPIRED.

Headers
object
string

Unique request reference identifier.

string

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

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?