fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
79 lines
2.2 KiB
YAML
79 lines
2.2 KiB
YAML
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 to `true`, swaps can be completed with items out of stock
|
|
type: boolean
|
|
default: true
|