Saltar al contenido principal

show-shop-branch

Este método se utiliza para mostrar de manera individual la información de una sucursal, no aplica paginación con en el caso de get-shop-branches.

Path del método​

show-shop-branch

Endpoint final​

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP​

GET

Lista de parámetros​

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

Deberás de ingresar el código de la sucursal que requieres obtener

Lista de códigos​

Exitoso
CódigoDescripción
0081La sucursal se ha obtenido 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
1473El Token API no es correcto y la autenticación del usuario ha fallado
1474El código de la sucursal es requerido
1475La sucursal que se intenta obtener no existe (el código de sucursal es incorrecto)
1476El Token API no es correcto y la autenticación del usuario ha fallado
1477Ocurrió un problema al obtener la sucursal, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1478Ocurrió un problema al obtener 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": "0081"
    },
    "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": "1474"
    }
}

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.