Buy with Prime | Developer Documentation
Documentation

OrderLink

Version 2024-01-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

valuedescription
EXTERNAL_ORDER_MANAGEMENTURL for external order management (e.g., merchant's DTC)
EXTERNAL_ORDER_TRACKINGDirect link to order tracking page, if available
BWP_STOREFRONTURL for BuyWithPrime order management experience
AMAZON_STOREFRONTURL for Amazon.com order management experience
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 3 days ago