Loading...
Was this page helpful?
Loading...
orderClaimItemValidationStep - Medusa Core Workflows Reference
This documentation provides a reference to the orderClaimItemValidationStep. It belongs to the @medusajs/medusa/core-flows package.
This step validates that claim items can be added to a claim. If the order or claim is canceled, or the order change is not active, the step will throw an error.
Note: You can retrieve an order, order claim, and order change details using Query,
or useQueryGraphStep.
Example#
Input#
orderOrderDTOThe order details.
orderOrderDTOidstringThe ID of the order.
idstringversionnumberThe version of the order.
versionnumberdisplay_idnumberThe order's display ID.
display_idnumberstatusOrderStatusThe status of the order.
statusOrderStatuscurrency_codestringThe currency of the order
currency_codestringcreated_atstring | DateWhen the order was created.
created_atstring | Dateupdated_atstring | DateWhen the order was updated.
updated_atstring | Dateoriginal_item_totalBigNumberValueThe original item total of the order.
original_item_totalBigNumberValueoriginal_item_subtotalBigNumberValueThe original item subtotal of the order.
original_item_subtotalBigNumberValueoriginal_item_tax_totalBigNumberValueThe original item tax total of the order.
original_item_tax_totalBigNumberValueitem_totalBigNumberValueThe item total of the order.
item_totalBigNumberValueitem_subtotalBigNumberValueThe item subtotal of the order.
item_subtotalBigNumberValueitem_tax_totalBigNumberValueThe item tax total of the order.
item_tax_totalBigNumberValueitem_discount_totalBigNumberValueThe item discount total of the order.
item_discount_totalBigNumberValueoriginal_totalBigNumberValueThe original total of the order.
original_totalBigNumberValueoriginal_subtotalBigNumberValueThe original subtotal of the order.
original_subtotalBigNumberValueoriginal_tax_totalBigNumberValueThe original tax total of the order.
original_tax_totalBigNumberValuetotalBigNumberValueThe total of the order.
totalBigNumberValuesubtotalBigNumberValueThe subtotal of the order. (Excluding taxes)
subtotalBigNumberValuetax_totalBigNumberValueThe tax total of the order.
tax_totalBigNumberValuediscount_subtotalBigNumberValueThe discount subtotal of the order.
discount_subtotalBigNumberValuediscount_totalBigNumberValueThe discount total of the order.
discount_totalBigNumberValuediscount_tax_totalBigNumberValueThe discount tax total of the order.
discount_tax_totalBigNumberValuecredit_line_totalBigNumberValueThe credit line total of the order.
credit_line_totalBigNumberValuegift_card_totalBigNumberValueThe gift card total of the order.
gift_card_totalBigNumberValuegift_card_tax_totalBigNumberValueThe gift card tax total of the order.
gift_card_tax_totalBigNumberValueshipping_totalBigNumberValueThe shipping total of the order.
shipping_totalBigNumberValueshipping_subtotalBigNumberValueThe shipping subtotal of the order.
shipping_subtotalBigNumberValueshipping_tax_totalBigNumberValueThe shipping tax total of the order.
shipping_tax_totalBigNumberValueshipping_discount_totalBigNumberValueThe shipping discount total of the order.
shipping_discount_totalBigNumberValueoriginal_shipping_totalBigNumberValueThe original shipping total of the order.
original_shipping_totalBigNumberValueoriginal_shipping_subtotalBigNumberValueThe original shipping subtotal of the order.
original_shipping_subtotalBigNumberValueoriginal_shipping_tax_totalBigNumberValueThe original shipping tax total of the order.
original_shipping_tax_totalBigNumberValueThe active order change, if any.
region_idstringOptionalThe ID of the region the order belongs to.
region_idstringOptionalcustomer_idstringOptionalThe ID of the customer on the order.
customer_idstringOptionalsales_channel_idstringOptionalThe ID of the sales channel the order belongs to.
sales_channel_idstringOptionalemailstringOptionalThe email of the order.
emailstringOptionalThe associated shipping address.
The associated billing address.
The associated order details / line items.
The associated shipping methods
The tramsactions associated with the order
The credit lines for an order
The summary of the order totals.
is_draft_orderbooleanOptionalWhether the order is a draft order.
is_draft_orderbooleanOptionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>Optionalcanceled_atstring | DateOptionalWhen the order was canceled.
canceled_atstring | DateOptionaldeleted_atstring | DateOptionalWhen the order was deleted.
deleted_atstring | DateOptionalorderClaimOrderClaimDTOThe claim details.
orderClaimOrderClaimDTOidstringThe 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 | DateOptionalorderChangeOrderChangeDTOThe order change details.
orderChangeOrderChangeDTOidstringThe ID of the order change
idstringversionnumberThe version of the order change
versionnumberorder_idstringThe ID of the associated order
order_idstringreturn_idstringThe ID of the associated return order
return_idstringexchange_idstringThe ID of the associated exchange order
exchange_idstringclaim_idstringThe ID of the associated claim order
claim_idstringThe associated order
The associated return order
The associated exchange order
The associated claim order
The actions of the order change
statusOrderChangeStatusThe status of the order change
statusOrderChangeStatusrequested_bynull | stringThe requested by of the order change
requested_bynull | stringrequested_atnull | string | DateWhen the order change was requested
requested_atnull | string | Dateconfirmed_bynull | stringThe confirmed by of the order change
confirmed_bynull | stringconfirmed_atnull | string | DateWhen the order change was confirmed
confirmed_atnull | string | Datedeclined_bynull | stringThe declined by of the order change
declined_bynull | stringdeclined_reasonnull | stringThe declined reason of the order change
declined_reasonnull | stringmetadatanull | Record<string, unknown>The metadata of the order change
metadatanull | Record<string, unknown>declined_atnull | string | DateWhen the order change was declined
declined_atnull | string | Datecanceled_bynull | stringThe canceled by of the order change
canceled_bynull | stringcanceled_atnull | string | DateWhen the order change was canceled
canceled_atnull | string | Datecreated_atstring | DateWhen the order change was created
created_atstring | Dateupdated_atstring | DateWhen the order change was updated
updated_atstring | Datechange_type"return" | "exchange" | "claim" | "edit" | "transfer"OptionalThe type of the order change
change_type"return" | "exchange" | "claim" | "edit" | "transfer"Optional