Saltar al contenido principal

add-shop

Este método se utiliza para dar de alta una nueva tienda, no existe un límite y puede tener tantas tiendas como lo requiera el usuario, entiéndase como Tienda a tu negocio, establecimiento, empresa o a ti mismo como prestador de servicios.


Path del método

add-shop

Endpoint final

PRODUCCION

https://aceptabits.com/api/thirdparty/v1/add-shop

SANDBOX DE PRUEBAS

https://sandbox.aceptabits.com/api/thirdparty/v1/add-shop

Método de petición HTTP

POST

Lista de parámetros

ParámetroObligatorioDescripciónvalor
nameSiEl nombre que se le asignara a la tiendaEjemplo:
Mariscos la casa de maria, Limpia fácil, Clínica Roma, Ing. Martin T Ch, etc.

Deveras de ingresar el nombre con el que requieres que la tienda se genere, se admite una cadena de caracteres alfanuméricos
descriptionNoLa descripción que le darás a tu tiendaEjemplo:
Venta de artículos deportivos para tiro con Arco, instalaciones de practica y escuela de arquería

Deveras de ingresar una descripción adecuada para tu tienda, la descripcion es un elemento muy útil a la hora de que un cliente utilice el buscador y así poder encontrar tu negocio, se admite una cadena de caracteres alfanuméricos
websiteNoEl sitio web de tu tiendaEjemplo:
https://misitioejemplo.com/

Deberas de ingresar la URL de la página web de tu negocio, puede ser propia, o el enlace de alguna de tus redes sociales, por ejemplo, se admite una cadena de caracteres alfanuméricos
addressNoLa dirección física de tu tiendaEjemplo:
Parcela #1532 Col. La Ejidal, Guadalajara, Jal.

Deveras de ingresar la dirección física de tu negocio, es un elemento muy útil a la hora de que un cliente utilice el buscador y así saber dónde está ubicado tu negocio, se admite una cadena de caracteres alfanuméricos
phoneNoEl teléfono de contacto de tu tiendaEjemplo:
+523333333333, 3333333333, (33) 3333333333, etc.

Deveras de ingresar el teléfono de contacto de tu negocio, recomendamos ingresarlo con lada o código de país para que las personas puedan contactar a tu negocio de manera más sencilla, se admite una cadena de caracteres alfanuméricos
emailNoEl email de contacto de tu tiendaEjemplo:
minegocio@ejemplo.com, minegocio@outlook.mx, etc,

Deveras de ingresar el email de contacto de tu negocio, lo recomendamos ampliamente para que las personas puedan ponerse en contacto con tu negocio, se admite una cadena de caracteres alfanuméricos
latNoEl valor LATITUD de las coordenadas de la ubicación de la tiendaEjemplo:
25.560150207599253

Deveras de ingresar el valor LATITUD de la ubicación de tu negocio, este valor debe de ser numérico, normalmente con decimales como se muestra en el ejemplo, puedes apoyarte con una aplicación de mapas para obtener este valor
lngNoEl valor LONGITUD de las coordenadas de la ubicación de la tiendaEjemplo:
-103.34785223007204

Deveras de ingresar el valor LONGITUD de la ubicación de tu negocio, este valor debe de ser numérico, normalmente con decimales como se muestra en el ejemplo, puedes apoyarte con una aplicación de mapas para obtener este valor
isShownNoIndica si quieres que la tienda sea visible en el buscador de AceptaBitsSe aceptan dos valores el 0 y el -1:

0 = no quiero mostrar mi tienda en el buscador
-1 = si quiero mostrar mi tienda en el buscador

Si no se envía este parámetro o si se envía con otro valor que no sean los mostrados se utilizara el valor 0
fileNoEs el archivo de imagen del logotipo de tu tiendaDeberá de ser un archivo de imagen en formato .png, .jpg o .jpeg, no se admitirá ningún otro tipo de formato, puedes apoyarte con la documentación oficial del cliente que utilices para las peticiones para saber cómo enviar archivos dentro de la petición
NOTAS

El parámetro lat y lng de la ubicación de la tienda se admitirán únicamente si se envían los dos valores, si se envía uno solo, el valor de ambos será almacenado como nulo


Lista de códigos

Exitoso
CódigoDescripción
0040La tienda ha sido creada con éxito

 

Error
CódigoDescripción
0000El Token API no es correcto y la autenticación del usuario ha fallado
0003El Token API no es correcto y la autenticación del usuario ha fallado
1195El Token API no es correcto y la autenticación del usuario ha fallado
1198El Nombre de la tienda es requerido
1420El logotipo no cumple con el formato requerido
1196El Token API no es correcto y la autenticación del usuario ha fallado
1197Ocurrió un problema al crear la tienda, 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": "0040"
},
"data": {
"code": "pgbsho49261493361754536",
"name": "Cenaduria Salcedo",
"created_at": "2024-08-07T19:49:18.000000Z",
"created_at_format": "2024-08-07 14:49:18",
"total_services": 1,
"total_products": 0,
"total_customers": 1,
"total_orders": 0,
"total_agents": 0,
"total_branches": 0,
"isEditable": -1,
"isDefault": 0,
"description": "Restaurante familiar de antojitos mexicanos y platillos de la region sur de jalisco, contamos con servicio a domicilio en la zona",
"website": null,
"address": "Av de la cosecha #269, col. El REstaurante, Guadalajara, Jal.",
"phone": "3333333333",
"email": null,
"lat": "20.553983",
"lng": "-103.467307",
"has_logo": -1,
"logo_file": "pgbsho49261493361754536.png",
"isShown": -1
}
}

Descripción de la respuesta

  • Revisar el listado de códigos EXITOSO para conocer el significado de success code.
  • data - muestra la información de la tienda recién creada
    • 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": "1198"
}
}

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.