Obtener servicios del negocio
Este endpoint permite consultar los servicios de un negocio con los productos vinculados a cada servicio.
GET /api/v2/businesses/{businessId}/services
Si los datos incluidos en la petición son correctos, la respuesta contendrá el listado de servicios del negocio.
Ejemplo de respuesta
[
{
"id": "0001",
"name": "STORE-01",
"timeZone": "Europe/Paris",
"products": [
"0001-GENERAL",
"0001-HD"
]
},
{
"id": "0002",
"name": "STORE-02",
"timeZone": "Africa/Abidjan",
"products": [
"0002"
],
"metadata": {
"franchisee": true
}
},
{
"name": "STORE-03",
"timeZone": "Europe/Madrid",
"products": [
null
],
"lat": 40.39336952418088,
"lon": -3.766111678479019
}
]
Detalles
-
id: identificador externo del servicio.
-
name: nombre del servicio.
-
timeZone: huso horario del servicio.
-
products: lista de identificadores externos de los productos del servicio.
-
lat: latitud de la ubicación física del servicio.
-
lon: longitud de la ubicación física del servicio.
-
metadata: cualquier metadato adicional que se haya definido a nivel de negocio para los servicios.
Como se puede apreciar en el ejemplo, la petición devolverá la información que se haya definido para cada servicio.
Consideraciones
Si el servicio no tiene identificador externo configurado en Orquest, la respuesta no incluirá este dato.
Si uno o más productos del servicio no tienen identificador externo configurado en Orquest, la respuesta incluirá un único null en el campo products, independientemente de cuántos productos sin identificador haya: al ser un conjunto (set), los valores null repetidos se colapsan en uno solo.
Códigos de error
Este endpoint no devuelve códigos de error propios que no se encuentren descritos en errores comunes.