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

# Excluir um produto

> Operação sobre produtos da conta.

Produtos vinculados a pedidos, checkouts ou conteúdo são arquivados e retornam o objeto completo com `status: "archived"`. Sem esses vínculos, a resposta confirma a exclusão com `deleted: true`.

Requer `products:write` ou `write`. Veja [campos, relacionamentos e eventos](https://docs.hubfy.io/api-reference/products/object.md).


## OpenAPI

````yaml api/v1/openapi.yaml DELETE /v1/products/{id}
openapi: 3.1.0
info:
  title: Hubfy API
  version: 1.0.0
  description: >-
    API pública da Hubfy para produtos, preços, arquivos, clientes, pedidos e
    links de pagamento. Autenticação por chave da conta. GET consulta; POST
    cria, atualiza ou executa ações; DELETE remove ou desativa. O ambiente usa
    dados reais, sem sandbox separado. Consulte os fundamentos, os objetos e os
    eventos em https://docs.hubfy.io/api-reference/introduction.
servers:
  - url: https://api.hubfy.io
security:
  - apiKeyAuth: []
tags:
  - name: Produtos
    description: Objeto Product. Campos e relacionamentos na visão geral.
  - name: Preços
    description: Objeto Price. Campos e relacionamentos na visão geral.
  - name: Arquivos
    description: Objeto Asset. Campos e relacionamentos na visão geral.
  - name: Clientes
    description: Objeto Customer. Campos e relacionamentos na visão geral.
  - name: Pedidos
    description: Objeto Order. Campos e relacionamentos na visão geral.
  - name: Links de pagamento
    description: Objeto PaymentLink. Campos e relacionamentos na visão geral.
  - name: Fundamentos da API
    description: Conexão e identificação da API.
paths:
  /v1/products/{id}:
    delete:
      tags:
        - Produtos
      summary: Excluir um produto
      description: >-
        Na criação, envie `name` e `initial_price`. O preço inicial segue as
        mesmas regras de [Preços](/api-reference/prices/object), sem o campo
        `product`. A atualização aceita `name`, `description`, `status`,
        `benefit` e `metadata`. A capa é definida no painel; `cover_url` é
        somente leitura.


        Se o produto estiver vinculado a pedido, checkout ou conteúdo, a
        exclusão o arquiva e retorna o produto com `status: "archived"`. Sem
        esses vínculos, retorna a confirmação de exclusão. Configurar `benefit`
        não cadastra cursos nem vínculos de entrega pela API.


        Permissão: `products:write` ou `write`. Consulte a [visão
        geral](/api-reference/products/object) para campos e relacionamentos.
      operationId: deleteProduct
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^pro_[a-z0-9]{16}$
          description: ID público do produto na conta.
      responses:
        '200':
          description: Operação concluída
          headers:
            X-Request-Id:
              description: Identifier of this HTTP request
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Product'
                  - $ref: '#/components/schemas/Deleted'
              example:
                id: pro_1234567890abcdef
                deleted: true
                object: product
        '400':
          $ref: '#/components/responses/ApiFailure'
        '401':
          $ref: '#/components/responses/ApiFailure'
        '403':
          $ref: '#/components/responses/ApiFailure'
        '404':
          $ref: '#/components/responses/ApiFailure'
        '409':
          $ref: '#/components/responses/ApiFailure'
        '429':
          $ref: '#/components/responses/ApiFailure'
        '500':
          $ref: '#/components/responses/ApiFailure'
        '502':
          $ref: '#/components/responses/ApiFailure'
        '503':
          $ref: '#/components/responses/ApiFailure'
      security:
        - apiKeyAuth: []
components:
  schemas:
    Product:
      type: object
      additionalProperties: false
      required:
        - id
        - benefit
        - cover_url
        - created_at
        - description
        - metadata
        - name
        - object
        - prices
        - status
        - updated_at
      properties:
        id:
          type: string
          pattern: ^pro_[a-z0-9]{16}$
          description: >-
            Identificador público estável. Use o valor retornado pela API nas
            consultas e relacionamentos; não derive IDs de nomes.
        benefit:
          type:
            - string
            - 'null'
          enum:
            - files
            - courses
            - links
            - null
          description: >-
            Tipo de conteúdo entregue: files (arquivos), courses (cursos) ou
            links (links). Pode ser null. Definir o tipo não vincula conteúdos
            ao produto.
        cover_url:
          type:
            - string
            - 'null'
          description: >-
            URL pública da capa do produto; null quando ausente. Somente
            leitura, definida no painel.
        created_at:
          type: string
          format: date-time
          description: >-
            Data e hora da criação, em ISO 8601 com fuso horário. Somente
            leitura.
        description:
          type:
            - string
            - 'null'
          description: >-
            Descrição do produto; null quando não informada. Envie null para
            limpar.
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Objeto JSON livre para referências da integração, limitado a 16 KB.
            Ao enviar, substitui todo o metadata anterior; use {} para limpar.
            Não aceita null.
        name:
          type: string
          description: Nome do produto. Obrigatório e não vazio na criação.
        object:
          const: product
          type: string
          description: Tipo do objeto retornado. O valor é fixo para este recurso.
        prices:
          type: array
          items:
            type: string
            pattern: ^prc_[a-z0-9]{16}$
          description: >-
            IDs dos preços vinculados, ordenados por criação e ID. Consulte cada
            preço em /v1/prices/{id}. Somente leitura.
        status:
          type: string
          enum:
            - draft
            - published
            - archived
          description: >-
            Estado do produto: draft (rascunho), published (publicado) ou
            archived (arquivado).
        updated_at:
          type: string
          format: date-time
          description: >-
            Data e hora da última alteração, em ISO 8601 com fuso horário.
            Somente leitura.
      example:
        id: pro_1234567890abcdef
        benefit: null
        cover_url: null
        created_at: '2030-01-01T00:00:00.000Z'
        description: null
        metadata: {}
        name: Curso de exemplo
        object: product
        prices:
          - prc_1234567890abcdef
        status: draft
        updated_at: '2030-01-01T00:00:00.000Z'
    Deleted:
      type: object
      additionalProperties: false
      required:
        - id
        - deleted
        - object
      properties:
        id:
          type: string
        deleted:
          type: boolean
          const: true
        object:
          type: string
          enum:
            - product
            - price
            - asset
            - customer
            - payment_link
      example:
        id: pro_1234567890abcdef
        deleted: true
        object: product
    ApiError:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - doc_url
            - message
            - param
            - type
          properties:
            code:
              type: string
            doc_url:
              type:
                - string
                - 'null'
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
      example:
        error:
          code: invalid_parameter
          doc_url: null
          message: The request contains invalid parameters
          param: null
          type: invalid_request_error
  responses:
    ApiFailure:
      description: A operação não foi concluída
      headers:
        X-Request-Id:
          description: Identifier of this HTTP request
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: invalid_parameter
              doc_url: null
              message: The request contains invalid parameters
              param: null
              type: invalid_request_error
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````

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