Reten Docs
Comércios

Atualizar Comércio

Atualize os campos e metadados de um comércio.

PATCH /api/commerces/:id

Atualiza os campos de um comércio.

Os metadados são mesclados, não substituídos: as chaves enviadas sobrescrevem as de mesmo nome, as não enviadas são mantidas, e enviar uma chave com null a remove. A mesclagem é recursiva (RFC 7386 JSON Merge Patch): os objetos aninhados são mesclados nível por nível, então você pode atualizar uma chave dentro de um objeto aninhado sem reenviar as irmãs. Qualquer outro valor substitui o anterior por completo, incluindo os arrays, que nunca são mesclados elemento a elemento. Enviar metadata: null esvazia o saco inteiro.

Auth: Obrigatória — permissão commerce:manage

Parâmetros de Rota

ParâmetroTipoDescrição
idUUIDID do comércio

Corpo da Requisição

Todos os campos são opcionais:

CampoTipoDescrição
namestringNome do comércio
tax_idstringID tributário (único por tenant)
global_external_idstringIdentificador externo global
is_activebooleanStatus ativo
metadataobjectJSON arbitrário, mesclado recursivamente; null o esvazia

Exemplo

curl -X PATCH https://api.reten.ai/api/commerces/880e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Store Name",
    "metadata": { "region": "north", "priority": "high" }
  }'
const commerceId = "880e8400-e29b-41d4-a716-446655440000";
const response = await fetch(`https://api.reten.ai/api/commerces/${commerceId}`, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Updated Store Name",
    metadata: { region: "north", priority: "high" },
  }),
});
const commerce = await response.json();
import requests

commerce_id = "880e8400-e29b-41d4-a716-446655440000"
response = requests.patch(
    f"https://api.reten.ai/api/commerces/{commerce_id}",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
    json={
        "name": "Updated Store Name",
        "metadata": {"region": "north", "priority": "high"},
    },
)
commerce = response.json()

Resposta 200 OK

Retorna o objeto do comércio atualizado.

Respostas de Erro

StatusDescrição
404Comércio não encontrado
409O ID tributário já existe