@medusajs/core-flows
Version:
Set of workflow definitions for Medusa
31 lines • 969 B
TypeScript
/**
* The data to cancel a fulfillment.
*/
export type CancelFulfillmentWorkflowInput = {
/**
* The ID of the fulfillment to cancel.
*/
id: string;
};
export declare const cancelFulfillmentWorkflowId = "cancel-fulfillment-workflow";
/**
* This workflow cancels a fulfillment. It's used by the
* [Cancel Fulfillment Admin API Route](https://docs.medusajs.com/api/admin#fulfillments_postfulfillmentsidcancel).
*
* You can use this workflow within your own customizations or custom workflows, allowing you to
* cancel a fulfillment within your custom flows.
*
* @example
* const { result } = await cancelFulfillmentWorkflow(container)
* .run({
* input: {
* id: "ful_123"
* }
* })
*
* @summary
*
* Cancel a fulfillment.
*/
export declare const cancelFulfillmentWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<CancelFulfillmentWorkflowInput, unknown, any[]>;
//# sourceMappingURL=cancel-fulfillment.d.ts.map