📘

Important

The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.

This page contains frequently asked questions about the Buy with Prime API.

Can I use the Buy with Prime API for shoppers that aren't Prime members and for products that I don't offer through Buy with Prime?

Yes. Starting with version 2024-11-01 of the Buy with Prime API, you can use the Buy with Prime API to provide a consistent and reliable shopping experience for all of your shoppers across all of your products that are fulfilled by Amazon. This single API integration streamlines the development process for a seamless experience across your entire catalog.

The Buy with Prime API offers granular, item-level configurations to process various cart scenarios based on the shopper's Prime membership and the product's eligibility for Buy with Prime. For example, the Buy with Prime API supports the following scenarios:

• A Prime member's cart that contains products that you offer through Buy with Prime: An Amazon shopper with a Prime membership adds one or more Buy with Prime products to their cart to get Prime benefits.
• A Prime member's cart that contains products that you don't offer through Buy with Prime: An Amazon shopper with a Prime membership adds Amazon-fulfilled products to their cart even though you don't offer the products through Buy with Prime.
• A Prime member's cart with a mix of products that offer Buy with Prime and others that don't: An Amazon shopper with a Prime membership adds a mix of Buy with Prime products and other products that are fulfilled by Amazon but not offered through Buy with Prime.
• A cart for a shopper without a Prime membership: A shopper who is not signed in (such as a guest) or an Amazon shopper who isn't a Prime member adds one or more Amazon-fulfilled products to their cart.

What are the benefits of using the Buy with Prime API for all of your Amazon-fulfilled products?

The Buy with Prime API offers several benefits:

• Inventory consolidation: Use your product inventory pool in Amazon fulfillment centers for both Prime members and shoppers who aren't Prime members.
• Buy with Prime selection flexibility: Offer Buy with Prime for specific products based on seasonality, pricing, and customer preferences, while using Amazon fulfillment for products that you don't offer through Buy with Prime.
• Increased units per order: Enable single orders for a mix of products that you do and don't offer through Buy with Prime.
• Shipping option variety: Provide Prime benefits for Prime members and fast shipping for shoppers who aren't Prime members.
• Consistent experience: Offer a reliable shopping experience regardless of the shopper's Prime membership status.
• Conversion boost: Leverage Amazon fulfillment options to increase conversions for shoppers who aren't Prime members.

If I currently use the Amazon Selling Partner API (SP-API), do I need to fulfill additional prerequisites to use the Buy with Prime API?

Yes. For Buy with Prime API prerequisites, see Prerequisites.

In addition, Create and Manage Catalogs to populate your Buy with Prime catalog with products. After you populate your Buy with Prime catalog, you can query inventory levels for any products in your Buy with Prime catalog, regardless of whether you offer the products through Buy with Prime.

Does the Buy with Prime API have any constraints?

The Buy with Prime API currently doesn’t support the following features:

• Fulfillment features: The Buy with Prime API has the following constraints:
  • The Buy with Prime API doesn't support Multi-channel Fulfillment (MCF) features like Blank Box when creating orders. Alternatively, you can configure these features on an account level in Seller Central for all orders. Blank Box means that the packing slip, shipping labels, and packaging materials don’t contain any Amazon branding.
  • If you want to programmatically manage inbound workflows that send shipments into Amazon's fulfillment network, you must use the SP-API Fulfillment Inbound API.
• Returns for products that aren't offered through Buy with Prime: Because the free returns policy on eligible items is only applicable to shoppers with Prime benefits, return offers are not supported for products not offering Prime. However, you can create returns within the Buy with Prime merchant console for orders with both Prime items and items fulfilled by Amazon.
• UI library: You can'tDisplay Buy with Prime Elements on Your Site to get delivery offers for products that you don't offer through Buy with Prime.

When should I use the Selling Partner API instead of the Buy with Prime API?

The answer depends on which Amazon services you use and which API features you need for your integration. To offer Buy with Prime on your site, you must use the Buy with Prime API. The SP-API doesn't support features such as getting a Prime delivery offer or creating orders. With version 2024-11-01 of the Buy with Prime API, you can offer Amazon fulfillment options for shoppers who aren't Prime members and products that you don't offer through Buy with Prime.

