Buy with Prime | Developer Documentation
Documentation

Get Reversal Offers

📘

Buy with Prime API is now available for early access

Sign up for early access to the Buy with Prime API using the 'Sign Up' button below. The API may change as Amazon receives feedback and iterates on it.

Sign Up

You can display a reversal offer on a product detail page, cart, or checkout page. A Buy with Prime reversal offer specifies whether the item (or multiple items that can be returned collectively) can be returned by evaluating a set of conditions specified in the returns policy found at About Our Returns Policies, which you must follow and incorporate into your existing policies.

This topic contains examples of how to get reversal offers.

For an overview of reversal terminology, see Process Returns. To learn how to call the Buy with Prime API, see Call the Buy with Prime API.

Get reversal offers for a product on a product detail page

The following example shows a query that gets reversal offers for a product on a product detail page.

A summary of the return (summary.title.value) that you can display on the product detail page for a product that can be returned within 30 days of delivery is "Free 30-day returns." The return details (summary.description.value) that you can display on the product detail page are "This item is eligible for free 30-day returns through Buy with Prime."

Request 
// GraphQL query
query reversalOffers {
  reversalOffers (
    reversalOffersInput: {
-      items: [
        { id: { SKU: "example-sku-1" } }
        ]
      }
    )  {
    id
    expiresAt
    reversalOfferCollection {
      item {
        id {
          __typename
          value
        }
      }
      summary {
        title {
          value
          locale
        }  
        resolutionTypes []
        description {
          value
          locale
        }
        window {
          endDate
          duration {
            unit
            value
          }
        }
      }
    }
  }
}
Response (product is eligible for a return) 
{
  "data": {
    "reversalOffers": {
      "id": "example-reversal-offer-id",
      "expiresAt": "2024-02-07T19:24:28.572312Z",
      "reversalOfferCollection": [
        {
          "item": {
            "id": {
              "__typename": "SkuReversalItemIdentifier",
              "value": "example-sku-1"
            }
          },
          "summary": {
            "title": {
                "value": "Free 30-day returns",
                "locale": "en-US"
             }, 
            "resolutionTypes": ["RETURN"],
            "description": {
                "value": "This item is eligible for free 30-day returns through Buy with Prime.",
                "locale": "en-US"
             },            
            "window": {
                "endDate": null,
                "duration": {
                  "unit": "day",
                  "value": 30
              }
            }                  
          }
        }
      ]
    }
  },
  "errors": []
}
Response (product is returnable until a holiday window) 
{
  "data": {
    "reversalOffers": {
      "id": "example-reversal-offer-id",
      "expiresAt": "2024-02-07T19:24:28.572312Z",
      "reversalOfferCollection": [
        {
          "item": {
            "id": {
              "__typename": "SkuReversalItemIdentifier",
              "value": "example-sku-1"
            }
          },
          "summary": {
            "title": {
                "value": "Free returns till 31-Jan-2024",
                "locale": "en-US"
             }, 
            "resolutionTypes": ["RETURN"],
            "description": {
                "value": "This item is eligible for free return till 31-Jan-2024 through Buy with Prime.",
                "locale": "en-US"
             },
             "window": {
              "endDate": "2024-01-31T23:59:59Z",
              "duration": null,
          }
        },
      ]
    }
  },
  "errors": []
}
Response (product isn't returnable) 
{
  "data": {
    "reversalOffers": {
      "id": "example-reversal-offer-id",
      "expiresAt": "2024-02-07T19:24:28.572312Z",
      "reversalOfferCollection": [
        {
          "item": {
            "id": {
              "__typename": "SkuReversalItemIdentifier",
              "value": "example-sku-1"
            }
          },
          "summary": {
            "title": {
                "value": "Not returnable",
                "locale": "en-US"
             },
            "resolutionTypes": [],
            "description": {
                "value": "This item is not eligible for a return through Buy with Prime",
                "locale": "en-US"
             },
             "window": null            
          }
        }
      ]
    }
  },
  "errors": []
}

Get reversal offers for multiple items in a cart

You can use one call to the reversalOffers query to retrieve reversal offers for multiple items that a customer is buying together. This is useful in getting reversal offers for list of items on pages such as the cart and checkout.

If you need to display a reversal offer for a collection of items that aren't being purchased together, call the reversalOffers query once for each item, as shown in the previous example.

The following example shows a query that gets reversal offers for multiple items in a cart.

Request 
query reversalOffers {
  reversalOffers (
    reversalOffersInput: {
      items: [
        { id: { SKU: "example-sku-3" } }
        { id: { SKU: "example-sku-4" } }
      ]
    }
  )  {
    id
    expiresAt
    reversalOfferCollection {
      item {
        id {
          __typename
          value
        }
      }
      summary {
        title {
          value
          locale
        }  
        resolutionTypes []
        description {
          value
          locale
        }
        window {
          endDate
          duration {
            unit
            value
          }
        }        
       }
     }
   }
}
Response 
{
  "data": {
    "reversalOffers": {
      "id": "example-reversal-offer-id",
      "expiresAt": "2024-02-07T19:24:28.572312Z",
      "reversalOfferCollection": [
        {
          "item": {
            "id": {
              "__typename": "SkuReversalItemIdentifier",
              "value": "example-sku-3"
            }
          },
          "summary": {
            "title": {
                "value": "Free 30-day returns",
                "locale": "en-US"
             },
            "resolutionTypes": ["RETURN"], 
            "description": {
                "value": "This item is eligible for free 30-day returns through Buy with Prime",
                "locale": "en-US"
             },
             "window": {
              "endDate": null,
              "duration": {
                "unit": "day",
                "value": 30
              }
            }                
          }
        },
        {
          "item": {
            "id": {
              "__typename": "SkuReversalItemIdentifier",
              "value": "example-sku-4"
            }
          },
          "summary": {
            "title": {
                "value": "Free 30-day returns",
                "locale": "en-US"
             },
            "resolutionTypes": ["RETURN"], 
            "description": {
                "value": "This item is eligible for free 30-day returns through Buy with Prime",
                "locale": "en-US"
             },
             "window": {
              "endDate": null,
              "duration": {
                "unit": "day",
                "value": 30
              }
            }            
          }
        }
      ]
    }
  },
  "errors": []
}

Related topics

Updated 2 days ago