get-shop-branches
Este método obtiene el listado de sucursales de una tienda que el usuario tiene creadas en la plataforma (se utiliza paginación para la consulta ordenada).
Notas
Si necesitas más información sobre como funciona la paginación consulta la seccion: Paginación.
Los resultados se ordenan de manera descendente por fecha en la que se creó la sucursal.
Path del método
get-shop-branches
Endpoint final
PRODUCCION
https://aceptabits.com/api/thirdparty/v1/get-shop-branches
SANDBOX DE PRUEBAS
https://sandbox.aceptabits.com/api/thirdparty/v1/get-shop-branches
Método de petición HTTP
GET
Lista de parámetros
| Parámetro | Obligatorio | Descripción | valor |
|---|---|---|---|
| code | Si | Es el código de la tienda a la que se realizara la búsqueda de las sucursales | ejemplo: pgbsho0635214789653205 Este código es único de cada tienda, se obtiene al consultar el listado de tiendas o al generar una tienda nueva, consulte los métodos: get-shops, add-shop o show-shop para mas detalles |
| page | Si | Es la página que se utilizara en la paginación de la petición | Ejemplo: 1, 2, 3, etc. Este valor debe ser numérico y entero, indicara la página actual a la cual se hará la consulta |
| limit | Si | Es el límite de elementos que se utilizara en la paginación de la petición | Ejemplo: 5, 10, 20, 50, etc. Este valor debe de ser numérico y entero, con un valor máximo posible de 100, si se envía un número mayor a 100 se realizara la consulta con el valor 100 |
| search | No | Se utiliza como filtro de búsqueda para la consulta de las sucursales, el filtro se aplicara dentro de:code address phone emailPara más información de estos campos consulta el método add-shop-branch, show-shop-branch o en esta misma sección en Ejemplo de respuesta EXITOSA | Ejemplo: pgbsho6199, velas, email@ejemplo, fabricación, etc. Se puede enviar una cadena de texto, un número, un correo electrónico o cualquier valor que se quiera utilizar como filtro |
Lista de códigos
Exitoso
| Código | Descripción |
|---|---|
| 0072 | Lista de sucursales obtenida con éxito |
Error
| Código | Descripción |
|---|---|
| 0000 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 0003 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 1427 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 1428 | El código de la tienda es requerido |
| 1573 | El campo página de la paginación es requerido |
| 1574 | El campo límite de la paginación es requerido |
| 1429 | La tienda a la que se intenta obtener el listad de sucursales no existe (el código de la tienda es incorrecto) |
| 1430 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 1431 | Ocurrió un problema al obtener el listado de sucursales, inténtelo nuevamente o consulte con soporte técnico para más ayuda |
Ejemplo de respuesta EXITOSA
Exitoso
Código HTTP 200
{
"status": true,
"success": {
"code": "0072"
},
"data": {
"data": [
{
"code_shop": "pgbsho44747793463129176",
"name_shop": "Velas martin",
"code": "pgbshobra2691913978258427",
"isShown": "-1",
"address": "Av Lopez Mateos #10652, Guadalajara, Jal.",
"phone": "(33) 33333333",
"email": "velasC4@mail.com",
"lat": "20.573653323563335",
"lng": "-103.45687866210939",
"created_at": "2024-08-10T02:26:26.000000Z",
"created_at_format": "2024-08-09 21:26:26",
}
],
"current_page": 1,
"last_page": 1,
"per_page": 10,
"from": 1,
"to": 1,
"total": 1
}
}
Descripción de la respuesta
- Revisar el listado de
códigos EXITOSOpara conocer el significado desuccesscode. data- Se obtiene la información de las sucursales de la tienda ingresada y la información actual de la paginacióncurrent_page- Indica cual es la página actual en la paginaciónlast_page- Indica cual es el último número de página posible (este valor cambia dependiendo del límite de elementos por página que se envió con el parámetro limit)per_page- Indica el limite de elementos mostrados por paginafrom- indica el índice inicial de la numeración de las sucursales mostrado en esta paginato- indica el índice final de la numeración de las sucursales mostrado en esta paginatotal- Indica el número de total de elementos que existendata- Arreglo donde se listan las sucursales de la tienda que tiene creadas el usuario en la plataformacode_shop- Código de la tienda a la que pertenece la sucursalname_shop- Nombre de la tienda a la que pertenece la sucursalcode- Código de la sucursal (este codigo es unico para cada sucursal que se ha dado de alta)isShown- Indica si la sucursal está configurada para ser visible en el buscador de AceptaBits, los valores posibles son:- 0 = no se mostrará en el buscador
- -1 = si se mostrara en el buscador
address- Muestra la dirección física de la sucursalphone- Muestra el teléfono de contacto de la sucursal, si no se dio de alta un teléfono de contacto mostrara el valor nullemail- Muestra el email de contacto de la sucursal, si no se dio de alta un email de contacto mostrara el valor nulllat- Muestra el valor LATITUD de las coordenadas de la ubicación de la sucursal, si no se dio de alta una ubicación mostrara el valor nulllng- Muestra el valor LONGITUD de las coordenadas de la ubicación de la sucursal, si no se dio de alta una ubicación mostrara el valor nullcreated_at- Fecha y hora de creación de la sucursal (UTC)created_at_format- Fecha y hora de creación de la sucursal (America/Mexico_City)
Ejemplo de respuesta FALLIDA
Error
Código HTTP 400, Código HTTP 401, Código HTTP 500
{
"status": false,
"error": {
"code": "1428"
}
}
Descripción de la respuesta
- Revisar el listado de
códigos ERRORpara conocer la causa y saber cómo corregir - Si se obtiene un código HTTP
500comunicarse a soporte técnico - Si se obtiene un código HTTP
401revisar que el Token API este correcto
Notas
Si tienes alguna duda recuerda que siempre puedes contactar con el equipo de soporte para desarrolladores ingresando en el siguiente enlace: Soporte para desarrolladores.