Tiendy Documentación
API

Product

Un Producto es un elemento individual que se pone a la venta en una tienda.

Un producto puede tener una o más variantes y cero o más imágenes.

Acciones disponibles

GET /admin/products.json

Obtener una lista de todos los productos de la tienda.

GET /admin/products/count.json

Consultar el número total de productos de la tienda.

GET /admin/products/:id.json

Obtener las propiedades del producto con identificador :id.

POST /admin/products.json

Crear un nuevo producto.

PUT /admin/products/:id.json

Modificar un producto.

DELETE /admin/products/:id.json

Eliminar un producto.

Propiedades de un producto

PropiedadDescripciónEjemplo
idNúmero único que identifica al producto.{ "id" : "12345" }
handleEs el identificador único para el producto que aparece en la URL.{ "handle" : "impresora-laser" }
titleEl nombre del producto tal como lo ha configurado el usuario.{ "title" : "Impresora láser" }
typeTipo del producto tal como lo ha configurado el usuario.{ "type" : "Impresoras" }
price_minPrecio mínimo del producto (el menor precio entre todas las variantes).{ "price_min" : "19.99" }
price_maxPrecio máximo del producto (el precio mayor entre todas las variantes).{ "price_max" : "195" }
compare_at_pricePrecio antes de la rebaja de la variante con menor precio.{ "compare_at_price" : "88.25" }
descriptionDescripción del producto tal como la ha configurado el usuario. Puede contener código HTML.{ "description" : "Fantástica impresora láser multifunción..." }
visibleIndica si el producto es visible (valor: 1) o no (valor: 0) en la tienda.{ "visible" : "1" }
featured_imageNombre del archivo de la imagen principal del producto.{ "featured_image" : "impresora_laser20.jpg" }
vendorFabricante o marca del producto tal como la ha configurado el usuario.{ "vendor" : "BQ" }
created_atFecha de creación del producto.{ "created_at" : "2013-04-01 19:30:04" }
variantsLista de variantes del producto.
imagesLista de imágenes asociadas al producto.

Campos de variants

Lista de variantes del producto.

{
  "variants": [
    {
      "id": "632457",
      "product_id": "264201",
      "title": "Est\u00e1ndar \/ Blanco",
      "price": "120",
      "price_orig": "0",
      "weight": "0",
      "sku": "",
      "inventory_management": "tiendy",
      "inventory_quantity": "1",
      "inventory_policy": "deny",
      "sort_order": "0",
      "available": "1",
      "option1": "Estándar",
      "option2": "Blanco",
      "option3": "",
      "option4": "",
      "option5": "",
      "option6": "",
      "requires_shipping": "1",
      "created_at": "2012-10-02 19:27:41",
      "updated_at": "2012-10-16 12:12:20",
    },
    {
      "id": "632458",
      "product_id": "264201",
      "title": "Otra \/ Blanco",
      "price": "20.99",
      "price_orig": "39.99",
      "weight": "0",
      "sku": "",
      "inventory_management": "tiendy",
      "inventory_quantity": "0",
      "inventory_policy": "deny",
      "sort_order": "1",
      "available": "0",
      "option1": "Otra",
      "option2": "Blanco",
      "option3": "",
      "option4": "",
      "option5": "",
      "option6": "",
      "requires_shipping": "1",
      "created_at": "2012-10-02 19:27:41",
      "updated_at": "2014-10-14 13:15:18",
    }
  ]
}

Cada elemento se compone de los siguientes campos:

PropiedadDescripción
idIdentificador único para la variante
product_idIdentificador del producto al que pertenece la variante
titleNombre de la variante
requires_shippingIndica si el producto requiere ser enviado
skuIdentificador de almacén del producto (Stock Keeping Unit)
inventory_managementSi tiendy se encarga de controlar el stock entonces valdrá "tiendy"
inventory_quantityNúmero de unidades en stock
inventory_policyPolítica de actuación a la hora de vender el producto: No permitir ventas del producto cuando no hay stock (deny) ó permitir ventas aún cuando no hay suficiente stock (continue).
sort_orderNúmero de orden dentro de la lista de variantes del producto (ordenación).
availableContiene el valor 1 cuando el producto está disponible para la venta.
optionXValor de cada uno de los atributos que se aplican a la variante (Color, Talla, etc.)
created_atFecha de creación de la variante
updated_atFecha de última actualización de la variante

Campos de images

Lista de imágenes asociadas al producto.

{
  "images": [
    {
      "id": "352565",
      "created_at": "2012-08-21 12:12:32",
      "position": "0",
      "product_id": "264201",
      "filename": "264201-1364837405-4b4bbf868a8449e0d128b02ec2f60d6b.jpg",
      "description": null
    },
    {
      "id": "352567",
      "created_at": "2012-10-02 19:27:41",
      "position": "0",
      "product_id": "264201",
      "filename": "264201-1364837405-352e42bd6f0f7e531a31c5e9641d023b.jpg",
      "description": null
    },
    {
      "id": "352566",
      "created_at": "2012-08-21 12:12:32",
      "position": "1",
      "product_id": "264201",
      "filename": "264201-1364837405-b5c7feed5a329605236004d48a786741.jpg",
      "description": null
    }
  ]
}

Basado en la documentación pública de la API de Tiendy.