OffersInput

📘

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

Specifies the input fields required to query offers.

Arguments

ArgumentDescription
baseOfferId (String)

Note: This field is experimental and may change in the future. Use with caution!

This field represents the identifier of a previously retrieved offer and is used to perform offer refinement. It allows you to refine an existing offer based on updated inputs such as the shopper's identity and delivery location. When provided, the system will generate a new offer using the latest context while using the referenced offer as a starting point.

lineItems ([OfferLineItemInput])

A list of the offer's line items.

location (DeliveryLocationInput)

Shopper delivery location information.

shopperIdentity (IdentityTokenInput)

Shopper Identity for benefits information.