Buy with Prime | Developer Documentation
Documentation

Alias

📘

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

A client managed Alias to be associated with the Buy with Prime Order or entities. Going forward clients can use this alias to identify an order and need not have to keep track of Buy with Prime generated intrinsic order identifier.

Fields

FieldDescription
aliasId (ID required)

The provided alias ID controlled by clients, this has to be unique with the provided alias type in the context of Buy with Prime merchant's store otherwise will result in validation error.

aliasType (String required)

Alias type could provide more information about the alias. Like client managed namespaces like EXTERNAL_ID, EXTERNAL_DISPLAY_ID etc.

Updated 3 days ago