8209d936a0
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>
105 lines
2.8 KiB
YAML
105 lines
2.8 KiB
YAML
type: object
|
|
description: The exchange's details.
|
|
x-schemaName: AdminExchange
|
|
required:
|
|
- id
|
|
- order_id
|
|
- created_at
|
|
- updated_at
|
|
- canceled_at
|
|
- deleted_at
|
|
- additional_items
|
|
- return_items
|
|
properties:
|
|
order_id:
|
|
type: string
|
|
title: order_id
|
|
description: The ID of the order the exchange is created for.
|
|
return_items:
|
|
type: array
|
|
description: The items returned (inbound) by the exchange.
|
|
items:
|
|
$ref: ./AdminReturnItem.yaml
|
|
additional_items:
|
|
type: array
|
|
description: The new items (outbound) sent by the exchange.
|
|
items:
|
|
$ref: ./BaseExchangeItem.yaml
|
|
no_notification:
|
|
type: boolean
|
|
title: no_notification
|
|
description: Whether to send the customer notifications when the exchange is updated.
|
|
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: ./AdminReturn.yaml
|
|
return_id:
|
|
type: string
|
|
title: return_id
|
|
description: The ID of the associated exchange.
|
|
id:
|
|
type: string
|
|
title: id
|
|
description: The exchange's ID.
|
|
display_id:
|
|
type: string
|
|
title: display_id
|
|
description: The exchange's display ID.
|
|
shipping_methods:
|
|
type: array
|
|
description: The shipping methods used to send the new (outbound) items.
|
|
items:
|
|
$ref: ./BaseOrderShippingMethod.yaml
|
|
transactions:
|
|
type: array
|
|
description: The exchange's transactions.
|
|
externalDocs:
|
|
url: >-
|
|
https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions
|
|
items:
|
|
$ref: ./BaseOrderTransaction.yaml
|
|
metadata:
|
|
type: object
|
|
description: The exchange's metadata, can hold custom key-value pairs.
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
title: created_at
|
|
description: The date that the exchange was created.
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
title: updated_at
|
|
description: The date that the exchange was updated.
|
|
order_version:
|
|
type: string
|
|
title: order_version
|
|
description: The version of the order once the exchange is applied.
|
|
created_by:
|
|
type: string
|
|
title: created_by
|
|
description: The ID of the user that created the exchange.
|
|
canceled_at:
|
|
type: string
|
|
title: canceled_at
|
|
description: The date the exchange was canceled.
|
|
format: date-time
|
|
deleted_at:
|
|
type: string
|
|
format: date-time
|
|
title: deleted_at
|
|
description: The date the exchange was deleted.
|
|
order:
|
|
$ref: ./BaseOrder.yaml
|
|
allow_backorder:
|
|
type: boolean
|
|
title: allow_backorder
|
|
description: >-
|
|
Whether variants that are out-of-stock can still be added as additional or
|
|
outbound items.
|