get-shops

Este método obtiene el listado de tiendas que el usuario tiene creadas en la plataforma (se utiliza paginación para la consulta ordenada).

Notas

Si necesitas más información sobre cómo funciona la paginación consulta la sección: Paginación.

Los resultados se ordenan de manera descendente por fecha en la que se creo la tienda.

Path del método

get-shops

Endpoint final

PRODUCCION

https://aceptabits.com/api/thirdparty/v1/get-shops

SANDBOX DE PRUEBAS

https://sandbox.aceptabits.com/api/thirdparty/v1/get-shops

Método de petición HTTP

GET

Lista de parámetros

Parámetro	Obligatorio	Descripción	valor
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 tiendas, el filtro se aplicara dentro de: `name` `code` `description` `website` `address` `phone` `email` Para más información de estos campos consulta el método add-shop, show-shop o en esta misma sección en Ejemplo de respuesta EXITOSA	Ejemplo: pgbsho6199, velas, email@ejemplo, fabricacion, 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
0039	Lista de tiendas 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
1192	El Token API no es correcto y la autenticación del usuario ha fallado
1571	El campo página de la paginación es requerido
1572	El campo límite de la paginación es requerido
1193	El Token API no es correcto y la autenticación del usuario ha fallado
1194	Ocurrió un problema al obtener el listado de tiendas, 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": "0039"
    },
    "data": {        
        "data": [
            {
                "code": "pgbsho40996222369461182",
                "name": "Tienda general",
                "created_at": "2024-07-18T20:09:19.000000Z",
                "created_at_format": "2024-07-18 15:09:19",
                "total_services": 1,
                "total_products": 2,
                "total_customers": 2,
                "total_orders": 0,
                "total_agents": 0,
                "total_branches": 0,
                "isEditable": "0",
                "isDefault": "-1",
                "description": null,
                "website": null,
                "address": null,
                "phone": null,
                "email": null,
                "lat": null,
                "lng": null,
                "has_logo": "0",
                "logo_file": null,
                "isShown": "-1"
            }
        ],
        "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 EXITOSO para conocer el significado de success code.
data - Se obtiene la información de las tiendas y la información actual de la paginación
- current_page - Indica cual es la página actual en la paginación
- last_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 límite de elementos mostrados por pagina
- from - indica el índice inicial de la numeración de las tiendas mostrado en esta pagina
- to - indica el índice final de la numeración de las tiendas mostrado en esta pagina
- total - Indica el número de total de elementos que existen
- data - Arreglo donde se listan las tiendas que tiene creadas el usuario en la plataforma
  - code - Código de la tienda (este código es único para cada tienda que se ha dado de alta)
  - name - Nombre de la tienda
  - created_at - Fecha y hora de creación de la tienda (UTC)
  - created_at_format - Fecha y hora de creación de la tienda (America/Mexico_City)
  - total_services - Indica el número total de servicios asignados a la tienda,
  - total_products - Indica el número total de productos asignados a la tienda,
  - total_customers - Indica el número total de clientes asignados a la tienda,
  - total_orders - Indica el número total de órdenes de venta asignadas a la tienda
  - total_agents - Indica el número total de agentes de venta asignados a la tienda
  - total_branches - Indica el número total de sucursales asignadas a la tienda
  - isEditable - indica si la tienda se puede o no editar, los valores posibles son:
    - 0 = no se puede editar
    - -1 = si se puede editar
  - isDefault - indica si la tienda es una tienda de default, los valores posibles son:
    - 0 = no es una tienda default
    - -1 = si es una tienda default
  - description - Muestra la descripción general de la tienda, si no se dio de alta una descripción mostrara el valor null
  - website - Muestra el sitio web de la tienda, si no se dio de alta un sitio web mostrara el valor null
  - address - Muestra la dirección física de la tienda, si no se dio de alta una dirección física mostrara el valor null
  - phone - Muestra el teléfono de contacto de la tienda, si no se dio de alta un teléfono de contacto mostrara el valor null
  - email -Muestra el email de contacto de la tienda, si no se dio de alta un email de contacto mostrara el valor null
  - lat - Muestra el valor LATITUD de las coordenadas de la ubicación de la tienda, si no se dio de alta una ubicación mostrara el valor null
  - lng - Muestra el valor LONGITUD de las coordenadas de la ubicación de la tienda, si no se dio de alta una ubicación mostrara el valor null
  - has_logo - Indica si se ha subido un logotipo a la tienda, los valores posibles son:
    - 0 = no tiene un logotipo
    - -1 = si tiene un logotipo
  - logo_file - muestra el nombre del logotipo (se genera con el codigo de la tienda y la extensión del logotipo subido: png, jpg o jpeg)
  - isShown - Indica si la tienda 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

Ejemplo de respuesta FALLIDA

Error

Código HTTP 400, Código HTTP 401, Código HTTP 500

{
    "status": false,
    "error": {
        "code": "1571"
    }
}

Descripción de la respuesta

Revisar el listado de códigos ERROR para conocer la causa y saber cómo corregir
Si se obtiene un código HTTP 500 comunicarse a soporte técnico
Si se obtiene un código HTTP 401 revisar 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.

get-shops

Path del método​

Endpoint final​

Método de petición HTTP​

Lista de parámetros​

Lista de códigos​

Ejemplo de respuesta EXITOSA​

Descripción de la respuesta​

Ejemplo de respuesta FALLIDA​

Descripción de la respuesta​

Path del método

Endpoint final

Método de petición HTTP

Lista de parámetros

Lista de códigos

Ejemplo de respuesta EXITOSA

Descripción de la respuesta

Ejemplo de respuesta FALLIDA

Descripción de la respuesta