Saltar al contenido principal

add-shop-branch

Este método se utiliza para dar de alta una nueva sucursal a una tienda, no existe un límite y puede tener tantas sucursales como lo requiera el usuario.

NOTAS
  • A las tiendas creadas por default como por ejemplo Tienda general no se les puede dar de alta sucursales, para conocer más acerca de los elementos creados por default se deberá de consultar la sección: Elementos creados por default.

Tener en cuenta lo siguiente antes de crear una sucursal:

Las sucursales son una extensión de las tiendas, su principal función es mostrar más resultados en el buscador de Dónde puedo pagar con AceptaBits?, es decir, a las sucursales se les puede asignar una dirección diferente, un email de contacto diferente, un teléfono de contacto diferente y una ubicación diferente(latitud y longitud en coordenadas) a las que tiene la tienda originalmente, por ejemplo, supongamos que tienes una tienda principal llamada Tortillería la montaña y esta está ubicada en Guadalajara jalisco, pero al mismo tiempo tienes una sucursal ubicada en Zapopan jalisco, cuando una persona haga una búsqueda de tortillerías podrá localizar tu negocio en las dos ubicaciones gracias a las sucursales.

Es importante mencionar que más allá de mostrar más resultados de búsqueda, no tienen otra funcionalidad principal, por ejemplo, las órdenes de venta no son asignables a una sucursal y siempre estarán ligadas a tu tienda principal, que en el ejemplo anterior seria tortillería la montaña que está en Guadalajara, si lo que necesitas es tener tus órdenes de venta separadas, entonces lo que te recomendamos es que en lugar de dar de alta una sucursal, des de alta una nueva tienda (ingresa en la documentación del método add-shop para más información) y cambiarles el nombre, por ejemplo, tu tienda principal que se llama Tortillería la montaña ahora podrías llamarla Tortillería la montaña - Guadalajara y a tu nueva tienda llamarla Tortillería la montaña - Zapopan, esto es solo una recomendación pero dependerá del dueño de la cuenta en AceptaBits como realizar la gestión de sus operaciones de venta.

Path del método​

add-shop-branch

Endpoint final​

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP​

POST

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
code_shopSiEs el código de la tienda a la que se asignara la sucursalejemplo:
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
addressSiLa dirección física de tu sucursalEjemplo:
Parcela #1532 Col. La Ejidal, Guadalajara, Jal.

Deveras de ingresar la dirección física de tu sucursal, es un elemento indispensable en las sucursales a la hora de que un cliente utilice el buscador y así poder saber dónde está ubicada tu sucursal, se admite una cadena de caracteres alfanuméricos
phoneNoEl teléfono de contacto de tu sucursalEjemplo:
+523333333333, 3333333333, (33) 3333333333, etc.

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

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

Deveras de ingresar el valor LATITUD de la ubicación de tu sucursal, 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 sucursalEjemplo:
-103.34785223007204

Deveras de ingresar el valor LONGITUD de la ubicación de tu sucursal, 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 sucursal sea visible en el buscador de AceptaBitsSe aceptan dos valores el 0 y el -1:

0 = no quiero mostrar mi sucursal en el buscador
-1 = si quiero mostrar mi sucursal 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
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
0073La sucursal 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
1432El Token API no es correcto y la autenticación del usuario ha fallado
1433El código de la tienda es requerido
1434La dirección es requerida
1435La tienda a la que se asignara la sucursal no existe (código de tienda incorrecto)
1436El Token API no es correcto y la autenticación del usuario ha fallado
1437Ocurrió un problema al crear la sucursal, 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": "0073"
    },
    "data": {
        "code_shop": "pgbsho44747793463129176",
        "name_shop": "Velas martin",
        "code": "pgbshobra4517949529787877",
        "isShown": 0,
        "address": "Av Rio grande No. 987 int 1, Monterrey, NL.",
        "phone": null,
        "email": null,
        "lat": null,
        "lng": null,
        "created_at": "2024-08-10T02:57:33.000000Z",
        "created_at_format": "2024-08-09 21:57:33",
    }
}

Descripción de la respuesta​

  • Revisar el listado de códigos EXITOSO para conocer el significado de success code.
  • data - La información de la sucursal recién creada
    • code_shop - Código de la tienda a la que pertenece la sucursal
    • name_shop - Nombre de la tienda a la que pertenece la sucursal
    • code - Código de la sucursal (este código es único 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 sucursal
    • phone - Muestra el teléfono de contacto de la sucursal, si no se dio de alta un teléfono de contacto mostrara el valor null
    • email - Muestra el email de contacto de la sucursal, 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 sucursal, 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 sucursal, si no se dio de alta una ubicación mostrara el valor null
    • created_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": "1434"
    }
}

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.