chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,8 +1,8 @@
|
||||
title: Refund
|
||||
description: >-
|
||||
Refund represent an amount of money transfered back to the Customer for a
|
||||
A refund represents an amount of money transfered back to the customer for a
|
||||
given reason. Refunds may occur in relation to Returns, Swaps and Claims, but
|
||||
can also be initiated by a store operator.
|
||||
can also be initiated by an admin for an order.
|
||||
type: object
|
||||
required:
|
||||
- amount
|
||||
@@ -21,21 +21,23 @@ properties:
|
||||
type: string
|
||||
example: ref_01G1G5V27GYX4QXNARRQCW1N8T
|
||||
order_id:
|
||||
description: The id of the Order that the Refund is related to.
|
||||
description: The ID of the order this refund was created for.
|
||||
nullable: true
|
||||
type: string
|
||||
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
order:
|
||||
description: An order object. Available if the relation `order` is expanded.
|
||||
description: The details of the order this refund was created for.
|
||||
x-expandable: order
|
||||
nullable: true
|
||||
type: object
|
||||
payment_id:
|
||||
description: The payment's ID if available
|
||||
description: The payment's ID, if available.
|
||||
nullable: true
|
||||
type: string
|
||||
example: pay_01G8ZCC5W42ZNY842124G7P5R9
|
||||
payment:
|
||||
description: Available if the relation `payment` is expanded.
|
||||
description: The details of the payment associated with the refund.
|
||||
x-expandable: payment
|
||||
nullable: true
|
||||
type: object
|
||||
amount:
|
||||
@@ -82,3 +84,7 @@ properties:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
Reference in New Issue
Block a user