createOrderClaimsStep - Medusa Core Workflows Reference
This documentation provides a reference to the createOrderClaimsStep. It belongs to the @medusajs/medusa/core-flows package.
This step creates one or more order claims.
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createOrderClaimsStep } from "@medusajs/medusa/core-flows"3 4const myWorkflow = createWorkflow(5 "my-workflow",6 () => {7 const data = createOrderClaimsStep([{8 "order_id": "order_123",9 "type": "replace"10 }])11 }12)
Input#
CreateOrderClaimDTO[]CreateOrderClaimDTO[]
CreateOrderClaimDTO[]CreateOrderClaimDTO[]order_idstringThe associated order's ID.
order_idstringtypeOrderClaimTypeThe type of the claim.
typeOrderClaimTypereturn_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 of the claim.
The items to be sent to the customer in replacement, if the
claim's type is replace.
replace.The shipping methods used to send the additional items to the customer,
if the claim's type is replace.
replace.The shipping methods used to send the items to be returned from the customer,
if the claim's type is replace.
replace.The amount to be refunded.
no_notificationbooleanOptionalWhether the customer should receive notifications related to updates
on the claim.
no_notificationbooleanOptionalcreated_bynull | stringOptionalThe id of the user that creates the order claim
created_bynull | stringOptionalOutput#
OrderClaimDTO[]OrderClaimDTO[]
OrderClaimDTO[]OrderClaimDTO[]idstringThe claim's ID.
idstringtypeOrderClaimTypeThe claim's type.
typeOrderClaimTypeorder_idstringThe ID of the associated order.
order_idstringorder_versionnumberThe version of the order when the claim is applied.
order_versionnumberdisplay_idnumberThe claim's display ID.
display_idnumberclaim_itemsany[]The items to be received from the customer.
claim_itemsany[]additional_itemsany[]The items to be sent to the customer
if the claim's type is replace.
additional_itemsany[]replace.metadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>The associated order.
The associated return, if the claim's type is replace.
replace.return_idstringOptionalThe ID of the associated return, if the claim's type is replace.
return_idstringOptionalreplace.no_notificationbooleanOptionalWhether the customer should receive notifications related
to updates on the claim.
no_notificationbooleanOptionalThe refund amount of the claim.
The raw refund amount of the claim.
created_bynull | stringOptionalThe id of the user that created the order claim
created_bynull | stringOptionalThe shipping methods used to send the additional items.
The claim's transactions if additional payment is required.
created_atstring | DateOptionalThe creation date of the claim.
created_atstring | DateOptionalupdated_atstring | DateOptionalThe update date of the claim.
updated_atstring | DateOptionaldeleted_atstring | DateOptionalThe deletion date of the claim.
deleted_atstring | DateOptionalcanceled_atstring | DateOptionalThe cancelation date of the claim.
canceled_atstring | DateOptionalWas this page helpful?