Obtener producto individual

Documentación del Endpoint: producto

URL del Endpoint

GET https://site.com/api/producto?apikey={apikey}&id={product_id}

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.

• id (int, requerido): El ID del producto que se desea obtener.

Ejemplo de Solicitud

GET https://site.com/api/producto?apikey=your_api_key&id=123

Respuesta Exitosa En caso de éxito, se devolverá un JSON con los detalles del producto, incluyendo sus variantes (si existen) y las opciones asociadas a cada variante.

Campos de Respuesta

• 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.

• product_type (string): Tipo de producto (por ejemplo, "physical" o "digital").

• 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.

• variantes (array): Lista de variantes asociadas al producto. Cada objeto variante contiene:

  • id (int): ID de la variante.

  • product_id (int): ID del producto al que pertenece la variante.

  • user_id (int): ID del usuario que creó la variante.

  • parent_id (int): ID del padre en caso de ser una copia o variante derivada (0 si es original).

  • label_names (string): Nombres de la etiqueta en diferentes idiomas (serializado).

  • variation_type (string): Tipo de variante (por ejemplo, "radio_button", "dropdown", etc.).

  • option_display_type (string): Tipo de presentación de las opciones.

  • show_images_on_slider (int): Indicador para mostrar imágenes en slider (0 o 1).

  • use_different_price (int): Indicador si la variante utiliza un precio diferente (0 o 1).

  • is_visible (int): Visibilidad de la variante (0 o 1).

  • options (array): Lista de opciones asociadas a la variante. Cada objeto opción contiene:

    • id (int): ID de la opción.

    • variation_id (int): ID de la variante a la que pertenece la opción.

    • parent_id (int): ID del padre (si aplica).

    • option_names (string): Nombres de la opción en diferentes idiomas (serializado).

    • stock (int): Stock disponible para esta opción.

    • color (string): Color asociado (si aplica).

    • price (float): Precio adicional (si la opción tiene un precio diferente).

    • discount_rate (float): Porcentaje de descuento aplicado a esta opción.

    • is_default (int): Indica si es la opción predeterminada (0 o 1).

    • use_default_price (int): Indicador de uso del precio por defecto (0 o 1).

    • no_discount (int): Indicador para no aplicar descuento (0 o 1).

• images: (array) lista de imagenes

Ejemplo de Respuesta Exitosa

{
    "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",
    "variantes": [
        {
            "id": 10,
            "product_id": 123,
            "user_id": 1,
            "parent_id": 0,
            "label_names": "[{\"lang_id\":1,\"label\":\"Color\"}]",
            "variation_type": "radio_button",
            "option_display_type": "color",
            "show_images_on_slider": 0,
            "use_different_price": 0,
            "is_visible": 1,
            "options": [
                {
                    "id": 101,
                    "variation_id": 10,
                    "parent_id": 0,
                    "option_names": "[{\"lang_id\":1,\"option_name\":\"Azul\"}]",
                    "stock": 50,
                    "color": "#0000FF",
                    "price": 0,
                    "discount_rate": 0,
                    "is_default": 1,
                    "use_default_price": 1,
                    "no_discount": 1
                },
                {
                    "id": 102,
                    "variation_id": 10,
                    "parent_id": 0,
                    "option_names": "[{\"lang_id\":1,\"option_name\":\"Rojo\"}]",
                    "stock": 30,
                    "color": "#FF0000",
                    "price": 0,
                    "discount_rate": 0,
                    "is_default": 0,
                    "use_default_price": 1,
                    "no_discount": 1
                }
            ]
        }
    ],
 "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"
        }
    ],
}

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"
}

ó

{
    "error": "Product not found"
}

Notas Adicionales

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

• Requerimiento del ID: El parámetro id es obligatorio para identificar el producto a obtener.

• Datos de Variantes: Si el producto tiene variantes, la respuesta incluirá un arreglo variantes con cada variante y, para cada una, un arreglo options con las opciones correspondientes.

• Formato de Lectura: Todos los campos del producto y sus variantes son de solo lectura a través de este endpoint.