Loading...
Was this page helpful?
Loading...
createOrderExchangesStep - Medusa Core Workflows Reference
This documentation provides a reference to the createOrderExchangesStep. It belongs to the @medusajs/medusa/core-flows package.
This step creates one or more order exchanges.
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createOrderExchangesStep } from "@medusajs/medusa/core-flows"3 4const myWorkflow = createWorkflow(5 "my-workflow",6 () => {7 const data = createOrderExchangesStep([{8 "order_id": "order_123"9 }])10 }11)
Input#
CreateOrderExchangeDTO[]CreateOrderExchangeDTO[]
CreateOrderExchangeDTO[]CreateOrderExchangeDTO[]order_idstringThe associated order's ID.
order_idstringreturn_idstringOptionalThe associated return's ID.
return_idstringOptionalclaim_idstringOptionalThe associated claim's ID.
claim_idstringOptionalexchange_idstringOptionalThe associated exchange's ID.
exchange_idstringOptionaldescriptionstringOptionalThe description of the action.
descriptionstringOptionalinternal_notestringOptionalThe internal note of the action.
internal_notestringOptionalreferencestringOptionalThe name of the data model the action
references. For example, return.
referencestringOptionalreturn.reference_idstringOptionalThe ID of the record of the data model
specified in reference.
For example, if reference is return, the
value is return_123.
reference_idstringOptionalreference is return, the
value is return_123.metadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalThe items to be sent to the customer.
The shipping methods used to send the additional items
to the customer.
The shipping methods used to return items from the customer.
The difference due of the exchange.
- If less than
0, the merchant owes the customer this amount.
- If greater than
0, the customer owes the merchange this amount.
- If equal to
0, no payment is required by either sides.
- If less than
0, the merchant owes the customer this amount. - If greater than
0, the customer owes the merchange this amount. - If equal to
0, no payment is required by either sides.
allow_backorderbooleanOptionalWhether backorder is allowed for the exchange's items.
allow_backorderbooleanOptionalno_notificationbooleanOptionalWhether the customer should receive notifications related to
updates on the exchange.
no_notificationbooleanOptionalcreated_bynull | stringOptionalThe id of the user that creates the order exchange
created_bynull | stringOptionalOutput#
OrderExchangeDTO[]OrderExchangeDTO[]
OrderExchangeDTO[]OrderExchangeDTO[]idstringThe exchange's ID.
idstringorder_idstringThe associated order's ID.
order_idstringorder_versionnumberThe version of the order when the exchange is applied.
order_versionnumberdisplay_idnumberThe exchange's display ID.
display_idnumberadditional_itemsany[]The items to be sent to the customer.
additional_itemsany[]metadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>The associated order.
no_notificationbooleanOptionalWhether the customer should receive notifications related
to updates on the exchange.
no_notificationbooleanOptionalThe difference due of the order exchange.
- If less than
0, the merchant owes the customer this amount.
- If greater than
0, the customer owes the merchange this amount.
- If equal to
0, no payment is required by either sides.
- If less than
0, the merchant owes the customer this amount. - If greater than
0, the customer owes the merchange this amount. - If equal to
0, no payment is required by either sides.
The raw difference due of the order exchange.
- If less than
0, the merchant owes the customer this amount.
- If greater than
0, the customer owes the merchange this amount.
- If equal to
0, no payment is required by either sides.
- If less than
0, the merchant owes the customer this amount. - If greater than
0, the customer owes the merchange this amount. - If equal to
0, no payment is required by either sides.
allow_backorderbooleanOptionalWhether the variants that are out of stock can be added to the exchange.
allow_backorderbooleanOptionalThe associated return.
return_idstringOptionalThe associated return's ID.
return_idstringOptionalcreated_bynull | stringOptionalThe id of the user that created the order exchange
created_bynull | stringOptionalThe shipping methods used to send the additional items.
The exchange's transactions if additional payment is required.
created_atstring | DateOptionalThe creation date of the exchange.
created_atstring | DateOptionalupdated_atstring | DateOptionalThe update date of the exchange.
updated_atstring | DateOptionaldeleted_atstring | DateOptionalThe deletion date of the exchange.
deleted_atstring | DateOptionalcanceled_atstring | DateOptionalThe cancelation date of the exchange.
canceled_atstring | DateOptional