Cómo gestionar los productos vía API
π Más información sobre Productos
Obtener todos los productos
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- page: número de página. Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado. Por defecto 100 si no es proporcionado (valor máximo).
Respuesta:
Lista de productos.
Ejemplo:
{
"result": {
"count": "2",
"items": [
{
"codigo": "ABC 123",
"activo": "1",
"destacado": "0",
"fecha_alta": "2012-02-28 02:00:00",
"nombre_es": "Producto 1",
"nombre_en": "Product 1",
"descripcion_corta_es": "",
"descripcion_corta_en": "",
"descripcion_larga_es": "",
"descripcion_larga_en": "",
"precio_por_variante1": "0"
},
{
"codigo": "DEF-456",
"activo": "0",
"destacado": "1",
"fecha_alta": "2012-08-02 01:00:00",
"nombre_es": "Producto 2",
"nombre_en": "Product 2",
"descripcion_corta_es": "desc esp",
"descripcion_corta_en": "desc ing",
"descripcion_larga_es": "desc esp",
"descripcion_larga_en": "desc ing",
"precio_por_variante1": "1"
}
]
}
}
Obtener la cantidad de productos
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/count?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Cantidad de productos.
Ejemplo:
{
"result": {
"count": "26"
}
}
Obtener un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Datos de un producto.
Ejemplo:
{
"result": {
"item": {
"codigo": "GHI-678",
"activo": "1",
"destacado": "0",
"fecha_alta": "2022-04-28 15:37:00",
"nombre_es": "Producto 3",
"nombre_en": "Product 3",
"descripcion_corta_es": "desc esp",
"descripcion_corta_en": "desc ing",
"descripcion_larga_es": "desc esp",
"descripcion_larga_en": "desc ing",
"precio_por_variante1": "1"
}
}
}
Crear un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos?apikey={CLAVE DE API}
Método HTTP:
POST
Parámetros:
- codigo: código que se le asigna al producto para poder identificarlo.
- activo: indica si el producto aparecerá publicado en el sitio web. Valores posibles: 0 (desactivado), 1 (activado).
- destacado: indica si el producto aparecerá destacado en el sitio web. Valores posibles: 0 (desactivado), 1 (activado).
- nombre_es: nombre del producto en idioma español.
- nombre_en: nombre del producto en idioma inglés.
- descripcion_corta_es: descripción que se muestra en el listado de productos (español).
- descripcion_corta_en: descripción que se muestra en el listado de productos (inglés).
- descripcion_larga_es: descripción que se muestra en la ficha ampliada del producto (español).
- descripcion_larga_en: descripción que se muestra en la ficha ampliada del producto (inglés).
- precio_por_variante1: indica si el producto utilizará precios que dependan de su variante primaria. Valores posibles: 0 (el precio será el mismo para todas las variantes del producto), 1 (el precio podrá ser diferente para cada variante).
Respuesta:
Cantidad de productos creados.
Ejemplo:
{
"result": {
"count": "1"
}
}
Modificar un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}?apikey={CLAVE DE API}
Método HTTP:
PUT
Parámetros:
- codigo: código que se le asigna al producto para poder identificarlo. Si se envía este valor no puede estar vacío.
- activo: indica si el producto aparecerá publicado en el sitio web. Valores posibles: 0 (desactivado), 1 (activado).
- destacado: indica si el producto aparecerá destacado en el sitio web. Valores posibles: 0 (desactivado), 1 (activado).
- nombre_es: nombre del producto en idioma español.
- nombre_en: nombre del producto en idioma inglés.
- descripcion_corta_es: descripción que se muestra en el listado de productos (español).
- descripcion_corta_en: descripción que se muestra en el listado de productos (inglés).
- descripcion_larga_es: descripción que se muestra en la ficha ampliada del producto (español).
- descripcion_larga_en: descripción que se muestra en la ficha ampliada del producto (inglés).
- precio_por_variante1: indica si el producto utilizará precios que dependan de su variante primaria. Valores posibles: 0 (el precio será el mismo para todas las variantes del producto), 1 (el precio podrá ser diferente para cada variante).
Nota: los campos que no se quieran modificar no deben ser incluidos en el conjunto de datos.
Respuesta:
Cantidad de productos modificados.
Ejemplo:
{
"result": {
"count": "1"
}
}
Borrar un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}?apikey={CLAVE DE API}
Método HTTP:
DELETE
Parámetros:
- Ninguno.
Respuesta:
Cantidad de productos borrados.
Ejemplo:
{
"result": {
"count": "1"
}
}
Obtener las categorías de un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/categorias?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Lista de categorias.
Ejemplo:
{
"result": {
"count": "2",
"items": [
{
"codigo": "CAT-01",
"activo": "1",
"nombre_es": "Categoría 1",
"nombre_en": "",
"codigo_padre": ""
},
{
"codigo": "CAT-02",
"activo": "1",
"nombre_es": "Categoría 2",
"nombre_en": "",
"codigo_padre": ""
}
]
}
}
Agregar una categoría a un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/categorias?apikey={CLAVE DE API}
Método HTTP:
POST
Parámetros:
- categoria_codigo: código que identifica a la categoría.
Respuesta:
Cantidad de categorías agregadas al producto.
Ejemplo:
{
"result": {
"count": "1"
}
}
Quitar una categoría a un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/categorias?apikey={CLAVE DE API}
Método HTTP:
DELETE
Parámetros:
- categoria_codigo: código que identifica a la categoría.
Respuesta:
Cantidad de categorías quitadas al producto.
Ejemplo:
{
"result": {
"count": "1"
}
}
Obtener las variantes primarias de un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/variantes1?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Lista de variantes.
Ejemplo:
{
"result": {
"count": "3",
"items": [
{
"codigo": "TAM-CHICO",
"activo": "1",
"nombre_es": "chico",
"nombre_en": ""
},
{
"codigo": "TAM-GRANDE",
"activo": "1",
"nombre_es": "grande",
"nombre_en": ""
},
{
"codigo": "TAM-MEDIANO",
"activo": "1",
"nombre_es": "mediano",
"nombre_en": ""
}
]
}
}
Agregar una variante primaria a un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/variantes1?apikey={CLAVE DE API}
Método HTTP:
POST
Parámetros:
- variante1_codigo: código identificador de la variante.
Respuesta:
Cantidad de variantes agregadas al producto.
Ejemplo:
{
"result": {
"count": "1"
}
}
Quitar una variante primaria a un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/variantes1?apikey={CLAVE DE API}
Método HTTP:
DELETE
Parámetros:
- variante1_codigo: código identificador de la variante.
Respuesta:
Cantidad de variantes quitadas al producto.
Ejemplo:
{
"result": {
"count": "1"
}
}
Obtener las variantes secundarias de un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/variantes2?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Lista de variantes.
Ejemplo:
{
"result": {
"count": "3",
"items": [
{
"codigo": "COL-AZUL",
"activo": "1",
"nombre_es": "azul",
"nombre_en": ""
},
{
"codigo": "COL-ROJO",
"activo": "1",
"nombre_es": "rojo",
"nombre_en": ""
},
{
"codigo": "COL-VERDE",
"activo": "1",
"nombre_es": "verde",
"nombre_en": ""
}
]
}
}
Agregar una variante secundaria a un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/variantes2?apikey={CLAVE DE API}
Método HTTP:
POST
Parámetros:
- variante2_codigo: código identificador de la variante.
Respuesta:
Cantidad de variantes agregadas al producto.
Ejemplo:
{
"result": {
"count": "1"
}
}
Quitar una variante secundaria a un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/variantes2?apikey={CLAVE DE API}
Método HTTP:
DELETE
Parámetros:
- variante2_codigo: código identificador de la variante.
Respuesta:
Cantidad de variantes quitadas al producto.
Ejemplo:
{
"result": {
"count": "1"
}
}
