> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel a maintenance task run

> Asks the runner to stop for good at its next checkpoint.

Cancelling is not a rollback — work already committed stays committed.
What a cancelled run keeps is its cursor, so an operator can see how
far it got. A run that is still `cancelling` because its worker has
gone is cancelled outright by a second request.


**Required scope:** `write_maintenance_tasks` (for API-key authentication).



## OpenAPI

````yaml /api-reference/admin.yaml post /api/v3/admin/maintenance_task_runs/{maintenance_task_run_id}/cancellation
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Admin user login, logout, token refresh, and current user profile
  - name: Allowed Origins
    description: CORS allowlist for storefront and admin client origins
  - name: API Keys
    description: Secret and publishable API keys
  - name: Catalogs
  - name: Categories
    description: >-
      Hierarchical product categories — tree management, repositioning, and
      product assignments
  - name: Channels
    description: >-
      Sales channels, product publication across channels, and per-channel order
      routing rules
  - name: Collections
  - name: Commission Lines
  - name: Commission Rates
  - name: Companies
  - name: Custom Field Definitions
  - name: Custom Fields
    description: >-
      Custom field definitions for products, variants, customers, and other
      resources
  - name: Customer Groups
    description: >-
      Customer groups for segmenting customers (e.g. wholesale, VIP) used by
      pricing and promotions
  - name: Customers
    description: Customer profiles, addresses, credit cards, and store credits
  - name: Deliveries
  - name: Delivery Settings
    description: >-
      How orders ship — delivery methods and their rules, delivery profiles, and
      delivery zones
  - name: Email Templates
    description: >-
      Customer email templates, the email layout and shared partials: drafts,
      previews, publishing and history
  - name: Exports
    description: Async CSV exports of admin resources
  - name: Files
    description: Uploading the files that product media, imports, logos and documents use
  - name: Fulfillments
    description: Order fulfillments — shipments, fulfill, cancel, resume, split
  - name: Gift Cards
    description: Gift cards and gift card batches
  - name: Imports
    description: >-
      Async CSV imports of admin resources, with per-row status and failed-row
      retry
  - name: Integrations
  - name: Maintenance Tasks
    description: >-
      Operator-run data work — backfills, reindexes and upgrade steps — and the
      record of every run
  - name: Markets
    description: >-
      Markets — geographic groupings of countries used for pricing, tax, and
      fulfillment rules
  - name: Media
  - name: OAuth
  - name: Option Types
    description: >-
      Option types and option values used to build product variants (e.g. Size,
      Color)
  - name: Orders
    description: Orders, order items, applied gift cards, and applied store credits
  - name: Package Types
  - name: Payment Methods
    description: Configured payment providers and their available types
  - name: Payments
    description: Order payments — list, capture, void
  - name: Policies
    description: The store's legal documents — terms of service, privacy, returns, shipping
  - name: Price Lists
  - name: Pricing
    description: >-
      Prices and price lists for currency-, market-, and customer-group-specific
      pricing
  - name: Product Types
  - name: Products
    description: >-
      Products, taxons/categories, product custom field values, and bulk product
      operations
  - name: Promotions
    description: Promotions, promotion rules, promotion actions, and coupon codes
  - name: Purchase Orders
  - name: Reasons
    description: >-
      Merchant-owned vocabularies for why a return, claim, refund, cancellation
      or tax exemption happened
  - name: Refunds
    description: Order refunds
  - name: Reports
  - name: Seller Requirements
  - name: Sellers
  - name: Settings
    description: Store-level settings — store profile, tags, and configuration
  - name: Shipping Labels
  - name: Staff
    description: Admin users, roles, and invitations to the store
  - name: Stock
  - name: Stock Locations
    description: Warehouses and physical fulfillment locations
  - name: Stock Movements
  - name: Stock Transfers
  - name: Store Credits
    description: Prepaid customer balances across all customers, and each balance's ledger
  - name: Suppliers
  - name: Variants
    description: >-
      Product variants — the individual SKUs (size/color combinations) sold
      under a product
  - name: Webhooks
    description: Webhook endpoints and webhook delivery history
