Pular para o conteúdo principal

Atualizar Lojista

Atualize as informações de um comerciante existente.

Endpoint​

PUT/v1/merchants/{merchantId}

Parâmetros de Path​

ParâmetroTipoObrigatórioDescrição
merchantIdstring✓ID único do lojista

Corpo da Requisição​

Os campos abaixo podem ser enviados individualmente ou em conjunto — apenas os campos presentes serão atualizados.

CampoTipoDescrição
dbaNamestringNome comercial
corporateNamestringRazão social
taxIdstringCNPJ ou CPF
addressobjectEndereço comercial (ver tabela abaixo)
contactobjectInformações de contato (site, email, phone)

Objeto Address​

CampoTipoObrigatórioDescrição
postalCodestring✓CEP (8 dígitos, sem hífen)
statestring✓Código do estado (2 letras)
citystring✓Cidade
neighborhoodstring✓Bairro / distrito
streetstring✓Nome da rua
numberstring✓Número da rua
countrystring—Código do país (ISO 3166-1 alpha-2, ex.: BR)
complementstring—Informação adicional (apartamento, sala, etc.)
Request
curl -X PUT https://yby-dev.positivolabs.com.br/v1/merchants/{merchantId} \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"dbaName": "Coffee Shop Faria Lima",
"corporateName": "Coffee Shop Comércio LTDA",
"taxId": "12345678000190",
"address": {
"postalCode": "01452000",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Itaim Bibi",
"street": "Av. Faria Lima",
"number": "3000",
"complement": "Andar 10",
"country": "BR"
},
"contact": {
"site": "http://coffeeshop.com",
"email": "faria-lima@coffeeshop.com",
"phone": "+5511999999999"
}
}'
Resposta
{
"id": "d6uo5nc42nrc73gv867g",
"createdAt": "2026-03-20T10:00:00Z",
"updatedAt": "2026-03-20T11:15:00Z",
"type": "merchant",
"dbaName": "Coffee Shop Faria Lima",
"corporateName": "Coffee Shop Comércio LTDA",
"taxId": "12345678000190",
"parentId": "d59gpddc93gc73jvje0g",
"merchantCategoryCode": "5347",
"economicActivityCode": "4712100",
"address": {
"id": "d6uo5nc42nrc73gv8680",
"postalCode": "01452000",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Itaim Bibi",
"street": "Av. Faria Lima",
"number": "3000",
"complement": "Andar 10",
"country": "BR"
},
"contact": {
"id": "d6uo5nc42nrc73gv8681",
"site": "http://coffeeshop.com",
"email": "faria-lima@coffeeshop.com",
"phone": "+5511999999999"
},
"bankAccounts": [
{
"id": "d6uo5nc42nrc73gv8682",
"accountType": "checking",
"routingNumber": "0001",
"accountNumber": "12345678-9"
}
],
"contactPerson": [
{
"id": "d6uo5nc42nrc73gv8683",
"name": "João Silva",
"taxId": "12345678900",
"email": "joao@coffeeshop.com",
"phone": "+5511988888888",
"position": "Gerente"
}
]
}

Próximos Passos​