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

# Delete a recommendation surface and its pins

> Deletes the surface named in the path. Side effects: deletes its Shopify metaobject, removes it from the recommendations config, deletes all its pins, and replicates the deletion to linked stores; other surfaces are unaffected and no recompute is queued. Returns `{deleted: <name>}`. Irreversible.



## OpenAPI

````yaml /api-reference/openapi/lite.json delete /recommendations/surfaces/{surface_name}
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /recommendations/surfaces/{surface_name}:
    delete:
      summary: Delete a recommendation surface and its pins
      description: >-
        Deletes the surface named in the path. Side effects: deletes its Shopify
        metaobject, removes it from the recommendations config, deletes all its
        pins, and replicates the deletion to linked stores; other surfaces are
        unaffected and no recompute is queued. Returns `{deleted: <name>}`.
        Irreversible.
      operationId: recsSurfaceDelete
      parameters:
        - schema:
            type: string
            pattern: ^[a-z0-9_-]+$
            description: The surface's URL-safe name.
          required: true
          description: The surface's URL-safe name.
          name: surface_name
          in: path
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: query
      responses:
        '200':
          description: The deleted surface's name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationSurfaceDeleted'
        '400':
          description: The request failed the schema, or the store has no Shopify config.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: Merchant not found for this caller, or no such surface.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    RecommendationSurfaceDeleted:
      type: object
      properties:
        deleted:
          type: string
      required:
        - deleted
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Shopify App Bridge session token of the embedded Depict: Search &
        Merchandising app. The shop in the token determines the merchant;
        merchant_id parameters must belong to that shop.

````