Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

1.3 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AdminPostOrdersOrderRefundsReq

internal.internal.AdminPostOrdersOrderRefundsReq

Schema

AdminPostOrdersOrderRefundsReq type: object required:

  • amount
  • reason properties: amount: description: The amount to refund. It should be less than or equal the refundable_amount of the order. type: integer reason: description: The reason for the Refund. type: string note: description: A note with additional details about the Refund. type: string no_notification: description: If set to true, no notification will be sent to the customer related to this Refund. type: boolean

Properties

amount

amount: number

Defined in

packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:93


no_notification

Optional no_notification: boolean

Defined in

packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:96


note

Optional note: string

Defined in

packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:95


reason

reason: string

Defined in

packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:94