PackageInformationSummary

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

Summary of all the deliveryInformation

Fields

FieldDescription
state (String required)

Aggregated state of all the package information.

The value is constrained to one of the following | value | description
| | -----------------| ----------------------------------------------------------------------------------------------------------------------------------------| | PENDING | If any of the package deliveries is in the "PENDING" state, the overall state is "PENDING". | | IN_TRANSIT | If all package deliveries are currently either in "IN_TRANSIT" or some have already been completed, the overall state is "IN_TRANSIT". | | DELIVERED | If all package deliveries are completed, with at least one of them in the "DELIVERED" state, the overall state is "DELIVERED". | | CANCELLED | If all package deliveries are canceled, the overall state is "CANCELLED". |