daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
3.8 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminPostOrdersOrderSwapsReq
internal.internal.AdminPostOrdersOrderSwapsReq
Schema
AdminPostOrdersOrderSwapsReq type: object required:
- return_items
properties:
return_items:
description: The Line Items to associate with the swap's return.
type: array
items:
type: object
required:
- item_id
- quantity
properties:
item_id:
description: The ID of the Line Item that will be returned.
type: string
quantity:
description: The number of items that will be returned
type: integer
reason_id:
description: The ID of the Return Reason to use.
type: string
note:
description: An optional note with information about the Return.
type: string
return_shipping:
description: The shipping method associated with the swap's return.
type: object
required:
- option_id
properties:
option_id:
type: string
description: The ID of the Shipping Option to create the Shipping Method from.
price:
type: integer
description: The price to charge for the Shipping Method.
additional_items:
description: The new items to send to the Customer.
type: array
items:
type: object
required:
- variant_id
- quantity properties: variant_id: description: The ID of the Product Variant. type: string quantity: description: The quantity of the Product Variant. type: integer custom_shipping_options: description: An array of custom shipping options to potentially create a Shipping Method from to send the additional items. type: array items: type: object required:
- option_id
- price
properties:
option_id:
description: The ID of the Shipping Option.
type: string
price:
description: The custom price of the Shipping Option.
type: integer
no_notification:
description: If set to
true, no notification will be sent to the customer related to this Swap. type: boolean allow_backorder: description: If set totrue, swaps can be completed with items out of stock type: boolean default: true
- option_id
properties:
option_id:
type: string
description: The ID of the Shipping Option to create the Shipping Method from.
price:
type: integer
description: The price to charge for the Shipping Method.
additional_items:
description: The new items to send to the Customer.
type: array
items:
type: object
required:
Properties
additional_items
• Optional additional_items: AdditionalItem[]
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:164
allow_backorder
• Optional allow_backorder: boolean
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:168
custom_shipping_options
• Optional custom_shipping_options: CustomShippingOption[]
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:165
no_notification
• Optional no_notification: boolean
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:166
return_items
• return_items: ReturnItem[]
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:161
return_location_id
• Optional return_location_id: string
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:167
return_shipping
• Optional return_shipping: ReturnShipping
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:162
sales_channel_id
• Optional sales_channel_id: string
Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:163