> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PATCH /api/v1/sales/:id

> Atualiza os metadados de uma venda existente.

Permite atualizar campos customizáveis de uma venda, como os metadados definidos pelo usuário (`user_metadata`). Útil para associar informações adicionais de negócio a uma transação sem alterar seu comportamento financeiro.

## Autenticação

Requer **Organization Access Token** via header `Authorization: Bearer`.

Escopos aceitos: `web:write` ou `sales:write`.

## Parâmetros de Path

**id** `string` *required*

Identificador único da venda a ser atualizada.

## Corpo da Requisição

**user\_metadata** `object`

Objeto de metadados customizados definidos pelo usuário. Aceita qualquer par chave-valor.

## Resposta

Retorna o objeto de venda atualizado com todos os campos.

**id** `string`

Identificador único da venda.

**status** `string`

Status atual da venda.

**amount** `integer`

Valor total da venda em centavos.

**payment\_type** `string`

Tipo de pagamento utilizado: `credit`, `boleto` ou `pix`.

**user\_metadata** `object`

Metadados customizados atualizados.

**created\_at** `string`

Data e hora de criação da venda no formato ISO 8601.

## Exemplo

```bash cURL theme={null}
curl -X PATCH "https://api.chargefy.io/api/v1/sales/sale_01j9abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "user_metadata": {
      "pedido_interno": "PED-9876",
      "canal": "whatsapp"
    }
  }'
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';
const chargefy = new Chargefy({ accessToken: process.env.CHARGEFY_ACCESS_TOKEN });
const result = await chargefy.sales.update('sale_01j9abc123', {
  user_metadata: {
    pedido_interno: 'PED-9876',
    canal: 'whatsapp',
  },
});
```

## Resposta de Exemplo

```json theme={null}
{
  "id": "sale_01j9abc123",
  "status": "succeeded",
  "amount": 9900,
  "payment_type": "credit",
  "user_metadata": {
    "pedido_interno": "PED-9876",
    "canal": "whatsapp"
  },
  "created_at": "2024-11-01T12:00:00Z"
}
```


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