Skip to main content

Consultar Franquia por CEP

Utilize o token obtido na autenticação para descobrir qual franquia da rede atende um determinado CEP.

🔗 Consultar Franquia por CEP (Swagger)

🔍 Parâmetros​

ParâmetroTipoObrigatórioDescrição
zipcodestring (path)✅CEP a ser consultado, somente números, 8 dígitos (ex: 01310100)

Exemplo de Requisição​

GET /integration/franchise/01310100
Authorization: Bearer <token>

📋 Campos da Resposta​

CampoTipoDescrição
idnumberID da franquia
namestringRazão social da franquia
name_fantasystring | nullNome fantasia da franquia
documentstringCNPJ/CPF da franquia
addressstring | nullEndereço
complementstring | nullComplemento do endereço
provincestring | nullBairro
whatsappstringWhatsApp da franquia
phonestring | nullTelefone da franquia
citystring | nullCidade
statestring | nullUF
opening_hoursstring | nullHorário de funcionamento
is_galaxpaybooleanSe a franquia está habilitada pra cobrança via GalaxPay
is_maistodosboolean | nullSe a franquia está habilitada pra cobrança via Mais Todos
Como a franquia é determinada

Cada franquia tem um ou mais intervalos de CEP cadastrados (zipcode_start_area – zipcode_end_area) como sua área de atendimento. A rota retorna a primeira franquia (que não seja a matriz/Laks) cujo intervalo contém o CEP informado. Se o CEP não cair em nenhum intervalo cadastrado, a resposta é 404.

Exemplo de Resposta (200)​

{
"id": 12,
"name": "PET DE TODOS UNIDADE CENTRO LTDA",
"name_fantasy": "Unidade Centro",
"document": "12345678000199",
"address": "RUA DAS FLORES, 100",
"complement": "LOJA 2",
"province": "CENTRO",
"whatsapp": "11988887777",
"phone": "1133334444",
"city": "SÃO PAULO",
"state": "SP",
"opening_hours": "Seg a Sáb, 08h às 18h",
"is_galaxpay": true,
"is_maistodos": false
}

⚠️ Respostas​

CódigoDescrição
200Retorna os dados da franquia responsável pelo CEP
401Token ausente ou inválido
404Nenhuma franquia atende esse CEP (error_companie_id_not_exist)