getItemEligibilityPreview

This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item's eligibility.

Usage Plan:

Rate (requests per second)	Burst
1	1

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

Query Params

marketplaceIds

array[string]

optional

The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.

<= 1 items

asin

string

required

The ASIN of the item for which you want an eligibility preview.

program

enum<string>

required

The program that you want to check eligibility against.

Allowed values:

INBOUNDCOMMINGLING

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference ID.

Body

The response schema for the getItemEligibilityPreview operation.

payload

object (ItemEligibilityPreview)

optional

The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes.

asin

string

required

The ASIN for which eligibility was determined.

marketplaceId

string

optional

The marketplace for which eligibility was determined.

program

enum<string>

required

The program for which eligibility was determined.

Allowed values:

INBOUNDCOMMINGLING

isEligibleForProgram

boolean

required

Indicates if the item is eligible for the program.

ineligibilityReasonList

array[string]

optional

Potential Ineligibility Reason Codes.

Allowed values:

FBA_INB_0004FBA_INB_0006FBA_INB_0007FBA_INB_0008FBA_INB_0009FBA_INB_0010FBA_INB_0011FBA_INB_0012FBA_INB_0013FBA_INB_0014FBA_INB_0015FBA_INB_0016FBA_INB_0017FBA_INB_0018FBA_INB_0019FBA_INB_0034FBA_INB_0035FBA_INB_0036FBA_INB_0037FBA_INB_0038FBA_INB_0050FBA_INB_0051FBA_INB_0053FBA_INB_0055FBA_INB_0056FBA_INB_0059FBA_INB_0065FBA_INB_0066FBA_INB_0067FBA_INB_0068FBA_INB_0095FBA_INB_0097FBA_INB_0098FBA_INB_0099FBA_INB_0100FBA_INB_0103FBA_INB_0104FBA_INB_0197UNKNOWN_INB_ERROR_CODE

errors

array[object (Error) {3}]

optional

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

code

string

required

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

message

string

required

A message that describes the error condition.

details

string

optional

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

Example

{
    "payload": {
        "asin": "string",
        "marketplaceId": "string",
        "program": "INBOUND",
        "isEligibleForProgram": true,
        "ineligibilityReasonList": [
            "FBA_INB_0004"
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

getItemEligibilityPreview

Request

Request samples

Responses