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:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions

View File

@@ -1,8 +1,8 @@
title: Claim Order
title: Claim
description: >-
Claim Orders represent a group of faulty or missing items. Each claim order
consists of a subset of items associated with an original order, and can
contain additional information about fulfillments and returns.
A Claim represents a group of faulty or missing items. It consists of claim
items that refer to items in the original order that should be replaced or
refunded. It also includes details related to shipping and fulfillment.
type: object
required:
- canceled_at
@@ -53,15 +53,17 @@ properties:
- requires_action
default: not_fulfilled
claim_items:
description: The items that have been claimed
description: The details of the items that should be replaced or refunded.
type: array
x-expandable: claim_items
items:
$ref: ./ClaimItem.yaml
additional_items:
description: >-
Refers to the new items to be shipped when the claim order has the type
The details of the new items to be shipped when the claim's type is
`replace`
type: array
x-expandable: additional_items
items:
$ref: ./LineItem.yaml
order_id:
@@ -69,13 +71,15 @@ properties:
type: string
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
order:
description: An order object. Available if the relation `order` is expanded.
description: The details of the order that this claim was created for.
x-expandable: order
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
The details of the return associated with the claim if the claim's type is
`replace`.
x-expandable: return_order
nullable: true
type: object
shipping_address_id:
@@ -84,17 +88,22 @@ properties:
type: string
example: addr_01G8ZH853YPY9B94857DY91YGW
shipping_address:
description: Available if the relation `shipping_address` is expanded.
description: The details of the address that new items should be shipped to.
x-expandable: shipping_address
nullable: true
$ref: ./Address.yaml
shipping_methods:
description: The shipping methods that the claim order will be shipped with.
description: >-
The details of the shipping methods that the claim order will be shipped
with.
type: array
x-expandable: shipping_methods
items:
$ref: ./ShippingMethod.yaml
fulfillments:
description: The fulfillments of the new items to be shipped
type: array
x-expandable: fulfillments
items:
type: object
refund_amount:
@@ -126,6 +135,10 @@ 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
no_notification:
description: >-
Flag for describing whether or not notifications related to this should be