PackageInformationDetails
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 delivery information for certain items in an order. DeliveryInformationDetails in a pending state can divide into multiple DeliveryInformationDetails, each having its unique identifier.
Fields
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
aliases ([Alias]) | A list of aliases that are associated with the DeliveryInformationDetails. This could include unique identifier of the DeliveryInformationDetails in merchant's store or display Id of the DeliveryInformationDetails in the merchant store etc. The total number of aliases associated with a DeliveryInformationDetails are limited to 5. | ||||||||||
deliverFromAddress (ShippingAddress) | The address at which the delivery started. Consists of street address, locality/city, region/state, country code and postal code. | ||||||||||
id (ID required) | Identifier for the deliveryInformation | ||||||||||
packageInformationDetailsFor (PackageInformationDetailsFor) | Contains details about entities associated with the delivery information. | ||||||||||
packageTracker (PackageTracker) | Tracking information associated with the package delivery, such as the tracking ID, carrier code, estimated delivery date and milestones. | ||||||||||
reason (String) | Reason associated to the package information state. Currently, the field is only present for cancelled delivery information. The value is constrained to one of the following
| ||||||||||
state (String required) | Current status of deliveryInformation. The value is constrained to one of the following
|
Updated 2 days ago