cancelOrderFulfillmentStep - Medusa Core Workflows Reference

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

This step cancels an order's fulfillment.

Example#

Code
1const data = cancelOrderFulfillmentStep({2  order_id: "order_123",3  items: [4    {5      id: "item_123",6      quantity: 17    }8  ]9})

CancelOrderFulfillmentDTOCancelOrderFulfillmentDTO

The details to cancel a fulfillment of an order, return, exchange, or claim.

order_idstring

The associated order's ID.

The items whose fulfillment is canceled.

return_idstringOptional

The associated return's ID.

claim_idstringOptional

The associated claim's ID.

exchange_idstringOptional

The associated exchange's ID.

descriptionstringOptional

The description of the action.

internal_notestringOptional

The internal note of the action.

referencestringOptional

The name of the data model the action references. For example, return.

reference_idstringOptional

The ID of the record of the data model specified in reference. For example, if reference is return, the value is return_123.

created_bynull | stringOptional

The user or customer that created this action.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.