AliasInput

📘
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.

Arguments

Argument Description

Argument	Description
`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)	You can use Alias type to provide more information about the alias, such as client managed namespaces like EXTERNAL_ID, EXTERNAL_DISPLAY_ID etc. This is an open field that accepts any custom value. It does not have a predefined set of allowed values. The size should be greater than or equal to 1 and less than or equal to 50.

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)

You can use Alias type to provide more information about the alias, such as client managed namespaces like EXTERNAL_ID, EXTERNAL_DISPLAY_ID etc. This is an open field that accepts any custom value. It does not have a predefined set of allowed values.

The size should be greater than or equal to 1 and less than or equal to 50.

📘Important

Overview

Arguments

📘
Important