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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| zipcode | string (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
| Campo | Tipo | Descrição |
|---|---|---|
| id | number | ID da franquia |
| name | string | Razão social da franquia |
| name_fantasy | string | null | Nome fantasia da franquia |
| document | string | CNPJ/CPF da franquia |
| address | string | null | Endereço |
| complement | string | null | Complemento do endereço |
| province | string | null | Bairro |
| string | WhatsApp da franquia | |
| phone | string | null | Telefone da franquia |
| city | string | null | Cidade |
| state | string | null | UF |
| opening_hours | string | null | Horário de funcionamento |
| is_galaxpay | boolean | Se a franquia está habilitada pra cobrança via GalaxPay |
| is_maistodos | boolean | null | Se 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ódigo | Descrição |
|---|---|
| 200 | Retorna os dados da franquia responsável pelo CEP |
| 401 | Token ausente ou inválido |
| 404 | Nenhuma franquia atende esse CEP (error_companie_id_not_exist) |