RefundDetails

Version 2024-11-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

Details about a refund.

Fields

FieldDescription
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 | Item was delivered, but the customer says they did not receive it.

                    |

| NOT_DELIVERED | Item was not delivered to the customer.

                           |

| DAMAGED_DEFECTIVE_ITEM | The item received by the customer was damaged or defective.

                   |

| RECEIVED_ITEM_TOO_LATE | The customer received the item too late.

                      |

| WRONG_ITEM_RECEIVED | The customer received the wrong item.

                  |

| EXPIRATION_DATE_PROBLEM | The item received by the customer has an expiration date problem.

                   |

| ITEM_MISSING | One or more items from the order are missing.

                    |

| LOST_IN_TRANSIT | The item was lost in transit, but the promised delivery date has not yet passed.

                   |

| CUSTOMER_NOT_SATISFIED_WITH_SERVICE | The customer is not satisfied with the service.

                  |

| FOOD_SAFETY_ISSUE | There is a food safety issue with the item.

                   |

| RETURN_RELATED_ERROR | There was an error with the customer's return, such as being charged a restocking fee or return shipping fees.

                  |

| RETURN_NO_SCAN | The customer's return has not been scanned by the carrier, and the refund date has passed.

                      |

| BILLING_ERROR | There was a billing error, such as an overcharge, undercharge, or incorrect tax.

                   |

| CANCELLED_ORDER | The item was cancelled by the shopper or is unfulfillable.

                   |

| DELIVERY_ISSUES | There were delivery issues, such as the delivery being rejected by the shopper, problems with the address, or problems with the shipping.
| | RETURN_DROPPED_OFF_PICKED_UP | The customer's return was successfully dropped off or picked up.

                  |

| RETURN_RECEIVED | The customer's return was received at the fulfillment center and grading is complete.

                   |

| OTHERS | This includes exceptional cases, such as when the customer was not able to return the item due to personal issues, the customer entered the wrong shipping address, or the customer returned the item to the merchant etc. |

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 | The return request was made after the allowed return period.
| | RETURN_NOT_AUTHORIZED | The return request was denied because it failed to meet the return criteria (e.g., missing return authorization code or exceeding the allowed return window). | | MISSING_ORIGINAL_PACKAGING | The product was not returned in its original packaging.
| | USED_OR_DAMAGED_ITEM | The returned item shows signs of use or damage.
| | ITEM_NOT_RETURNED_IN_ORIGINAL_CONDITION | The returned item is damaged or altered from its original state.
| | MISSING_RECEIPT_OR_PROOF_OF_PURCHASE | The shopper did not provide a receipt or proof of purchase.
| | FAILURE_TO_PROVIDE_PROOF_OF_PURCHASE | The shopper failed to provide evidence of their purchase (e.g., order number or receipt).
| | NON_RETURNABLE_ITEMS | The item is non-returnable (e.g., perishables, personalized products).
| | NON_REFUNDABLE_SHIPPING_FEES | The shipping fees are non-refundable.
| | FRAUDULENT_RETURN_ATTEMPT | The shopper attempted to manipulate the return process dishonestly.
| | REFUND_ALREADY_PROCESSED | A refund has already been issued for the same order or item.
| | EXCESSIVE_RETURNS | The shopper has a history of excessive returns.
| | REFUND_VIOLATION | The return violates the platform's refund policy in some way.
| | PARTIALLY_DECLINED | The refund request was partially declined, with some line items receiving a refund and others being declined.
| | OTHERS | The default reason code in case the merchant does not want to update or has other 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

valuedescription
PENDINGRefund is created and pending.
FAILURERefund has failed.
PARTIALRefund is Partially successful.
SUCCESSRefund is completed successfully.
REJECTEDRefund was rejected.
updatedAt (String)

The Date Time in ISO 8601 format when a refund was last updated.