Productos
Crea y actualiza productos, relaciones, archivos e importaciones de catálogo.
Estados
activeA la venta.
outOfStockA la venta, sin unidades.
draftBorrador. Así se crea si no envías status.
inactiveFuera de venta.
discontinuedFuera de venta.
archivedNo aparece en las listas.
Campos
idstringIdentificador único del recurso.statusenumEstado de publicación; solo los productos active y outOfStock se pueden vender.draft · active · inactive · outOfStock · discontinued · archivedskustringCódigo de unidad de mantenimiento de stock (SKU).namestringNombre visible del producto.typeenumTipo de producto: product, service o bundle.product · service · bundlecurrencystringCódigo de moneda de tres letras de los precios, como PEN.pricenumberPrecio más bajo entre las variantes activas, en la moneda de la tienda.versionintegerVer los 65 campos
isInternalSellerbooleanIndica si la venta pertenece al vendedor interno de la tienda.sellerApprovalPolicyenumCómo se moderan los productos de vendedores terceros: manualReview o autoApprove; null para el vendedor interno.manualReview · autoApprove · reviewRequestedbooleandescriptionstringDescripción completa del producto.slugstringIdentificador apto para URL.urlstringRuta del producto en la tienda, según customUrl o el patrón de URL de la tienda.customUrlstringRuta personalizada en la tienda; null si aplica el patrón de URL de la tienda.templatestringPlantilla de la tienda online asignada al producto; null usa la plantilla predeterminada.summarystringResumen breve del producto; null si no se define.conditionenumEstado del artículo: new, used o refurbished.new · used · refurbisheddiscountPercentagenumberActualmente siempre null; calcúlalo con price y compareAtPrice.taxRatenumberTasa de impuesto de respaldo en porcentaje si no aplica una tasa regional; por defecto 0.brandobjectMarca del producto; null si no tiene.variantsarray<object>Variantes del producto, sin incluir las eliminadas.compareAtPricenumberPrecio de comparación de la variante activa más barata; null si no tiene.costPricenumberCosto de la variante predeterminada en la moneda de la tienda; null si no se define.totalOnHandintegerUnidades físicas en total de las variantes activas.availableintegerUnidades disponibles para vender entre las variantes activas.committedintegerUnidades reservadas para pedidos pendientes entre las variantes activas.totalVariantsintegerCantidad de variantes, sin contar las eliminadas.activeVariantsintegerCantidad de variantes con estado active.vendorstringNombre del proveedor o fabricante; null si no se define.tagsarray<string>Etiquetas libres asignadas al producto.specificationsarray<object>Especificaciones del producto con sus valores.imagesarray<object>Imágenes y videos del producto, ordenados por order.categoryobjectCategoría del producto; null si no tiene.bundleItemsarray<object>Componentes de un bundle; vacío en otros tipos de producto.moderationReasonstringMotivo de rechazo o de cambios pedidos por el revisor; null si no hay.metaTitlestringTítulo SEO; null si no se define.metaDescriptionstringDescripción SEO; null si no se define.metaKeywordsarray<string>Palabras clave SEO; null si no se definen.featuredUntilstringFin del período destacado; hoy nunca se asigna, así que siempre es null.isFeaturedbooleanIndica si el producto está marcado como destacado.minOrderQuantityintegerCantidad mínima por pedido.maxOrderQuantityintegerCantidad máxima por pedido; null significa sin límite.isDigitalbooleanIndica si el producto es digital y no requiere envío.hasVariantsbooleanIndica si el producto tiene más de una variante.hasOptionsbooleanIndica si alguna variante usa opciones como talla o color.hasModifiersbooleanIndica si el producto tiene al menos una personalización asignada.hasActivitybooleanIndica si se registró alguna actividad del producto.hasPriceListsbooleanIndica si el producto pertenece al menos a una lista de precios.hasReviewsbooleanIndica si el producto tiene al menos una reseña aprobada.hasSizeGuidebooleanIndica si aplica una guía de tallas activa, directa o por su categoría.sizeGuideobjectSiempre null aquí; usa el endpoint de guía de tallas del producto.viewsintegerVisitas a la página del producto; aún no se registran, así que siempre es 0.salesCountnumberUnidades vendidas en pedidos confirmados, descontando devoluciones y reembolsos.reviewsCountintegerCantidad de reseñas aprobadas.collectionsarray<object>Colecciones que incluyen el producto.createdOnstringFecha y hora de creación del recurso, en formato ISO 8601.updatedOnstringFecha y hora de la última modificación, en formato ISO 8601.lastActivityOnstringCuándo se registró la última actividad del producto, en UTC; null si nunca.operationIdstringstoreIdstringID de la tienda.sellerIdstringVendedor de la venta. Los productos propios de la tienda usan su vendedor interno.packageIdstringID del paquete de envío predeterminado; null si no tiene.shippingProfileIdstringID del perfil de envío asignado; null si no tiene.modifierGroupIdsarray<string>IDs de las personalizaciones asignadas al producto, en el orden de la tienda.Operaciones
| Método | Ruta | Operación |
|---|---|---|
POST | / | Crear producto |
GET | / | Listar productos |
GET | / | Obtener producto por ID |
GET | / | Contar productos |
PATCH | / | Actualizar producto |
DELETE | / | Eliminar producto |
POST | / | Crear reseña |
GET | / | Consultar una creación de producto |
GET | / | Listar precios del producto |
Importar y exportar
| Método | Ruta | Operación |
|---|---|---|
POST | / | Exportar productos |
POST | / | Importar productos |
Lotes
| Método | Ruta | Operación |
|---|---|---|
POST | / | Crear o actualizar productos en lote |
POST | / | Actualizar colecciones de productos en lote |
POST | / | Eliminar productos en lote |
POST | / | Asignar personalizaciones en lote |
POST | / | Actualizar precios en lote |
POST | / | Actualizar estado en lote |
POST | / | Actualizar etiquetas de productos en lote |
Guía de tallas
| Método | Ruta | Operación |
|---|---|---|
GET | / | Obtener guía de tallas |
PUT | / | Definir guía de tallas |
Última actualización: