ReturnPackageDetails

📘
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

Field Description

id (ID ^required)

Unique identifier for the return package

packageTracker (PackageTracker)

Tracking information associated with the return package delivery, such as the tracking ID, carrier code, estimated delivery date and milestones

reason (String)

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

The value is constrained to one of the following

value	description
CARRRIER_REJECTED	Return package delivery is rejected by Carrier
SHIPMENT_LOST	Return package shipment is lost
PICKUP_MISSED	Return package pickup unsuccessful
UNDELIVERABLE	Failure during return package delivery
OTHERS	Some unknown error has been encountered

returnPackageFor (ReturnFor)

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

state (String ^required)

Current status of packageInformation

The value is constrained to one of the following | value | description
| | -----------------| ---------------------------------------------------------------------------------------------------------------| | CREATED | Return package artifacts like return label are created and return package delivery is currently pending | | DROPPED_OFF | Return package dropped off by customer at drop off location | | IN_TRANSIT | Return package delivery is currently in progress and tracking details have been added to the return package | | DELIVERED | Return package delivery is successfully completed.
| | FAILED | Return package delivery has failed for one of the reasons mentioned in the reason. |

📘Important

Overview

Fields

📘
Important