FBA Small and Light API Use Case Guide
How to use the FBA Small and Light API.
API Version: v1
What is the Small and Light API?
The Small and Light API enables developers to access the Small and Light FBA program. You can use the API to:
-
Determine if a seller SKU is eligible for the Small and Light program.
-
Determine if a seller SKU is enrolled in the Small and Light program.
-
Enroll a seller SKU in the program.
-
Disenroll a seller SKU from the program.
This API does not support querying multiple marketplaces in the same request. If multiple marketplaces are provided in the request, the API will select the first marketplace from the list.
Terminology
- SKU: Stock keeping unit. Identifies a seller’s listing for an ASIN in a given marketplace.
Prerequisites
To complete any of the tutorials you will need:
- Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
- Approval for the Amazon Fulfillment role in your developer profile.
- The Amazon Fulfillment role selected in the App registration page for your application.
Tutorial: Check the eligibility of a seller SKU for the Small and Light program
This tutorial shows you how to find out if a seller SKU is eligible to be enrolled in the Small and Light program for a given marketplace. If a seller SKU is ineligible for the program, the error responses will indicate the ineligibility reasons. To enroll a seller SKU in the Small and Light program, go to Tutorial: Enroll in the Small and Light program.
Prerequisites
To complete this tutorial you will need:
- Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
- Approval for the Amazon Fulfillment role in your developer profile.
- The Amazon Fulfillment role selected in the App registration page for your application.
Get the seller SKU eligibility for the Small and Light program
Call the getSmallAndLightEligibilityBySellerSKU
operation by passing the following parameters:
Parameter | Description | Required |
---|---|---|
marketplaceIds |
The marketplace for which the eligibility status is retrieved. Note: Accepts a single marketplace only.
Max count : 1 Type:< string > array |
Yes |
sellerSKU |
The seller SKU that identifies the item. Type: string |
Yes |
A successful response has the code 200, and includes the objects below.
Name | Description | Required |
---|---|---|
marketplaceId |
A marketplace identifier. Type: |
Yes |
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: |
Yes |
status |
The Small and Light eligibility status of the item. | Yes |
An unsuccessful response has a non-2xx code, and includes the objects below. If the seller SKU is not eligible for the program, a 404 response will provide the ineligibility errors.
Name | Description | Required |
---|---|---|
errors |
The reason why the request failed and eligibility for the program was not determined. Type: < Error > array |
Yes |
Error | ||
Name | Description | Required |
code |
An error code that identifies the type of error that occurred. Type: string |
Yes |
message |
A message that describes the error condition in a human-readable form. Type: string |
Yes |
details |
Additional information that can help the caller understand or fix the issue. Type: string |
No |
Successful response example
HTTP/1.1 200 OK
{
"marketplaceId": "ATVPDKIKX0DER",
"sellerSKU": "exampleSellerSKU",
"status": "ELIGIBLE"
}
Unsuccessful response example
HTTP/1.1 404 Not Found
{
"errors": [
{
"code": "INVALID_ASIN_PRICE",
"message": "The product's selling price is too high."
},
{
"code": "INVALID_PACKAGE_WEIGHT",
"message": "The product's package weight does not meet the required criteria."
}
]
}
Tutorial: Check if a seller SKU is enrolled in the Small and Light program
This tutorial shows you how to find out if a seller SKU is enrolled in the Small and Light program for a given marketplace. To enroll a seller SKU in the Small and Light program go to Tutorial: Enroll in the Small and Light program. To disenroll a seller SKU from the Small and Light program go to Tutorial: Disenroll from the Small and Light program.
Prerequisites
To complete this tutorial you will need:
- Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
- Approval for the Amazon Fulfillment role in your developer profile.
- The Amazon Fulfillment role selected in the App registration page for your application.
Get the Small and Light enrollment details for a seller SKU
Call the getSmallAndLightEnrollmentBySellerSKU
operation by passing the following parameters:
Parameter | Description | Required |
---|---|---|
marketplaceIds |
The marketplace for which the enrollment status is retrieved. Note: Accepts a single marketplace only. Max count: 1 Type: < string > array |
Yes |
sellerSKU |
The seller SKU that identifies the item. Type: string |
Yes |
Request example
GET https://sellingpartnerapi-na.amazon.com/fba/smallAndLight/v1/enrollments/exampleSellerSKU?marketplaceIds= ATVPDKIKX0DER
Response
A successful response has the code 200, and includes the objects below.
Name | Description | Required |
---|---|---|
marketplaceId |
A marketplace identifier. Type: |
Yes |
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: |
Yes |
status |
The Small and Light enrollment status of the item. | Yes |
An unsuccessful response has a non-2xx code, and includes the objects below.
Name | Description | Required |
---|---|---|
errors |
A list of error responses returned when a request is unsuccessful. Type: < Error > array |
No |
Error | ||
Name | Description | Required |
code |
An error code that identifies the type of error that occurred. Type: string |
Yes |
message |
A message that describes the error condition in a human-readable form. Type: string |
Yes |
details |
Additional information that can help the caller understand or fix the issue. Type: string |
No |
Successful response example
HTTP/1.1 200 OK
{
"marketplaceId": "ATVPDKIKX0DER",
"sellerSKU": "exampleSellerSKU",
"status": "NOT_ENROLLED"
}
Unsuccessful response example
HTTP/1.1 400 Not Found
{
"errors": [
{
"code": "ServiceUnavailable",
"message": "Service is temporarily unavailable."
}
]
}
Tutorial: Enroll in the Small and Light program
This tutorial shows you how to enroll a seller SKU in the Small and Light program for a given marketplace. To disenroll a seller SKU from the Small and Light program go to Tutorial: Disenroll from the Small and Light program.
Prerequisites
To complete this tutorial you will need:
- Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
- Approval for the Amazon Fulfillment role in your developer profile.
- The Amazon Fulfillment role selected in the App registration page for your application.
Enroll a seller SKU in the Small and Light program
Call the putSmallAndLightEnrollmentBySellerSKU
operation by passing the following parameters:
Parameter | Description | Required |
---|---|---|
marketplaceIds |
The marketplace in which to enroll the item. Note: Accepts a single marketplace only. Max count : 1 Type: < string > array |
Yes |
sellerSKU |
The seller SKU that identifies the item. Type: string |
Yes |
Request example
PUT https://sellingpartnerapi-na.amazon.com/fba/smallAndLight/v1/enrollments/exampleSellerSKU?marketplaceIds= ATVPDKIKX0DER
Response
A successful response has the code 200, and includes the objects below.
Name | Description | Required |
---|---|---|
marketplaceId |
A marketplace identifier. Type: |
Yes |
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: |
Yes |
status |
The Small and Light enrollment status of the item. | Yes |
An unsuccessful response has a non-2xx code, and includes the objects below. A 404 response will provide the ineligibility errors, if any.
Name | Description | Required |
---|---|---|
errors |
A list of error responses returned when a request is unsuccessful. Type: < Error > array |
No |
Error | ||
Name | Description | Required |
code |
An error code that identifies the type of error that occurred. Type: string |
Yes |
message |
A message that describes the error condition in a human-readable form. Type: string |
Yes |
details |
Additional information that can help the caller understand or fix the issue. Type: string |
No |
Successful response example
HTTP/1.1 200 OK
{
"marketplaceId": "ATVPDKIKX0DER",
"sellerSKU": "exampleSellerSKU",
"status": "ENROLLED"
}
Unsuccessful response example
HTTP/1.1 404 Not Found
{
"errors": [
{
"code": "INVALID_ASIN_PRICE",
"message": "The product's selling price is too high."
},
{
"code": "INVALID_PACKAGE_WEIGHT",
"message": "The product's package weight does not meet the required criteria."
}
]
}
Tutorial: Disenroll from the Small and Light program
This tutorial shows you how to disenroll a seller SKU from the Small and Light program for a given marketplace. To enroll a seller SKU to the Small and Light program go to Tutorial: Enroll in the Small and Light program.
Prerequisites
To complete this tutorial you will need:
- Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.
- Approval for the Amazon Fulfillment role in your developer profile.
- The Amazon Fulfillment role selected in the App registration page for your application.
Delete a seller SKU from the Small and Light program
Call the deleteSmallAndLightEnrollmentBySellerSKU
operation by passing the following parameters:
Parameter | Description | Required |
---|---|---|
marketplaceIds |
The marketplace in which to remove the item from the Small and Light program. Note: Accepts a single marketplace only.
Max count : 1 Type: < string > array |
Yes |
sellerSKU |
The seller SKU that identifies the item. Type: string |
Yes |
Request example
DELETE https://sellingpartnerapi-na.amazon.com/fba/smallAndLight/v1/enrollments/exampleSellerSKU?marketplaceIds= ATVPDKIKX0DER
Response
A successful response has the code 204 with an empty response body. An unsuccessful response has a non-2xx code, and includes the objects below.
Name | Description | Required |
---|---|---|
errors |
A list of error responses returned when a request is unsuccessful. Type: < Error > array |
No |
Error | ||
Name | Description | Required |
code |
An error code that identifies the type of error that occurred. Type: string |
Yes |
message |
A message that describes the error condition in a human-readable form. Type: string |
Yes |
details |
Additional information that can help the caller understand or fix the issue. Type: string |
No |
Successful response example
HTTP/1.1 204 OK
{
}
Unsuccessful response example
HTTP/1.1 400 Not Found
{
"errors": [
{
"code": "ServiceUnavailable",
"message": "Service is temporarily unavailable."
}
]
}
Updated about 2 months ago