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 delivery state. Currently, the field is only present for failed delivery. The value is constrained to one of the following
| ||||||||||||
returnPackageFor (ReturnFor required) | Captures the association to entities against which this return package is created. | ||||||||||||
state (String required) | Current status of deliveryInformation. The value is constrained to one of the following
| ||||||||||||
instructions ([LocalizedString]) | Instructions associated to return package. | ||||||||||||
labels ([ReturnLabel]) | Return labels associated to return package. | ||||||||||||
packageTrackerIdentifier (PackageTrackerIdentifier) | Represents the unique identifier of a package tracker. | ||||||||||||
rma (String required) | RMA associated with the return package. |
Updated about 17 hours ago