Obter Configurações de Filiais

Descrição

Recupera uma lista de configurações de filiais, incluindo informações detalhadas como endereço, CNPJ, horários de funcionamento e termos de busca associados.

🔑 Parâmetros de Consulta

Este endpoint não requer parâmetros.

📤 Estrutura da Resposta

A resposta é um array de objetos contendo as informações detalhadas de cada filial.

Campo	Tipo	Descrição
`idBranch`	inteiro	Identificador único da filial.
`name`	string	Nome público da filial.
`internalName`	string	Nome interno da filial.
`cnpj`	string	CNPJ da filial.
`address`	string	Endereço da filial.
`neighborhood`	string	Bairro onde a filial está localizada.
`telephone`	string	Número de telefone da filial (pode ser `null`).
`number`	string	Número do endereço da filial.
`idState`	inteiro	Identificador do estado da filial.
`state`	string	Nome completo do estado.
`stateShort`	string	Sigla do estado.
`city`	string	Cidade onde a filial está localizada.
`complement`	string	Complemento do endereço (pode ser `null`).
`zipCode`	string	CEP da filial.
`website`	string	Nome do site ou referência associada à filial.
`latitude`	float	Latitude para localização geográfica.
`longitude`	float	Longitude para localização geográfica.
`openingDate`	datetime	Data de abertura da filial (pode ser `null`).
`businessHours`	array	Lista de objetos com os horários de funcionamento da filial (detalhado abaixo).
`searchTerms`	array	Termos de busca associados à filial.

🧩 Estrutura do Objeto `businessHours`

Campo	Tipo	Descrição
`idHour`	inteiro	Identificador único do horário de funcionamento.
`idBranch`	inteiro	Identificador da filial associada.
`weekDay`	string	Dias da semana correspondentes ao horário (ex: `2,3,4,5,6`).
`hoursFrom`	datetime	Hora de início do funcionamento (formato ISO 8601).
`hoursTo`	datetime	Hora de término do funcionamento (formato ISO 8601).
`flDeleted`	booleano	Indica se o horário foi excluído.
`idTmp`	inteiro	Campo temporário (pode ser `null`).
`creationDate`	datetime	Data de criação do registro do horário (formato ISO 8601).
`idEmployeeCreation`	inteiro	Identificador do funcionário que criou o registro do horário.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idBranch": 0,
    "name": "string",
    "internalName": "string",
    "cnpj": "string",
    "address": "string",
    "neighborhood": "string",
    "telephone": "string",
    "whatsapp": "string",
    "number": "string",
    "idState": 0,
    "state": "string",
    "stateShort": "string",
    "city": "string",
    "complement": "string",
    "zipCode": "string",
    "website": "string",
    "latitude": 0,
    "longitude": 0,
    "openingDate": "2019-08-24T14:15:22.123Z",
    "businessHours": [
        {
            "idHour": 0,
            "idBranch": 0,
            "weekDay": "string",
            "hoursFrom": "2019-08-24T14:15:22.123Z",
            "hoursTo": "2019-08-24T14:15:22.123Z",
            "flDeleted": true,
            "idTmp": 0,
            "creationDate": "2019-08-24T14:15:22.123Z",
            "idEmployeeCreation": 0
        }
    ],
    "searchTerms": [
        "string"
    ]
}

🟠400Bad Request

Get branch configurations

Obter Configurações de Filiais#

Descrição#

🔑 Parâmetros de Consulta#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto businessHours#