chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
67f9429293
commit
4fb22e8ba5
@@ -5,23 +5,46 @@ description: >-
|
||||
can also be initiated by a store operator.
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
- amount
|
||||
- created_at
|
||||
- id
|
||||
- idempotency_key
|
||||
- metadata
|
||||
- note
|
||||
- order_id
|
||||
- payment_id
|
||||
- reason
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The refund's ID
|
||||
type: string
|
||||
example: ref_01G1G5V27GYX4QXNARRQCW1N8T
|
||||
order_id:
|
||||
description: The id of the Order that the Refund is related to.
|
||||
nullable: true
|
||||
type: string
|
||||
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
order:
|
||||
description: An order object. Available if the relation `order` is expanded.
|
||||
nullable: true
|
||||
type: object
|
||||
payment_id:
|
||||
description: The payment's ID if available
|
||||
nullable: true
|
||||
type: string
|
||||
example: pay_01G8ZCC5W42ZNY842124G7P5R9
|
||||
payment:
|
||||
description: Available if the relation `payment` is expanded.
|
||||
nullable: true
|
||||
type: object
|
||||
amount:
|
||||
description: The amount that has be refunded to the Customer.
|
||||
type: integer
|
||||
example: 1000
|
||||
note:
|
||||
description: An optional note explaining why the amount was refunded.
|
||||
nullable: true
|
||||
type: string
|
||||
example: I didn't like it
|
||||
reason:
|
||||
@@ -37,28 +60,26 @@ properties:
|
||||
- other
|
||||
example: return
|
||||
idempotency_key:
|
||||
type: string
|
||||
description: >-
|
||||
Randomly generated key used to continue the completion of the refund in
|
||||
case of failure.
|
||||
nullable: true
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user