Saltar al contenido principal

show-shop

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

Path del método​

show-shop

Endpoint final​

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP​

GET

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
codeSiEl código de la tienda que se quiere obtenerEjemplo:
pgbsho52199963640359741

Deberás de ingresar el codigo de la tienda que requieres obtener

Lista de códigos​

Exitoso
CódigoDescripción
0063La tienda 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
1379El Token API no es correcto y la autenticación del usuario ha fallado
1380El código de tienda es requerido
1381La tienda que se intenta obtener no existe (el código de tienda es incorrecto)
1382El Token API no es correcto y la autenticación del usuario ha fallado
1383Ocurrió un problema al obtener la tienda, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1384Ocurrió un problema al obtener la tienda, inténtelo nuevamente o consulte con soporte técnico para mas ayuda

Ejemplo de respuesta EXITOSA​

Exitoso

Código HTTP 200


{
    "status": true,
    "success": {
        "code": "0063"
    },
    "data": {
        "code": "pgbsho52199963686188374",
        "name": "Cenaduria Salcedo e Hijos",
        "created_at": "2024-08-07T19:54:44.000000Z",
        "created_at_format": "2024-08-07 14:54:44",
        "total_services": 1,
        "total_products": 0,
        "total_customers": 1,
        "total_orders": 0,
        "total_agents": 0,
        "total_branches": 0,
        "isEditable": "-1",
        "isDefault": "0",
        "description": null,
        "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": "0",
        "logo_file": null,
        "isShown": "-1"
    }
}

Descripción de la respuesta​

  • Revisar el listado de códigos EXITOSO para conocer el significado de success code.
  • 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": "1380"
    }
}

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.