> ## Documentation Index > Fetch the complete documentation index at: https://docs.beinfi.com/llms.txt > Use this file to discover all available pages before exploring further. # Atualizar produto > Substitui os dados do produto: `name`, `description` e `status` são sempre gravados, então envie os três. Omitir `description` apaga a descrição, e omitir `status` deixa o produto sem status. `imageObjectKey` e `requiresShipping` são exceções: se ausentes, ficam como estão. Preço não se altera aqui; crie uma nova versão. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.json patch /products/{productID} openapi: 3.1.0 info: title: Infi API version: 0.0.1 description: > A API REST do Infi: catálogo, clientes, medição de uso, assinaturas, faturas, pagamentos e checkout. **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…` (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente. As rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no navegador de quem paga. **Idempotência.** Toda requisição que altera dados exige o header `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta original em vez de executar de novo. **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`, `"0.0001"`), nunca como número de ponto flutuante. **Erros.** O corpo traz `error_code` (estável, use para decidir), `message` (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de requisições e de idempotência vêm aninhados em `error`, com `code` e `request_id`. servers: - url: https://api-sandbox.beinfi.com description: Sandbox - url: https://api.beinfi.com description: Produção security: - bearerAuth: [] tags: - name: Catálogo - name: Clientes - name: Medição de uso - name: Assinaturas - name: Faturas - name: Pagamentos - name: Checkout - name: Cupons - name: Cobrança - name: Conta - name: Webhooks - name: Conta de teste - name: Rail - name: Lojas paths: /products/{productID}: parameters: - $ref: '#/components/parameters/ProductID' patch: tags: - Catálogo summary: Atualizar produto description: > Substitui os dados do produto: `name`, `description` e `status` são sempre gravados, então envie os três. Omitir `description` apaga a descrição, e omitir `status` deixa o produto sem status. `imageObjectKey` e `requiresShipping` são exceções: se ausentes, ficam como estão. Preço não se altera aqui; crie uma nova versão. operationId: updateProduct parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - name properties: name: type: string description: Nome do produto. description: type: - string - 'null' description: >- Descrição do produto. Omitir ou enviar `null` apaga a descrição atual. status: type: string enum: - active - archived description: '`active` ou `archived`. Sempre envie.' imageObjectKey: type: - string - 'null' description: >- O `objectKey` devolvido por `POST /catalog/images/presign`. Ausente mantém a foto atual; `""` remove a foto. É recusado se a chave não foi gerada para a sua conta. requiresShipping: type: - boolean - 'null' description: >- Se a compra exige entrega física. Quando `true`, o checkout pede o endereço de entrega. Ausente mantém o valor atual. responses: '200': content: application/json: schema: $ref: '#/components/schemas/Product' description: O produto atualizado. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/ValidationFailed' components: parameters: ProductID: name: productID in: path required: true schema: type: string format: uuid description: ID do produto. IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string description: >- Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original. schemas: Product: type: object properties: id: type: string format: uuid key: type: - string - 'null' description: >- Chave estável que você escolhe para o produto, única na sua conta. Permite criar o mesmo produto de novo sem duplicar. name: type: string type: type: string enum: - agent - item description: '`item` (padrão) ou `agent`.' description: type: - string - 'null' pricingModel: type: string enum: - subscription - one_time - usage - prepaid description: >- Como o produto é cobrado: `subscription`, `one_time`, `usage` ou `prepaid`. currency: type: string example: BRL description: Código ISO 4217 de 3 letras, como `BRL`. status: type: string example: active description: '`active` ou `archived`.' imageUrl: type: - string - 'null' description: Endereço público da foto do produto. requiresShipping: type: boolean description: >- Se a compra exige entrega física; quando `true`, o checkout pede endereço. createdAt: type: string format: date-time updatedAt: type: string format: date-time description: Um item do catálogo. O preço fica nas versões do produto. Error: type: object required: - message - error_code - tracer_id properties: message: type: string description: Frase legível para pessoas. error_code: $ref: '#/components/schemas/ErrorCode' description: Código estável do erro. Use-o para decidir o que fazer. tracer_id: type: string description: Identificador da requisição. Informe-o ao falar com o suporte. description: >- O corpo de erro padrão. É plano (sem o envelope `error`) e o identificador de rastreio é `tracer_id`. NotFoundError: type: object required: - message - error_code - tracer_id - resource properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string resource: type: string ValidationError: type: object required: - message - error_code - tracer_id - errors properties: message: type: string error_code: $ref: '#/components/schemas/ErrorCode' tracer_id: type: string errors: type: array items: type: object required: - field - value - constraint - description properties: field: type: string value: type: string constraint: type: string description: type: string description: >- Detalhe por campo (`field`, `description`). Sempre presente num `422`; pode vir vazio. description: >- Corpo de um `422`. Mesmo formato de `Error`, mais `errors[]` com o detalhe por campo. É ali que está a frase que diz o que corrigir (por exemplo, "product has no published version"). ErrorCode: type: string examples: - internal_error - validation_failed - bad_request - unauthorized - forbidden - not_found - conflict - rate_limited description: >- Código estável do erro. A lista não é fechada: além dos códigos genéricos, cada área tem os seus (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Um código que você não conhece deve ser tratado pelo status HTTP, mostrando `message`; não falhe ao ler a resposta. responses: Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Chave ausente ou inválida. NotFound: content: application/json: schema: $ref: '#/components/schemas/NotFoundError' description: Recurso não encontrado. ValidationFailed: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: >- Um ou mais campos são inválidos. O detalhe de cada campo está em `errors[]`. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave secreta da conta: `Authorization: Bearer sk_test_…` ou `sk_live_…`. Use só no servidor. ````