listPlacementOptions

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
2	6

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.

Request

Path Params

inboundPlanId

string

required

Identifier of an inbound plan.

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

Query Params

pageSize

integer

optional

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

>= 1<= 20

Default:

paginationToken

string

optional

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.

>= 0 characters<= 1024 characters

Responses

🟢200OK

application/json

ListPlacementOptions 200 response

Headers

x-amzn-RequestId

string

optional

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

optional

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

Body

The `listPlacementOptions` response.

pagination

object (Pagination)

optional

The process of returning the results to a request in batches of a defined size called pages. This is done to exercise some control over result size and overall throughput. It's a form of traffic management.

nextToken

string

optional

A generated string used to retrieve the next page of the result. If nextToken is returned, pass the value of nextToken to the next request. If nextToken is not returned, there are no more items to return.

placementOptions

array[object (PlacementOption) {6}]

required

Placement options generated for the inbound plan.

discounts

array[object (Incentive) {4}]

required

Discount for the offered option.

expiration

string <date-time>

optional

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

fees

array[object (Incentive) {4}]

required

The fee for the offered option.

placementOptionId

string

required

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

>= 38 characters<= 38 characters

Match pattern:

^[a-zA-Z0-9-]*$

shipmentIds

array[string]

required

Shipment ids.

status

string

required

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

>= 1 characters<= 1024 characters

Example

{
    "pagination": {
        "nextToken": "string"
    },
    "placementOptions": [
        {
            "discounts": [
                {
                    "description": "string",
                    "target": "string",
                    "type": "string",
                    "value": {
                        "amount": 0,
                        "code": "str"
                    }
                }
            ],
            "expiration": "2019-08-24T14:15:22Z",
            "fees": [
                {
                    "description": "string",
                    "target": "string",
                    "type": "string",
                    "value": {
                        "amount": 0,
                        "code": "str"
                    }
                }
            ],
            "placementOptionId": "stringstringstringstringstringstringst",
            "shipmentIds": [
                "stringstringstringstringstringstringst"
            ],
            "status": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses