Locator

📘

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

Contains information to locate a location/s. E.g. 'locator for return drop-off locations'.

Fields

FieldDescription
locatorDisplayString (LocalizedString)

Represents displayable text for the location.

url (String required)

Represents location url. E.g. 'https://www.theupsstore.com/tools/find-a-store'.