Obtener productos

Documentación del Endpoint: productos

URL del Endpoint

GET https://site.com/api/productos?apikey={apikey}&page={Number}

Parámetros de la Solicitud

La solicitud debe incluir los siguientes parámetros en la URL:

  • apikey (string, requerido): Tu clave API para autenticar la solicitud.

  • page (int, opcional): Número de página para paginación. El valor predeterminado es 1.

Ejemplo de Solicitud

GET https://site.com/api/productos?apikey=your_api_key&page=1

Respuesta Exitosa

En caso de éxito, se devolverá un JSON con los detalles de los productos, así como información de paginación.

Campos de Respuesta

  • success (boolean): Indica si la solicitud fue exitosa.

  • products (array): Lista de productos.

    • id (int): ID del producto.

    • sku (string): SKU del producto.

    • category_id (int): ID de la categoría del producto.

    • price (float): Precio del producto.

    • currency (string): Moneda del producto.

    • stock (int): Cantidad de stock disponible para el producto.

    • product_type (string): Tipo de producto.

    • title (string): Título del producto.

    • description (string): Descripción completa del producto.

    • short_description (string): Descripción corta del producto.

    • seo_title (string): Título SEO del producto.

    • seo_description (string): Descripción SEO del producto.

    • seo_keywords (string): Palabras clave SEO del producto.

    • brand_id (int): ID de la marca del producto.

    • visibility (int): Visibilidad del producto.

    • status (int): Estado del producto.

    • created_at (string): Fecha de creación del producto.

    • updated_at (string): Fecha de la última actualización del producto.

    • images: (array) : lista de imagenes

    • details: (array): detalles del producto

Ejemplo de Respuesta

[
    {
        "id": 123,
        "sku": "PROD12345",
        "category_id": 5,
        "price": 59.99,
        "currency": "USD",
        "stock": 100,
        "product_type": "physical",
        "title": "Joystick Sony PS4 Original Azul",
        "description": "Joystick original para PS4, color azul.",
        "short_description": "Joystick Sony PS4 Azul",
        "seo_title": "Joystick PS4 Original Azul",
        "seo_description": "Compra el joystick original para PS4 en color azul.",
        "seo_keywords": "joystick, ps4, sony, azul",
        "brand_id": 2,
        "visibility": 1,
        "status": 1,
        "created_at": "2023-01-01 12:00:00",
        "updated_at": "2023-01-02 12:00:00"
        "images": [
                {
                    "id": "123",
                    "product_id": "123",
                    "image_default": "202502/img_x500_67bcbb14222431-68588488-24758584.png",
                    "image_big": "202502/img_1920x_67bcbb1440c9a3-07250252-90087553.png",
                    "image_small": "202502/img_x300_67bcbb147093f2-82004391-44356872.png",
                    "is_main": "0",
                    "storage": "local"
                },
            ],
        "details": {
         "id": "123",
                "product_id": "123",
                "lang_id": "1",
                "title": "Joystick Sony PS4 Original Azul",
                "description": "lorem ipsum dolor amet"
            }
        },
    {
        "id": 124,
        "sku": "PROD12346",
        "category_id": 6,
        "price": 29.99,
        "currency": "USD",
        "stock": 50,
        "product_type": "digital",
        "title": "Juego Digital PS4",
        "description": "Juego digital para PS4, descarga inmediata.",
        "short_description": "Juego Digital PS4",
        "seo_title": "Juego Digital PS4",
        "seo_description": "Compra el juego digital para PS4.",
        "seo_keywords": "juego, ps4, digital",
        "brand_id": 3,
        "visibility": 1,
        "status": 1,
        "created_at": "2023-01-05 12:00:00",
        "updated_at": "2023-01-06 12:00:00"
    }
]

Respuesta de Error

En caso de error, se devolverá un JSON con un mensaje de error y un código de estado HTTP correspondiente.

Ejemplo de Respuesta de Error

{
    "error": "Invalid API Key"
}

Notas Adicionales

  • Autenticación: Asegúrate de que el API Key proporcionado sea válido.

  • Paginación: Utiliza el parámetro page para navegar a través de las diferentes páginas de productos.

  • Campos del Producto: Todos los campos del producto devueltos en la respuesta son solo para lectura.

Last updated