Saltar al contenido principal

edit-shop-branch

Este método se utiliza para editar una sucursal, ya sea para cambiar la dirección o cualquier otro de los datos que contiene la sucursal.

Path del método​

edit-shop-branch

Endpoint final​

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP​

POST

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
codeSiEl código de la sucursal que se quiere editarEjemplo:
pgbshobra746575878763354

Deveras de ingresar el código de la sucursal que requieres editar

Este código es único y puedes encontrarlo al consultar la información de una sucursal dentro de los métodos get-shop-branches o show-shop-branch
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 utiliza 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
NOTAS
  • Los parámetros que se envíen y estén vacíos remplazaran el contenido de la sucursal por un valor nulo, ejemplo, si deseas eliminar por completo el email de contacto de la sucursal deveras de enviar el parámetro email con valor vacío para que al ejecutar el servicio el campo email quede con valor nulo.
  • El único campo que no aplica con la regla anterior es address, si se envía address con un valor vacío, la dirección actual de la sucursal se mantendrá.
  • El parámetro lat y lng de la ubicación de la sucursal se admitirán únicamente si se envían los dos valores, si se envía uno solo los valores actuales permanecerán del mismo modo, de igual manera si se desea eliminar por completo las coordenadas de la ubicación se deberán de enviar ambos parámetros con valor vacío
  • Si el parámetro isShown se envía con un valor diferente a 0 o -1 el estado actual para el buscador quedara sin cambios

Lista de codigos​

Exitoso
CódigoDescripción
0074La sucursal se ha actualizado 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
1438El Token API no es correcto y la autenticación del usuario ha fallado
1439El código de la sucursal es requerido
1440La sucursal que se intenta editar no existe (el código de sucursal es incorrecto)
1441El Token API no es correcto y la autenticación del usuario ha fallado
1442Ocurrió un problema al editar 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": "0074"
    },
    "data": {
        "code_shop": "pgbsho44747793463129176",
        "name_shop": "Velas martin",
        "code": "pgbshobra7465758764698489",
        "isShown": "0",
        "address": "Av Rio grande No. 987 int 3, Monterrey, NL.",
        "phone": "(33) 3333333333",
        "email": "sucursal@mail.com",
        "lat": "20.499721",
        "lng": "-103.278145",
        "created_at": "2024-08-12T19:21:30.000000Z",
        "created_at_format": "2024-08-12 14:21:30",
    }
}

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
    • 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": "1439"
    }
}

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.