createOrderClaimItemsFromActionsStep - Medusa Core Workflows Reference

This documentation provides a reference to the createOrderClaimItemsFromActionsStep. It belongs to the @medusajs/medusa/core-flows package.

This step creates claim items from a change action.

Note: You can retrieve an order change action details using Query, or useQueryGraphStep.

Example#

Code
1const data = createOrderClaimItemsFromActionsStep({2  claimId: "claim_123",3  changes: [4    {5      id: "orchact_123",6      // other order change action details...7    }8  ]9})

Input#

CreateOrderClaimItemsFromActionsInputCreateOrderClaimItemsFromActionsInput

The details of creating the claim items from a change action.

changesOrderChangeActionDTO[]

The change actions to create claim items from.

claimIdstring

The ID of the claim to create the items for.

Output#

OrderClaimItemDTO[]OrderClaimItemDTO[]

idstring

The ID of the order claim item.

claim_idstring

The associated claim's ID.

order_idstring

The associated order's ID.

item_idstring

The associated item's ID.

itemOrderLineItemDTO

The associated item.

quantitynumber

The quantity of the order claim item

reasonClaimReason

The reason of the order claim item

raw_quantityBigNumberRawValue

The raw quantity of the order claim item

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

created_atstring | DateOptional

The creation date of the order claim item

updated_atstring | DateOptional

The update date of the order claim item