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
@@ -40,7 +40,7 @@ properties:
|
||||
- production_failure
|
||||
- other
|
||||
tags:
|
||||
description: A list o tags to add to the Claim Item
|
||||
description: A list of tags to add to the Claim Item
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
@@ -51,7 +51,8 @@ properties:
|
||||
return_shipping:
|
||||
description: >-
|
||||
Optional details for the Return Shipping Method, if the items are to be
|
||||
sent back.
|
||||
sent back. Providing this field will result in a return being created and
|
||||
associated with the claim.
|
||||
type: object
|
||||
properties:
|
||||
option_id:
|
||||
@@ -61,7 +62,9 @@ properties:
|
||||
type: integer
|
||||
description: The price to charge for the Shipping Method.
|
||||
additional_items:
|
||||
description: The new items to send to the Customer when the Claim type is Replace.
|
||||
description: >-
|
||||
The new items to send to the Customer. This is only used if the claim's
|
||||
type is `replace`.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -70,13 +73,15 @@ properties:
|
||||
- quantity
|
||||
properties:
|
||||
variant_id:
|
||||
description: The ID of the Product Variant to ship.
|
||||
description: The ID of the Product Variant.
|
||||
type: string
|
||||
quantity:
|
||||
description: The quantity of the Product Variant to ship.
|
||||
description: The quantity of the Product Variant.
|
||||
type: integer
|
||||
shipping_methods:
|
||||
description: The Shipping Methods to send the additional Line Items with.
|
||||
description: >-
|
||||
The Shipping Methods to send the additional Line Items with. This is only
|
||||
used if the claim's type is `replace`.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
@@ -95,11 +100,13 @@ properties:
|
||||
type: object
|
||||
shipping_address:
|
||||
description: >-
|
||||
An optional shipping address to send the claim to. Defaults to the parent
|
||||
order's shipping address
|
||||
An optional shipping address to send the claimed items to. If not
|
||||
provided, the parent order's shipping address will be used.
|
||||
$ref: ./AddressPayload.yaml
|
||||
refund_amount:
|
||||
description: The amount to refund the Customer when the Claim type is `refund`.
|
||||
description: >-
|
||||
The amount to refund the customer. This is used when the claim's type is
|
||||
`refund`.
|
||||
type: integer
|
||||
no_notification:
|
||||
description: If set to true no notification will be send related to this Claim.
|
||||
@@ -107,3 +114,7 @@ properties:
|
||||
metadata:
|
||||
description: An optional set of key-value pairs to hold additional information.
|
||||
type: object
|
||||
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