chore(docs): Generated API Reference (#3211)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
9997485c55
commit
14b2de94e2
@@ -5,27 +5,41 @@ description: >-
|
||||
contain additional information about fulfillments and returns.
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
- canceled_at
|
||||
- created_at
|
||||
- deleted_at
|
||||
- fulfillment_status
|
||||
- id
|
||||
- idempotency_key
|
||||
- metadata
|
||||
- no_notification
|
||||
- order_id
|
||||
- payment_status
|
||||
- refund_amount
|
||||
- shipping_address_id
|
||||
- type
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The claim's ID
|
||||
type: string
|
||||
example: claim_01G8ZH853Y6TFXWPG5EYE81X63
|
||||
type:
|
||||
description: The claim's type
|
||||
type: string
|
||||
enum:
|
||||
- refund
|
||||
- replace
|
||||
payment_status:
|
||||
type: string
|
||||
description: The status of the claim's payment
|
||||
type: string
|
||||
enum:
|
||||
- na
|
||||
- not_refunded
|
||||
- refunded
|
||||
default: na
|
||||
fulfillment_status:
|
||||
description: The claim's fulfillment status
|
||||
type: string
|
||||
enum:
|
||||
- not_fulfilled
|
||||
@@ -56,18 +70,22 @@ properties:
|
||||
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
order:
|
||||
description: An order object. Available if the relation `order` is expanded.
|
||||
nullable: true
|
||||
type: object
|
||||
return_order:
|
||||
description: >-
|
||||
A return object. Holds information about the return if the claim is to be
|
||||
returned. Available if the relation 'return_order' is expanded
|
||||
nullable: true
|
||||
type: object
|
||||
shipping_address_id:
|
||||
description: The ID of the address that the new items should be shipped to
|
||||
nullable: true
|
||||
type: string
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
shipping_address:
|
||||
description: Available if the relation `shipping_address` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Address.yaml
|
||||
shipping_methods:
|
||||
description: The shipping methods that the claim order will be shipped with.
|
||||
@@ -78,43 +96,49 @@ properties:
|
||||
description: The fulfillments of the new items to be shipped
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Fulfillment.yaml
|
||||
type: object
|
||||
refund_amount:
|
||||
description: The amount that will be refunded in conjunction with the claim
|
||||
nullable: true
|
||||
type: integer
|
||||
example: 1000
|
||||
canceled_at:
|
||||
description: The date with timezone at which the claim was canceled.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
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.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
no_notification:
|
||||
description: >-
|
||||
Flag for describing whether or not notifications related to this should be
|
||||
send.
|
||||
nullable: true
|
||||
type: boolean
|
||||
example: false
|
||||
idempotency_key:
|
||||
type: string
|
||||
description: >-
|
||||
Randomly generated key used to continue the completion of the cart
|
||||
associated with the claim in case of failure.
|
||||
nullable: true
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
|
||||
Reference in New Issue
Block a user