asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (automated) (#10017)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-11-11 12:30:22 +00:00
committed by GitHub
parent bc2d556c2c
commit 82fd93da17
28 changed files with 60 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

@@ -11441,8 +11441,8 @@ paths:
in: query
description: |-
Comma-separated fields that should be included in the returned data.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
without prefix it will replace the entire default fields.
required: false
schema:
type: string
@@ -48352,7 +48352,7 @@ components:
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
description: The ID of the associated product's type.
AdminOrderPreview:
type: object
description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
@@ -55950,7 +55950,7 @@ components:
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
description: The ID of the associated product's type.
BaseOrderLineItemAdjustment:
type: object
description: The adjustment's details.
@@ -58344,7 +58344,7 @@ components:
display_id:
type: number
title: display_id
description: The order's display id.
description: The order's display ID.
OrderAddress:
type: object
description: The address's details.
@@ -58807,19 +58807,8 @@ components:
title: no_notification
description: Whether to send the customer notifications when the exchange is updated.
difference_due:
oneOf:
- type: string
title: difference_due
description: The exchange's difference due.
- type: number
title: difference_due
description: The exchange's difference due.
- type: string
title: difference_due
description: The exchange's difference due.
- type: number
title: difference_due
description: The exchange's difference due.
type: number
title: difference_due
description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer.
return:
$ref: '#/components/schemas/Return'
@@ -59171,7 +59160,7 @@ components:
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
description: The ID of the associated product's type.
OrderLineItemAdjustment:
type: object
description: The line item adjustment's details.
@@ -59702,19 +59691,8 @@ components:
- received
- partially_received
refund_amount:
oneOf:
- type: string
title: refund_amount
description: The return order's refund amount.
- type: number
title: refund_amount
description: The return order's refund amount.
- type: string
title: refund_amount
description: The return order's refund amount.
- type: number
title: refund_amount
description: The return order's refund amount.
type: number
title: refund_amount
description: The amount refunded by this return.
order_id:
type: string
@@ -65691,7 +65669,7 @@ components:
product_type_id:
type: string
title: product_type_id
description: The item's product type id.
description: The ID of the associated product's type.
StoreOrderResponse:
type: object
description: The order's details.
@@ -68561,7 +68539,7 @@ components:
description: The customer's phone.
metadata:
type: object
description: The customer's metadata.
description: The customer's metadata, can hold custom key-value pairs.
UpdateAddress:
type: object
description: The details to update in the address.