DeliveryInformationStateInput

📘
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

Input for specifying delivery state updates. (Only enabled in Sandbox)

Arguments

Argument Description

reason (DeliveryInformationDetailsReasonInput)

Reason associated to the delivery information state. Currently, the field is only present for cancelled delivery information.

The value is constrained to one of the following

value	description
CUSTOMER_REQUESTED	Cancellation is requested by Customer
UNFULFILLABLE	Unable to Fulfill
UNDELIVERABLE	Failure during Delivery

state (DeliveryInformationDetailsStateInput ^required)

Current status of deliveryInformation.

The value is constrained to one of the following

value	description
PENDING	The process of picking items has started and Delivery is currently pending.
IN_TRANSIT	Delivery is currently in progress and tracking details have been added to the delivery.
DELIVERED	Delivery is successfully completed.
CANCELLED	Delivery has been canceled for one of the reasons mentioned in the `cancellationReason`.

📘Important

Overview

Arguments

📘
Important