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.
Reversal is a term that the Buy with Prime API uses to encompass the concepts of returns, refunds, and cancellations.
At a high level, a Buy with Prime reversal offer specifies whether the item (or multiple items that are bought together) 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. A reversal offer contains the following information (some of which is nested inside the reversal offer object):
id: The unique identifier of the reversal offers response.expiresAt: The timestamp by which the reversal offers expire.reversalOfferCollection: A list of items and associated reversal offers. Each item in the list contains the item ID and its associated reversal offers. Each reversal offer has anitemand asummary.summary: A title and a description string that you can display to shoppers on the product detail page, the checkout page, and so on. The summary contains return eligibility (returnable/non-returnable) and a return window (for example, 30 days from order delivery). The summary also contains resolution types likeRETURN, which indicates the return eligibility of the item. An absence of theRETURNresolution means that the item is not eligible for return. You can use these resolutions to display custom messages or UI elements.
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.
To avoid an ItemDoesNotExist error when you call the generateReversalOffers query, ensure that the item is within your Buy with Prime catalog. To query your Buy with Prime catalog, use the mappingProduct query.
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 generateReversalOffers {
generateReversalOffers (
reversalOffersInput: {
items: [
{ id: { SKU: "example-sku-1" } }
]
}
) {
id
expiresAt
reversalOfferCollection {
item {
id {
__typename
value
}
}
summary {
title {
value
locale
}
resolutionTypes []
description {
value
locale
}
}
}
}
}
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": ["RETURNABLE"],
"description": {
"value": "This item is eligible for free 30-day returns through Buy with Prime.",
"locale": "en-US"
}
}
},
]
}
},
"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"
}
}
}
]
}
},
"errors": []
}
Get reversal offers for multiple items in a cart
You can use one call to the generateReversalOffers query to retrieve reversal offers for multiple items that a shopper 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 generateReversalOffers 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 generateReversalOffers {
generateReversalOffers (
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
}
}
}
}
}
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"
}
}
},
{
"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"
}
}
}
]
}
},
"errors": []
}
Related topics
Updated about 2 months ago