Get branch configurations

Permite obter uma lista das configurações da unidade.

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

Este endpoint não requer parâmetros obrigatórios.

Resposta

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

Estrutura da Resposta

CampoTipoDescrição
idBranchinteiroIdentificador único da filial.
namestringNome público da filial.
internalNamestringNome interno da filial.
cnpjstringCNPJ da filial.
addressstringEndereço da filial.
neighborhoodstringBairro onde a filial está localizada.
telephonestringNúmero de telefone da filial (pode ser null).
numberstringNúmero do endereço da filial.
idStateinteiroIdentificador do estado da filial.
statestringNome completo do estado.
stateShortstringSigla do estado.
citystringCidade onde a filial está localizada.
complementstringComplemento do endereço (pode ser null).
zipCodestringCEP da filial.
websitestringNome do site ou referência associada à filial.
latitudefloatLatitude para localização geográfica.
longitudefloatLongitude para localização geográfica.
openingDatedatetimeData de abertura da filial (pode ser null).
businessHoursarrayLista de objetos com os horários de funcionamento da filial (detalhado abaixo).
searchTermsarrayTermos de busca associados à filial.

Estrutura do Objeto businessHours

CampoTipoDescrição
idHourinteiroIdentificador único do horário de funcionamento.
idBranchinteiroIdentificador da filial associada.
weekDaystringDias da semana correspondentes ao horário (ex: 2,3,4,5,6).
hoursFromdatetimeHora de início do funcionamento (formato ISO 8601).
hoursTodatetimeHora de término do funcionamento (formato ISO 8601).
flDeletedbooleanoIndica se o horário foi excluído.
idTmpinteiroCampo temporário (pode ser null).
creationDatedatetimeData de criação do registro do horário (formato ISO 8601).
idEmployeeCreationinteiroIdentificador do funcionário que criou o registro do horário.
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!