offers

📘

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 multiple offers for the purchase intent, like items, client's ip address etc.

ℹ️

Required scope(s)

Generate product offers

Response

Return type OfferConnection

Arguments

ArgumentDescription
input (OffersInput)

Specifies the input fields to query offers.

Examples


Get Offers With Shipping Location And No Shopper Identity

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } lineItems: [ { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-MRRA-PP285Q", "expiresAt": "1730901475", "lineItems": [ { "product": { "productId": { "value": "8qb6t1tzhzjmi6" }, "offerPrime": true, "amazonSku": { "value": "Y2-FWTY-AWDW" }, "sku": { "value": "Y2-FWTY-AWDW" } }, "deliveryOffer": { "summary": { "deliveryCharge": { "amount": 0, "currencyCode": "USD" }, "deliveryMessage": { "locale": "en-US", "messageText": "Get it as soon as Tomorrow Nov 7" }, "deliveryProvider": "PRIME" }, "details": null }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers For Prime Item With Authenticated Shopper

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } shopperIdentity: { lwaAccessToken: { value: "shopper_token_id" } } lineItems: [ { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-UJJ3-JZ6KJ5", "expiresAt": "1730878827", "lineItems": [ { "product": { "productId": { "value": "8qb6t1tzhzjmi6" }, "offerPrime": true, "amazonSku": { "value": "Y2-FWTY-AWDW" }, "sku": { "value": "Y2-FWTY-AWDW" } }, "deliveryOffer": { "summary": null, "details": { "id": "5060887210", "policy": { "messaging": { "messageText": "Tomorrow, Nov 6" } }, "deliveryProvider": "AMAZON", "deliveryPreviewId": "SIP-0926389-7002857", "date": { "latest": "2024-11-07T04:00:00Z" } } }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers For Prime Item But Non Prime Shopper With Terms Is Prime Eligible True

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } shopperIdentity: { lwaAccessToken: { value: "non_prime_shopper_token_id" } } lineItems: [ { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-M8MU-G78BEE", "expiresAt": "1730103955", "lineItems": [ { "product": { "productId": { "value": "8qb6t1tzhzjmi6" }, "offerPrime": true, "amazonSku": { "value": "Y2-FWTY-AWDW" }, "sku": { "value": "Y2-FWTY-AWDW" } }, "deliveryOffer": { "summary": null, "details": null }, "reversalOffers": { "summary": null } } ] } } ] } } }

Get Offers For Prime And Non Prime Item With No Shopper Information

Request

query { offers( input: { lineItems: [ { product: { identifier: { sku: "GY-5U3E-6VMU", } }, amount: { value: 1 } }, { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-R7AP-E8EUXN", "expiresAt": "1730102628", "lineItems": [ { "product": { "productId": { "value": "mr9ztf8f08nue1" }, "offerPrime": false, "amazonSku": { "value": "GY-5U3E-6VMU" }, "sku": { "value": "GY-5U3E-6VMU" } }, "deliveryOffer": { "summary": null, "details": null }, "reversalOffers": { "summary": null } }, { "product": { "productId": { "value": "8qb6t1tzhzjmi6" }, "offerPrime": true, "amazonSku": { "value": "Y2-FWTY-AWDW" }, "sku": { "value": "Y2-FWTY-AWDW" } }, "deliveryOffer": { "summary": { "deliveryCharge": { "amount": 0, "currencyCode": "USD" }, "deliveryMessage": { "locale": "en-US", "messageText": "Get it as soon as Tomorrow Oct 29" }, "deliveryProvider": "PRIME" }, "details": null }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers For Prime And Non Prime Item

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } shopperIdentity: { lwaAccessToken: { value: "shopper_token_id" } } lineItems: [ { product: { identifier: { sku: "GY-5U3E-6VMU", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: false } }, { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-83C7-W5TDCA", "expiresAt": "1730878730", "lineItems": [ { "product": { "productId": { "value": "mr9ztf8f08nue1" }, "offerPrime": false, "amazonSku": { "value": "GY-5U3E-6VMU" }, "sku": { "value": "GY-5U3E-6VMU" } }, "deliveryOffer": { "summary": null, "details": { "id": "97e6c47a-68c9-439a-b65f-e50a4fb21312", "policy": { "messaging": { "messageText": "Sat, Nov 9" } }, "deliveryProvider": "AMAZON", "deliveryPreviewId": "0eaf3694-7b6c-48e3-b8f5-022ab0456c1e", "date": { "latest": "2024-11-09T07:23:49.930Z" } } }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } }, { "product": { "productId": { "value": "aq8rngp9qist23" }, "offerPrime": true, "amazonSku": { "value": "HJ-PMQE-1UDC" }, "sku": { "value": "HJ-PMQE-1UDC" } }, "deliveryOffer": { "summary": null, "details": { "id": "5060887210", "policy": { "messaging": { "messageText": "Tomorrow, Nov 6" } }, "deliveryProvider": "AMAZON", "deliveryPreviewId": "SIP-6316594-9921243", "date": { "latest": "2024-11-07T04:00:00Z" } } }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers For Only Prime Items

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } shopperIdentity: { lwaAccessToken: { value: "shopper_token_id" } } lineItems: [ { product: { identifier: { sku: "HJ-PMQE-1UDC", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } }, { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-82XK-EM66GK", "expiresAt": "1730878676", "lineItems": [ { "product": { "productId": { "value": "8qb6t1tzhzjmi6" }, "offerPrime": true, "amazonSku": { "value": "Y2-FWTY-AWDW" }, "sku": { "value": "Y2-FWTY-AWDW" } }, "deliveryOffer": { "summary": null, "details": { "id": "5060887210", "policy": { "messaging": { "messageText": "Tomorrow, Nov 6" } }, "deliveryProvider": "AMAZON", "deliveryPreviewId": "SIP-4315506-8490059", "date": { "latest": "2024-11-07T04:00:00Z" } } }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } }, { "product": { "productId": { "value": "aq8rngp9qist23" }, "offerPrime": true, "amazonSku": { "value": "HJ-PMQE-1UDC" }, "sku": { "value": "HJ-PMQE-1UDC" } }, "deliveryOffer": { "summary": null, "details": { "id": "5060887210", "policy": { "messaging": { "messageText": "Tomorrow, Nov 6" } }, "deliveryProvider": "AMAZON", "deliveryPreviewId": "SIP-4315506-8490059", "date": { "latest": "2024-11-07T04:00:00Z" } } }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers For Only Prime Item With No Shopper Information

Request

query { offers( input: { lineItems: [ { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-5M9P-EKSJCD", "expiresAt": "1730102061", "lineItems": [ { "product": { "productId": { "value": "8qb6t1tzhzjmi6" }, "offerPrime": true, "amazonSku": { "value": "Y2-FWTY-AWDW" }, "sku": { "value": "Y2-FWTY-AWDW" } }, "deliveryOffer": { "summary": { "deliveryCharge": { "amount": 0, "currencyCode": "USD" }, "deliveryMessage": { "locale": "en-US", "messageText": "Get it as soon as Tomorrow Oct 29" }, "deliveryProvider": "PRIME" }, "details": null }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers For Only Non Prime Item With Term Is Prime Eligible True

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } shopperIdentity: { lwaAccessToken: { value: "shopper_token_id" } } lineItems: [ { product: { identifier: { sku: "GY-5U3E-6VMU", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-7QJS-Q3QKPP", "expiresAt": "1730262270", "lineItems": [ { "product": { "productId": { "value": "mr9ztf8f08nue1" }, "offerPrime": false, "amazonSku": { "value": "GY-5U3E-6VMU" } }, "deliveryOffer": { "summary": null, "details": null }, "reversalOffers": { "summary": { "resolutionTypes": [], "message": { "title": { "value": "Not returnable" } } } } } ] } } ] } } }

Get Offers For Only Non Prime Item With No Shopper Information

Request

query { offers( input: { lineItems: [ { product: { identifier: { sku: "GY-5U3E-6VMU", } }, amount: { value: 1 } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-C2UU-XFNB6C", "expiresAt": "1730102596", "lineItems": [ { "product": { "productId": { "value": "mr9ztf8f08nue1" }, "offerPrime": false, "amazonSku": { "value": "GY-5U3E-6VMU" }, "sku": { "value": "GY-5U3E-6VMU" } }, "deliveryOffer": { "summary": null, "details": null }, "reversalOffers": { "summary": null } } ] } } ] } } }

Get Offers For Only Non Prime Item

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } shopperIdentity: { lwaAccessToken: { value: "shopper_token_id" } } lineItems: [ { product: { identifier: { sku: "GY-5U3E-6VMU", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: false } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-YZWX-HXBSVK", "expiresAt": "1730878603", "lineItems": [ { "product": { "productId": { "value": "mr9ztf8f08nue1" }, "offerPrime": false, "amazonSku": { "value": "GY-5U3E-6VMU" }, "sku": { "value": "GY-5U3E-6VMU" } }, "deliveryOffer": { "summary": null, "details": { "id": "1edd4dba-7bf5-4e51-82bf-4add495739c7", "policy": { "messaging": { "messageText": "Sat, Nov 9" } }, "deliveryProvider": "AMAZON", "deliveryPreviewId": "f2c0e3fa-3cf2-41a7-8889-84c99bf0eca9", "date": { "latest": "2024-11-09T07:21:43.738Z" } } }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers For Ip Based Location

Request

query { offers( input: { location: { ipAddress: "192.184.1.100" } lineItems: [ { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "data": { "offers": { "edges": [ { "node": { "id": "322-2J3X-VTPWSM", "expiresAt": "1730102913", "lineItems": [ { "product": { "productId": { "value": "8qb6t1tzhzjmi6" }, "offerPrime": true, "amazonSku": { "value": "Y2-FWTY-AWDW" }, "sku": { "value": "Y2-FWTY-AWDW" } }, "deliveryOffer": { "summary": { "deliveryCharge": { "amount": 0, "currencyCode": "USD" }, "deliveryMessage": { "locale": "en-US", "messageText": "Get it as soon as Tomorrow Oct 29" }, "deliveryProvider": "PRIME" }, "details": null }, "reversalOffers": { "summary": { "resolutionTypes": [ "RETURN" ], "message": { "title": { "value": "Free 30-day returns" } } } } } ] } } ] } } }

Get Offers With Invalid Shopper Token

Request

query { offers( input: { location: { shippingAddress: { name: "John Smith", streetAddress: "399 Boren Ave N", locality: "Seattle", region: "WA", countryCode: "US", postalCode: "98019" } } shopperIdentity: { lwaAccessToken: { value: "invalid_shopper_token_id" } } lineItems: [ { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "errors": [ { "message": "Invalid idPToken in the request", "locations": [ { "line": 2, "column": 3 } ], "path": [ "offers" ], "extensions": { "classification": { "type": "ValidationError", "code": "InvalidIdpToken", "details": { "message": null }, "errorType": "ValidationException", "errorCode": 400 } } } ], "data": { "offers": null } }

Get Offers With Invalid Ip Address

Request

query { offers( input: { location: { ipAddress: "1000.123.123.123" } lineItems: [ { product: { identifier: { sku: "Y2-FWTY-AWDW", } }, amount: { value: 1 }, deliveryTerms: { isPrimeEligible: true } } ] } ) { edges { node { id, expiresAt, lineItems { product { productId { value } offerPrime amazonSku { value } sku { value } } deliveryOffer { summary { deliveryCharge { amount currencyCode } deliveryMessage { locale messageText } deliveryProvider } details { id policy { messaging { messageText } } deliveryProvider deliveryPreviewId date { latest } } } reversalOffers { summary { resolutionTypes message { title { value } } } } } } } } }

Response

{ "errors": [ { "message": "Input request is not valid, the following issues were encountered: [/offers/input/location/ipAddress must match \"^((25[0-5]|(2[0-4]|1[0-9]|[1-9]|)[0-9])[.]?\\b){4}$\"]", "locations": [ { "line": 2, "column": 3 } ], "path": [ "offers" ], "extensions": { "classification": { "type": "ValidationError", "code": "ValidationError", "details": {}, "errorType": "ValidationException", "errorCode": 400 } } } ], "data": { "offers": null } }


Did this page help you?