Orders

List the refunds of an order

Changed on

Every refund of the order, newest first: method, status, amount in dollars, reason and the credit note number.

get/admin/orders/{order_id}/refunds

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/admin/orders/{order_id}/refunds
  • Auth: HTTP bearer

Path parameters

order_idstring uuid required
Example:b3c9b4c0-d2d8-43cc-b96c-3aea9f8ae128

Response

Refunds retrieved successfully

idstring uuid required
method'CARD' | 'CREDITS' | 'WIRE' | 'BILL_COM' required
amountnumber required
status'REQUESTED' | 'PENDING' | 'REQUIRES_ACTION' | 'SUCCEEDED' | 'FAILED' | 'CANCELED' required
reason'ITEM_CANCELLED' | 'SWAP' | 'GOODWILL' | 'STRIPE_DASHBOARD' required
origin'APP' | 'STRIPE_DASHBOARD' required
order_item_idstring uuid nullable required
swap_idstring uuid nullable required
stripe_refund_idstring nullable required
failure_reasonstring nullable required
replaced_by_refund_idstring uuid nullable required
needs_attentionboolean required
created_atstring required
credit_note_reference_numberstring nullable required

Changes