paths:
  /api/v3/admin/maintenance_task_runs/{maintenance_task_run_id}/cancellation:
    parameters:
      - name: maintenance_task_run_id
        in: path
        description: Maintenance task run ID
        required: true
        schema:
          type: string
    post:
      tags:
        - Maintenance Tasks
      summary: Cancel a maintenance task run
      description: >-
        Asks the runner to stop for good at its next checkpoint.


        Cancelling is not a rollback — work already committed stays committed.

        What a cancelled run keeps is its cursor, so an operator can see how

        far it got. A run that is still `cancelling` because its worker has

        gone is cancelled outright by a second request.



        **Required scope:** `write_maintenance_tasks` (for API-key
        authentication).
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          description: Bearer token for admin authentication
          schema:
            type: string
      responses:
        '200':
          description: maintenance task run cancelling
          content:
            application/json:
              example:
                id: mtr_UkLWZg9DAJ
                status: cancelling
                dry_run: false
                initiated_via: api
                tick_count: 0
                tick_total: null
                error_class: null
                error_message: null
                started_at: null
                ended_at: null
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                task_name: capture_methods
                duration: 0
                tallies: {}
                arguments: {}
                error_backtrace: null
                active: true
                admin_user_id: null
              schema:
                $ref: '#/components/schemas/MaintenanceTaskRun'
        '422':
          description: maintenance task run cannot be cancelled
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: a run with status succeeded cannot be cancelled
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - api_key: []
          bearer_auth: []
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: >-
            import { createAdminClient } from '@spree/admin-sdk'


            const client = createAdminClient({
              baseUrl: 'https://your-store.com',
              secretKey: 'sk_xxx',
            })


            const run = await
            client.maintenanceTaskRuns.cancel('mtr_UkLWZg9DAJ')
        - lang: bash
          label: Spree CLI
          source: >-
            spree api post
            /maintenance_task_runs/{maintenance_task_run_id}/cancellation -d '{
            ... }'
components:
  schemas:
    MaintenanceTaskRun:
      type: object
      properties:
        id:
          type: string
        status:
          anyOf:
            - type: string
              enum:
                - enqueued
                - running
                - interrupted
                - cancelling
                - cancelled
                - succeeded
                - errored
            - type: string
          description: The values listed are the built-in ones; extensions may add more.
        dry_run:
          type: boolean
        initiated_via:
          type: string
        tick_count:
          type: number
        tick_total:
          type: number
          nullable: true
        error_class:
          type: string
          nullable: true
        error_message:
          type: string
          nullable: true
        started_at:
          type: string
          nullable: true
        ended_at:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        task_name:
          type: string
        duration:
          type: number
          nullable: true
        tallies:
          type: object
        arguments:
          type: object
        error_backtrace:
          type: string
          nullable: true
        active:
          type: boolean
        admin_user_id:
          type: string
          nullable: true
        admin_user:
          $ref: '#/components/schemas/AdminUser'
      required:
        - id
        - status
        - dry_run
        - initiated_via
        - tick_count
        - tick_total
        - error_class
        - error_message
        - started_at
        - ended_at
        - created_at
        - updated_at
        - task_name
        - duration
        - tallies
        - arguments
        - error_backtrace
        - active
        - admin_user_id
      x-typelizer: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: record_not_found
            message:
              type: string
              example: Record not found
            details:
              type: object
              description: Field-specific validation errors
              nullable: true
              example:
                name:
                  - is too short
                  - is required
                email:
                  - is invalid
          required:
            - code
            - message
      required:
        - error
      example:
        error:
          code: validation_error
          message: Validation failed
          details:
            name:
              - is too short
            email:
              - is invalid
    AdminUser:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        full_name:
          type: string
          nullable: true
        selected_locale:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - active
            - locked
            - deactivated
        created_at:
          type: string
        updated_at:
          type: string
        last_active_at:
          type: string
          nullable: true
        sessions:
          type: array
          items:
            $ref: '#/components/schemas/Session'
        inviter:
          allOf:
            - $ref: '#/components/schemas/Actor'
          nullable: true
        avatar_url:
          type: string
          nullable: true
        roles:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Role ID
              name:
                type: string
                description: Role name, e.g. admin
            required:
              - id
              - name
          description: Role assignments on the current store
        stores:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Store ID
              name:
                type: string
                description: Store name
              code:
                type: string
                description: Store code
            required:
              - id
              - name
              - code
          description: Stores the staff member can access through a role assignment
      required:
        - id
        - email
        - first_name
        - last_name
        - full_name
        - selected_locale
        - status
        - created_at
        - updated_at
        - last_active_at
        - avatar_url
        - roles
        - stores
      x-typelizer: true
    Session:
      type: object
      properties:
        id:
          type: string
        ip_address:
          type: string
          nullable: true
        user_agent:
          type: string
          nullable: true
        last_active_at:
          type: string
      required:
        - id
        - ip_address
        - user_agent
        - last_active_at
      x-typelizer: true
    Actor:
      type: object
      properties:
        id:
          type: string
        type:
          anyOf:
            - type: string
              enum:
                - admin_user
                - api_key
            - type: string
          description: The values listed are the built-in ones; extensions may add more.
        label:
          type: string
          nullable: true
      required:
        - id
        - type
        - label
      x-typelizer: true
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.