PackageMilestoneStatus

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 the package milestone status.

Fields

FieldDescription
code (String required)

Represents the package milestone status codes.

The value is constrained to one of the following | value | description
| | -------------------- | -------------------------------------------------------------------------------------------------- | | PENDING | Package tracking information not available yet.
| | INFO_RECEIVED | Carrier received package delivery request from shipper. | | IN_TRANSIT | Carrier accepted the package from shipper and the delivery is in progress. | | DELAYED | Package is delayed.
| | OUT_FOR_DELIVERY | Carrier is about to deliver the package.
| | AVAILABLE_FOR_PICKUP | Package arrived at nearby pickup point and is available for pickup. | | DELIVERY_ATTEMPTED | Carrier attempted to deliver but failed, and usually leaves a notice and will try to delivery again. | | DELIVERED | Package is delivered successfully.
| | EXCEPTION | Exception occurred during package delivery.
| | LOST | Package is lost by carrier during package delivery.
| | UNDELIVERABLE | Package is undeliverable.
| | RETURN_TO_SENDER | Package is returning or returned to sender.
| | CUSTOMER_ACTION | Customer action is required to proceed with the package delivery. |

message (LocalizedString required)

Represents the localised detailed message describing the package milestone status.