Buy with Prime | Developer Documentation
Documentation

OrderLink

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

Represents the URL to manage an order.

Fields

FieldDescription
destinationType (String required)

Denotes the type of link to manage the order. The value is constrained to one of the following

| value | description
| | ---------------------------| --------------------------------------------------------------------------------------------------------------------| | EXTERNAL_ORDER_MANAGEMENT | The URL to manage the order on external experience as a shopper. (non-Amazon owned e.g., merchant's DTC storefront) | | EXTERNAL_ORDER_TRACKING | The URL to directly link to order tracking page if any associated with the order. | | BWP_STOREFRONT | The URL to manage the order on BuyWithPrime owned experience as a shopper. | | AMAZON_STOREFRONT | The URL to manage the order on Amazon.com owned experience as a shopper. |

displayMessage (String)

An optional string that could be used to display a Call to Action

url (String required)

URL associated with managing the order.

Updated about 8 hours ago