📘 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.
Details about a refund.
Field Description aliases ([Alias] )A list of aliases associated with Buy With Prime Refund. This can include
unique identifiers for refunds in merchant's store.
createdAt (String )The Date Time in ISO 8601 format when a refund was created.
id (ID required )Unique identifier for a refund.
paymentDetails ([PaymentDetails] )Provides details about payments that are disbursed for a refund. Note that there could be multiple payments amongst
different payment methods for a refund.
refundFor (RefundFor )Captures the reason for which this refund is entitled to e.g. refunds against a lineItem, a return etc.
E.g. Refund issued for Two OrderLineItems
"refundFor": {
"orderLineItems": [
{
"lineItem": { // lineItem-1 object },
"amount": {"amount": 1}
},
{
"lineItem": { // lineItem-2 object },
"amount": {"amount": 2}
},
]
}
refundRequestReason (String )Captures the reason for which the refund was requested.
The value is constrained to one of the following
Value Description DELIVERED_NOT_RECEIVED Customer claims non-receipt of delivered item NOT_DELIVERED Item not delivered to customer DAMAGED_DEFECTIVE_ITEM Item received damaged or defective RECEIVED_ITEM_TOO_LATE Item received later than expected WRONG_ITEM_RECEIVED Customer received incorrect item EXPIRATION_DATE_PROBLEM Item has expiration date issue ITEM_MISSING One or more ordered items missing LOST_IN_TRANSIT Item lost; promised delivery date not passed CUSTOMER_NOT_SATISFIED_WITH_SERVICE Customer dissatisfied with service FOOD_SAFETY_ISSUE Food safety concern with item RETURN_RELATED_ERROR Error in return process (e.g., unexpected fees) RETURN_NO_SCAN Return not scanned; refund date passed BILLING_ERROR Billing issues (e.g., incorrect charges/tax) CANCELLED_ORDER Order cancelled or unfulfillable DELIVERY_ISSUES Problems with delivery execution RETURN_DROPPED_OFF_PICKED_UP Return successfully initiated RETURN_RECEIVED Return received and graded at fulfillment center OTHERS Exceptional cases not covered by other reasons
refundStatusReason (String )Captures the reason for updating the current state of the refund.
The value is constrained to one of the following
Value Description RETURN_WINDOW_EXPIRED Return request made after allowed period RETURN_NOT_AUTHORIZED Return denied due to unmet criteria (e.g., missing auth code) MISSING_ORIGINAL_PACKAGING Product not returned in original packaging USED_OR_DAMAGED_ITEM Returned item shows signs of use or damage ITEM_NOT_RETURNED_IN_ORIGINAL_CONDITION Item damaged or altered from original state MISSING_RECEIPT_OR_PROOF_OF_PURCHASE No receipt or proof of purchase provided by Shopper FAILURE_TO_PROVIDE_PROOF_OF_PURCHASE Failed to provide evidence of purchase (e.g., order number) NON_RETURNABLE_ITEMS Item is non-returnable (e.g., perishables, personalized) NON_REFUNDABLE_SHIPPING_FEES Shipping fees are non-refundable FRAUDULENT_RETURN_ATTEMPT Attempted dishonest manipulation of return process REFUND_ALREADY_PROCESSED Refund already issued for this order/item EXCESSIVE_RETURNS Shopper has history of excessive returns REFUND_VIOLATION Return violates platform's refund policy PARTIALLY_DECLINED Refund partially declined for some line items OTHERS Default code for merchant's other/unspecified reasons
refundTotal (RefundTotal )Represents the total amount that has been refunded or is in progress. Note that refundable charges can get added while
paymentDetails are not in terminal state. Once all the paymentDetails reach terminal state, refundTotal reflects
the total amount that was refunded.
state (String )Indicates the state of the refund.
The value is constrained to one of the following
value description PENDING Refund is created and pending. FAILURE Refund has failed. PARTIAL Refund is Partially successful. SUCCESS Refund is completed successfully. REJECTED Refund was rejected.
updatedAt (String )The Date Time in ISO 8601 format when a refund was last updated.
