Obtener Configuraciones de Sucursales

Descripción

Recupera una lista de configuraciones de sucursales, incluyendo información detallada como dirección, CNPJ, horarios de funcionamiento y términos de búsqueda asociados.

🔑 Parámetros de Consulta

Este endpoint no requiere parámetros.

📤 Estructura de la Respuesta

La respuesta es un arreglo de objetos que contiene la información detallada de cada sucursal.

Campo	Tipo	Descripción
`idBranch`	int32	Identificador único de la sucursal.
`name`	string	Nombre público de la sucursal.
`internalName`	string	Nombre interno de la sucursal.
`cnpj`	string	CNPJ de la sucursal.
`address`	string	Dirección de la sucursal.
`neighborhood`	string	Barrio donde se encuentra la sucursal.
`telephone`	string	Número de teléfono de la sucursal (puede ser `null`).
`number`	string	Número de la dirección de la sucursal.
`idState`	int32	Identificador del estado de la sucursal.
`state`	string	Nombre completo del estado.
`stateShort`	string	Sigla del estado.
`city`	string	Ciudad donde se encuentra la sucursal.
`complement`	string	Complemento de la dirección (puede ser `null`).
`zipCode`	string	Código postal (CEP) de la sucursal.
`website`	string	Nombre del sitio web o referencia asociada a la sucursal.
`latitude`	float	Latitud para localización geográfica.
`longitude`	float	Longitud para localización geográfica.
`openingDate`	datetime	Fecha de apertura de la sucursal (puede ser `null`).
`businessHours`	array	Lista de objetos con los horarios de funcionamiento de la sucursal (detallado abajo).
`searchTerms`	array	Términos de búsqueda asociados a la sucursal.

🧩 Estructura del Objeto `businessHours`

Campo	Tipo	Descripción
`idHour`	int32	Identificador único del horario de funcionamiento.
`idBranch`	int32	Identificador de la sucursal asociada.
`weekDay`	string	Días de la semana correspondientes al horario (ej.: `2,3,4,5,6`).
`hoursFrom`	datetime	Hora de inicio del funcionamiento (formato ISO 8601).
`hoursTo`	datetime	Hora de finalización del funcionamiento (formato ISO 8601).
`flDeleted`	booleano	Indica si el horario fue eliminado.
`idTmp`	int32	Campo temporal (puede ser `null`).
`creationDate`	datetime	Fecha de creación del registro del horario (formato ISO 8601).
`idEmployeeCreation`	int32	Identificador del empleado que creó el registro del horario.

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

Obtener Configuraciones de Sucursales#

Descripción#

🔑 Parámetros de Consulta#

📤 Estructura de la Respuesta#

🧩 Estructura del Objeto businessHours#