FBA Small and Light API v1 reference
Manage listings in the Small and Light program.
Overview
The Selling Partner API for FBA Small and Light lets you help sellers manage their listings in the Small and Light program. The program reduces the cost of fulfilling orders for small and lightweight FBA inventory. You can enroll or remove items from the program and check item eligibility and enrollment status. You can also preview the estimated program fees charged to a seller for items sold while enrolled in the program.
Version information
Version : v1
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
getSmallAndLightEnrollmentBySellerSKU
putSmallAndLightEnrollmentBySellerSKU
deleteSmallAndLightEnrollmentBySellerSKU
getSmallAndLightEligibilityBySellerSKU
getSmallAndLightFeePreview
Paths
GET /fba/smallAndLight/v1/enrollments/{sellerSKU}
Operation: getSmallAndLightEnrollmentBySellerSKU
Description
Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 2 | 10 |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | sellerSKU required | The seller SKU that identifies the item. | string |
| Query | marketplaceIds required | The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. Max count : 1 | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SmallAndLightEnrollment |
For error status codes, descriptions and schemas, see Error responses and schemas.
PUT /fba/smallAndLight/v1/enrollments/{sellerSKU}
Operation: putSmallAndLightEnrollmentBySellerSKU
Description
Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 2 | 5 |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | sellerSKU required | The seller SKU that identifies the item. | string |
| Query | marketplaceIds required | The marketplace in which to enroll the item. Note: Accepts a single marketplace only. Max count : 1 | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SmallAndLightEnrollment |
For error status codes, descriptions and schemas, see Error responses and schemas.
DELETE /fba/smallAndLight/v1/enrollments/{sellerSKU}
Operation: deleteSmallAndLightEnrollmentBySellerSKU
Description
Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace. If the item is not eligible for disenrollment, the ineligibility reasons are returned.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 2 | 5 |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | sellerSKU required | The seller SKU that identifies the item. | string |
| Query | marketplaceIds required | The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only. Max count : 1 | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | No Content |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /fba/smallAndLight/v1/eligibilities/{sellerSKU}
Operation: getSmallAndLightEligibilityBySellerSKU
Description
Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 2 | 10 |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | sellerSKU required | The seller SKU that identifies the item. | string |
| Query | marketplaceIds required | The marketplace for which the eligibility status is retrieved. NOTE: Accepts a single marketplace only. Max count : 1 | < string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SmallAndLightEligibility |
For error status codes, descriptions and schemas, see Error responses and schemas.
POST /fba/smallAndLight/v1/feePreviews
Operation: getSmallAndLightFeePreview
Description
Returns the Small and Light fee estimates for the specified items. You must include a marketplaceId parameter to retrieve the proper fee estimates for items to be sold in that marketplace. The ordering of items in the response will mirror the order of the items in the request. Duplicate ASIN/price combinations are removed.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 1 | 3 |
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | Request schema for submitting items for which to retrieve fee estimates. | SmallAndLightFeePreviewRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SmallAndLightFeePreviews |
For error status codes, descriptions and schemas, see Error responses and schemas.
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 404 | The resource specified does not exist. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 415 | The request payload is in an unsupported format. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
Definitions
MarketplaceId
A marketplace identifier.
Type : string
SellerSKU
Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.
Type : string
Error
Error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition in a human-readable form. | string |
| details optional | Additional information that can help the caller understand or fix the issue. | string |
ErrorList
A list of error responses returned when a request is unsuccessful.
| Name | Schema |
|---|---|
| errors optional | < Error > array |
SmallAndLightEnrollmentStatus
The Small and Light enrollment status of the item.
Type : enum
| Value | Description |
|---|---|
| ENROLLED | The Small and Light enrollment status is enrolled. |
| NOT_ENROLLED | The Small and Light enrollment status is not enrolled. |
SmallAndLightEligibilityStatus
The Small and Light eligibility status of the item.
Type : enum
| Value | Description |
|---|---|
| ELIGIBLE | The Small and Light eligibility status is eligible. |
| NOT_ELIGIBLE | The Small and Light eligibility status is not eligible. |
SmallAndLightEnrollment
The Small and Light enrollment status of the item indicated by the specified seller SKU.
| Name | Description | Schema |
|---|---|---|
| marketplaceId required | A marketplace identifier. | MarketplaceId |
| sellerSKU required | Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | SellerSKU |
| status required | The Small and Light enrollment status of the item. | SmallAndLightEnrollmentStatus |
SmallAndLightEligibility
The Small and Light eligibility status of the item indicated by the specified seller SKU.
| Name | Description | Schema |
|---|---|---|
| marketplaceId required | A marketplace identifier. | MarketplaceId |
| sellerSKU required | Identifies an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit. | SellerSKU |
| status required | The Small and Light eligibility status of the item. | SmallAndLightEligibilityStatus |
SmallAndLightFeePreviewRequest
Request schema for submitting items for which to retrieve fee estimates.
| Name | Description | Schema |
|---|---|---|
| marketplaceId required | A marketplace identifier. | MarketplaceId |
| items required | A list of items for which to retrieve fee estimates (limit: 25). | < Item > array |
SmallAndLightFeePreviews
| Name | Description | Schema |
|---|---|---|
| data optional | A list of fee estimates for the requested items. The order of the fee estimates will follow the same order as the items in the request, with duplicates removed. | < FeePreview > array |
Item
An item to be sold.
| Name | Description | Schema |
|---|---|---|
| asin required | The Amazon Standard Identification Number (ASIN) value used to identify the item. | string |
| price required | The price that the seller plans to charge for the item. | MoneyType |
FeePreview
The fee estimate for a specific item.
| Name | Description | Schema |
|---|---|---|
| asin optional | The Amazon Standard Identification Number (ASIN) value used to identify the item. | string |
| price optional | The price that the seller plans to charge for the item. | MoneyType |
| feeBreakdown optional | A list of the Small and Light fees for the item. | < FeeLineItem > array |
| totalFees optional | The total fees charged if the item participated in the Small and Light program. | MoneyType |
| errors optional | One or more unexpected errors occurred during the getSmallAndLightFeePreview operation. | < Error > array |
FeeLineItem
Fee details for a specific fee.
MoneyType
| Name | Description | Schema |
|---|---|---|
| currencyCode optional | The currency code in ISO 4217 format. | string |
| amount optional | The monetary value. | number |
FeeType
The type of fee charged to the seller.
Type : enum
| Value | Description |
|---|---|
| FBAWeightBasedFee | The FBA weight-based fee (weight handling). |
| FBAPerOrderFulfillmentFee | The FBA per-order fulfillment fee (order handling). |
| FBAPerUnitFulfillmentFee | The FBA fulfillment fee (Pick & Pack). |
| Commission | The commission - referral fee. |
Updated 2 months ago