UNPKG

@medusajs/core-flows

Version:

Set of workflow definitions for Medusa

39 lines 1.4 kB
import { OrderChangeDTO, OrderWorkflow } from "@medusajs/types"; /** * The details of the draft order and its change to validate. */ export interface ValidateDraftOrderUpdateActionItemStepInput { /** * The details of the item removal action. */ input: OrderWorkflow.DeleteOrderEditItemActionWorkflowInput; /** * The order change to validate. */ orderChange: OrderChangeDTO; } /** * This step validates that an item change can be removed from a draft order edit. It throws an error if the * item change is not in the draft order edit, or if the item change is not adding or updating an item. * * :::note * * You can retrieve a draft order change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query), * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep). * * ::: * * @example * const data = validateDraftOrderRemoveActionItemStep({ * input: { * action_id: "action_123", * order_id: "order_123", * }, * orderChange: { * id: "orch_123", * // other order change details... * } * }) */ export declare const validateDraftOrderRemoveActionItemStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateDraftOrderUpdateActionItemStepInput, unknown>; //# sourceMappingURL=validate-draft-order-remove-action-item.d.ts.map