Buy with Prime | Developer Documentation
Documentation

ReturnDeliveryDetails

Version 2024-04-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 details for returned items.

Fields

FieldDescription
id (ID required)

Identifier for the return delivery

reason (String)

Reason associated to the return delivery state. Currently, the field is only present for failed delivery.

The value is constrained to one of the following

valuedescription
CARRIER_REJECTEDReturn delivery is rejected by Carrier
SHIPMENT_LOSTReturn delivery shipment is lost
PICKUP_MISSEDReturn Package pickup unsuccessful
UNDELIVERABLEFailure during Delivery
EXCEPTIONSome unknown error has been encountered
returnDeliveryFor (ReturnFor)

Captures the association to entities against which this return delivery is created.

state (String required)

Current status of deliveryInformation.

The value is constrained to one of the following

valuedescription
PENDINGDelivery artefacts like label are created and Delivery is currently pending.
DROPPED_OFFDelivery package dropped off by customer at drop off location
PICKED_UPDelivery package picked up by the carrier from customer location
IN_TRANSITDelivery is currently in progress and tracking details have been added to the delivery.
DELIVEREDDelivery is successfully completed.
FAILEDDelivery has failed for one of the reasons mentioned in the reason.
trackingDetails (TrackingDetails)

Tracking information associated with the delivery, such as the tracking ID and carrier.

Updated 4 days ago