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

# Delete a product swap automation

> Permanently deletes a product swap automation configuration. Once deleted, the swap will no longer be applied to any subscription orders. Existing subscriptions that have already had products swapped are not affected.

**Deletion Behavior:**
- Permanently removes the swap automation
- Does not reverse past swaps that have already occurred
- Future orders will not have this swap applied
- Cannot be undone - swap configuration must be recreated if needed

**Impact on Subscriptions:**
- **Active Subscriptions**: Will continue with current products (no automatic reversion)
- **Future Orders**: Swap will not be applied
- **Past Orders**: Already swapped products remain unchanged
- **Queued Swaps**: Pending swaps for this automation are cancelled

**When to Delete:**
- Discontinuing a seasonal product rotation
- Removing outdated swap rules
- Cleaning up test or experimental swaps
- Product lines being discontinued
- Correcting misconfigured swaps

**Important Notes:**
- This operation is permanent and cannot be undone
- Consider deactivating instead of deleting if you might reuse the configuration
- Activity logs for past swaps are retained
- Customers are not automatically notified of swap deletion

**Best Practices:**
- Review affected subscriptions before deletion
- Consider communicating changes to affected customers
- Export swap configuration if you might need it later
- Use deactivation for temporary pauses instead of deletion

**Authentication:** Requires valid X-API-Key header



## OpenAPI

````yaml /subscription/admin-api-swagger.json delete /api/external/v2/product-swaps/{id}
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing subscriptions, payments, and
    related operations. These APIs allow you to programmatically manage
    subscription lifecycles, handle payments, configure products, and integrate
    subscription functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://subscription-admin.appstle.com
security: []
tags:
  - description: >-
      Core APIs for managing the complete subscription lifecycle including
      creation, updates, pausing, resuming, and cancellation of subscriptions.
    name: Subscription Management
  - description: >-
      APIs for managing subscription payment methods, processing payments,
      handling payment retries, and updating billing information.
    name: Subscription Payments
  - description: >-
      APIs for managing subscription contracts including delivery schedules,
      pricing, order notes, billing cycles, and shipping addresses.
    name: Subscription Contracts
  - description: >-
      APIs for managing products within subscriptions including adding,
      removing, updating quantities, and swapping products.
    name: Subscription Products
  - description: >-
      APIs for handling billing operations, payment processing, and financial
      transactions related to subscriptions.
    name: Billing & Payments
  - description: >-
      APIs for managing discounts and promotional codes applied to
      subscriptions.
    name: Subscription Discounts
  - description: >-
      APIs for managing one-time add-on products that can be purchased alongside
      recurring subscription items.
    name: Subscription One-Time Products
  - description: >-
      APIs for managing subscription plans, pricing tiers, and plan
      configurations.
    name: Subscription Plans
  - description: >-
      APIs for managing customizable product boxes and bundles where customers
      can select multiple items.
    name: Build-a-Box & Bundles
  - description: >-
      APIs for managing the product catalog including product information,
      variants, and inventory.
    name: Product Catalog
  - description: >-
      APIs for managing operational settings, configurations, and administrative
      functions.
    name: Operations & Settings
  - description: >-
      APIs powering the customer-facing portal where subscribers can manage
      their own subscriptions.
    name: Customer Portal
  - description: APIs for managing customer information, profiles, and account details.
    name: Customers
  - description: >-
      APIs for retrieving aggregated subscription data, customer subscription
      history, and account-level subscription information.
    name: Subscription Data
  - description: >-
      APIs for managing delivery profiles, shipping rates, free shipping
      configuration, and delivery method options on subscriptions.
    name: Delivery & Shipping
  - description: >-
      APIs for managing storefront customization including custom CSS, theme
      settings, label translations, and merchant-defined widget configuration.
    name: Customization
  - description: >-
      APIs for configuring cancellation flows, retention offers, cancellation
      reason management, and win-back automation.
    name: Customer Retention
paths:
  /api/external/v2/product-swaps/{id}:
    delete:
      tags:
        - Product Catalog
      summary: Delete a product swap automation
      description: >-
        Permanently deletes a product swap automation configuration. Once
        deleted, the swap will no longer be applied to any subscription orders.
        Existing subscriptions that have already had products swapped are not
        affected.


        **Deletion Behavior:**

        - Permanently removes the swap automation

        - Does not reverse past swaps that have already occurred

        - Future orders will not have this swap applied

        - Cannot be undone - swap configuration must be recreated if needed


        **Impact on Subscriptions:**

        - **Active Subscriptions**: Will continue with current products (no
        automatic reversion)

        - **Future Orders**: Swap will not be applied

        - **Past Orders**: Already swapped products remain unchanged

        - **Queued Swaps**: Pending swaps for this automation are cancelled


        **When to Delete:**

        - Discontinuing a seasonal product rotation

        - Removing outdated swap rules

        - Cleaning up test or experimental swaps

        - Product lines being discontinued

        - Correcting misconfigured swaps


        **Important Notes:**

        - This operation is permanent and cannot be undone

        - Consider deactivating instead of deleting if you might reuse the
        configuration

        - Activity logs for past swaps are retained

        - Customers are not automatically notified of swap deletion


        **Best Practices:**

        - Review affected subscriptions before deletion

        - Consider communicating changes to affected customers

        - Export swap configuration if you might need it later

        - Use deactivation for temporary pauses instead of deletion


        **Authentication:** Requires valid X-API-Key header
      operationId: deleteProductSwap
      parameters:
        - in: header
          name: X-API-Key
          required: false
          schema:
            type: string
        - in: path
          name: id
          required: true
          schema:
            format: int64
            type: integer
      responses:
        '204':
          description: Product swap successfully deleted - No content returned
        '400':
          content:
            application/json:
              example:
                detail: Product swap does not belong to this shop or ID is invalid
                status: 400
                title: Invalid id
                type: https://example.com/errors/bad-request
          description: Invalid product swap ID or swap doesn't belong to authenticated shop
        '401':
          content:
            application/json:
              example:
                detail: Valid X-API-Key header is required
                status: 401
                title: Authentication required
                type: https://example.com/errors/unauthorized
          description: Authentication required
        '403':
          content:
            application/json:
              example:
                detail: API key does not have permission to delete product swaps
                status: 403
                title: Insufficient permissions
                type: https://example.com/errors/forbidden
          description: Insufficient permissions to delete product swaps
        '404':
          content:
            application/json:
              example:
                detail: Product swap with ID 10782 not found
                status: 404
                title: Resource not found
                type: https://example.com/errors/not-found
          description: Product swap not found
      deprecated: true

````