reversalOffers

Version 2024-11-01

📘

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.

Overview

Returns reversal offers for given items.

ℹī¸

Required scope(s)

View Product Return Policy, View Catalog Data

Response

Return type ReversalOffers

Arguments

ArgumentDescription
reversalOffersInput (ReversalOffersInput required)

Represents the request information for reversal offers.

Examples


Query Reversal Offers With Valid Items

Request

query reversalOffers { reversalOffers( reversalOffersInput: { items: [ { id: { mSKU: { marketplaceId: "US", value: "B08J4FX127" } } } { id: { SKU: "titan-sku-3" } } ] } ) { expiresAt id reversalOfferCollection { item { id { __typename value ... on MskuReversalItemIdentifier { marketplaceId } } } summary { title { value locale } description { value locale } resolutionTypes window { endDate duration { unit value } } } } } }

Response

{ "data": { "reversalOffers": { "expiresAt": "2024-04-23T10:51:19.229612Z", "id": "0f47a5e9-dca0-440d-9c2c-48dc1e10175e", "reversalOfferCollection": [ { "item": { "id": { "__typename": "MskuReversalItemIdentifier", "value": "B08J4FX127", "marketplaceId": "US" } }, "summary": { "title": { "value": "Not returnable", "locale": "en-US" }, "description": { "value": "This item is not eligible for a return through Buy with Prime", "locale": "en-US" }, "resolutionTypes": [] } }, { "item": { "id": { "__typename": "SkuReversalItemIdentifier", "value": "titan-sku-3" } }, "summary": { "title": { "value": "Free 30-day returns", "locale": "en-US" }, "description": { "value": "This item is eligible for free 30-day returns through Buy with Prime", "locale": "en-US" }, "resolutionTypes": [ "RETURN" ], "window": { "duration": { "unit": "day", "value": 30 } } } } ] } } }

Query Reversal Offers With Invalid Items

Request

query reversalOffers { reversalOffers( reversalOffersInput: { items: [ { id: { mSKU: { marketplaceId: "US", value: "B08J4FX12" } } } { id: { SKU: "titan-sku-6" } } ] } ) { expiresAt id reversalOfferCollection { item { id { __typename value ... on MskuReversalItemIdentifier { marketplaceId } } } summary { title { value locale } description { value locale } resolutionTypes window { endDate duration { unit value } } } } } }

Response

{ "errors": [ { "message": "Item B08J4FX12 missing from the catalog", "locations": [ { "line": 2, "column": 5 } ], "path": [ "reversalOffers" ], "extensions": { "classification": { "errorType": "ValidationException", "errorCode": 400, "type": "ValidationError", "code": "ItemDoesNotExist", "details": { "itemId": { "type": "MSKU", "value": "B08J4FX12", "marketplaceId": "US" } } } } }, { "message": "Item titan-sku-6 missing from the catalog", "locations": [ { "line": 2, "column": 5 } ], "path": [ "reversalOffers" ], "extensions": { "classification": { "errorType": "ValidationException", "errorCode": 400, "type": "ValidationError", "code": "ItemDoesNotExist", "details": { "itemId": { "type": "SKU", "value": "titan-sku-6" } } } } } ], "data": null }


Did this page help you?