The SP-API supports several other Amazon services for Fulfillment by Amazon (FBA) sellers and vendors. To develop integrations for those services, you must use the SP-API. Certain features, such as Fulfillment Inbound, are not yet available in the Buy with Prime API.

What are examples of ways I can integrate the Buy with Prime API into my site's shopping experience?

The following scenarios demonstrate integration points where you can add support for Amazon fulfillment to your store’s shopping experience.

Delivery offers

You can Create Delivery Previews for products that you offer through Buy with Prime and products that you don’t offer through Buy with Prime. You can display delivery estimates across product detail pages, the shopping cart, and checkout. The deliveryPreview query supports all existing Amazon fulfillment delivery speeds, such as priority and standard. You can display delivery offers for Prime members as well as shoppers who aren't Prime members.

The following example shows the response to a query to the Delivery Preview interface.

{
  "data":{
    "deliveryPreview":{
      "id":"product-a-delivery-preview",
      "deliveryGroups":[
        {
          "id":"product-a-delivery-group",
          "products":[
            {
              "productIdentifier":{
                "value":"product-a-id-1"
              },
               "amount": {
                 "unit:" "UNIT",
                 "value": 1
              }
            }
          ],
          "deliveryOffers":[
            {
              "id":"product-a-delivery-offer-1",
              "date":{
                "earliest":"2024-04-01T04:00:00Z",
                "latest":"2024-04-01T04:00:00Z"
              },
              "deliveryTerms":{
                "isPrimeEligible": true
              },
              "policy":{
                "messaging":{
                  "messageText":"Get it as soon as Tomorrow, April 1st",
                  "locale":"en-US",
                  "badge":"PRIME"
                }
              },
              "expiresAt":null
            },
            {
              "id":"product-a-delivery-offer-2",
              "date":{
                "earliest":"2024-04-03T04:00:00Z",
                "latest":"2024-04-03T04:00:00Z"
              },
              "deliveryTerms":{
                "isPrimeEligible": true,
                "deliverySpeed":"Standard"
              },
              "policy":{
                "messaging":{
                  "messageText":"Get it April 3rd",
                  "locale":"en-US",
                  "badge":"PRIME"
                }
              },
              "expiresAt":null
            }
          ]
        }
      ]
    }
  }
}

The following checkout image shows delivery offers for a product that isn't offered through Buy with Prime.

The following checkout image shows a cart that has one product that is offered through Buy with Prime, and one product that isn't offered through Buy with Prime.

Order management

You can create, update, query, or cancel orders with a mix of products that you offer through Buy with Prime and products that you don't offer through Buy with Prime but are fulfilled by Amazon. When you create an order, you specify the delivery offer for each line item based on selected delivery offers that the deliveryPreview query returns.

The following example shows a call to the Order interface.

// GraphQL mutation
mutation createOrder($input: CreateOrderInput) {
  createOrder(input: $input) {
    order {
      id
    }
  }
}
  
// Mutation variables  
{
   "input": {
      "desiredExecutionState":"STARTED",
      "customer": john,
      "recipient": john,
      "lineItems":[
        {
          "purchasedProduct": {
             "productId": productA.buyWithPrimeProductId,
             "title":productA.title,
             "price": {
                "amount": productA.price.amount,
                "currencyCode": productA.price.currencyCode
              },
             "variationSelections": [ 
               {
                "dimension": productA.variationDetails.[0].dimension,
                "value": productA.variationDetails.[0].value
               }
             ]
          },
          "amount": {
            "value": 1
          },
          "selectedDeliveryOffer": {
            "details":{
              "deliveryPreviewId": selectedDeliveryPreview.deliveryPreviewId,
              "id": selectedDeliveryPreview.deliveryOfferId,
              "deliveryProvider": "AMAZON",
              "deliveryTerms": {
                "isPrimeEligible": true
              }
            }
          },
          "taxes": {
            "summary": {
              "collectableTaxAmount": {
                "amount": "10.00",
                "currencyCode": "USD"
              }
            }
          }
        }

The following product detail page image shows delivery offers for a product that is offered through Buy with Prime.

The following product detail page image contains delivery offers for a product that isn't offered through Buy with Prime.

The following image shows a checkout page for a Prime member and a product that's offered through Buy with Prime.

Related topics

• About the Buy with Prime API
• Call the Buy with Prime API
• Terminology