Saltar al contenido

Variantes

Consulta variantes y trabaja con sesiones de edición en hoja de cálculo.

Campos

idstringIdentificador único del recurso.
namestringNombre de la variante, hasta 200 caracteres; por defecto, el nombre del producto.
skustringCódigo de unidad de mantenimiento de stock (SKU).
statusenumEstado de la variante: active, inactive, outOfStock, discontinued, pendingMapping o withError.outOfStock · discontinued · pendingMapping · withError · active · inactive
pricenumberPrecio de venta en currency.
currencystringCódigo de moneda de tres letras de los precios del producto.
versioninteger
productNamestringNombre del producto.
Ver los 51 campos
productDescriptionstringDescripción del producto.
productSlugstringSlug de URL del producto.
productTypeenumTipo de producto: product, service o bundle.product · service · bundle
productIsDigitalbooleanIndica si el producto es digital.
productStatusenumEstado del producto: draft, active, inactive, outOfStock, discontinued o archived.draft · active · inactive · outOfStock · discontinued · archived
productImagestringURL de la imagen principal del producto; vacía si no tiene.
thumbnailstringURL de la imagen principal de la variante, o productImage si no tiene.
brandNamestringNombre de la marca del producto; null si no tiene.
categoryNamestringNombre de la categoría del producto; null si no tiene.
tagsarray<string>Etiquetas del producto.
barcodestringCódigo de barras de la variante, como EAN o UPC.
isDigitalbooleanIndica si la variante es digital y no requiere envío.
allowBackordersbooleanIndica si se puede comprar sin stock disponible.
onHandintegerUnidades en existencia en todas las ubicaciones.
committedintegerUnidades reservadas para pedidos pendientes en todas las ubicaciones.
availableintegerUnidades disponibles para vender en todas las ubicaciones.
orderintegerPosición entre las variantes del producto; los valores menores van primero.
isDefaultbooleanIndica si es la variante predeterminada del producto.
countryOfOriginstringPaís de origen para aduanas, hasta 10 caracteres.
hsCodestringCódigo del Sistema Armonizado para aduanas, hasta 50 caracteres.
compareAtPricenumberPrecio de comparación en currency; null si no está definido.
costPricenumberCosto unitario en currency; null si no está definido.
lowStockThresholdintegerEl stock es bajo si las unidades disponibles no superan este valor.
weightnumberPeso en unitOfMeasure.
widthnumberAncho en centímetros.
heightnumberAlto en centímetros.
lengthnumberLargo en centímetros.
unitOfMeasureenumUnidad de weight: kilogram, gram, pound u ounce.kilogram · gram · pound · ounce
requiresShippingbooleanIndica si la variante requiere envío; false en digitales y productos service o bundle.
trackInventorybooleanIndica si se controla el stock; siempre false en productos service y bundle.
imagesarray<object>Imágenes del producto asignadas a esta variante.
optionsarray<object>Valores de opción que definen la variante, como talla o color.
inventoriesarray<object>Stock por ubicación.
optionValuesobjectValores de opción por ID de opción; mismos datos que options.
createdOnstringFecha y hora de creación del recurso, en formato ISO 8601.
updatedOnstringFecha y hora de la última modificación, en formato ISO 8601.
storeIdstringID de la tienda.
productIdstringID del producto al que pertenece la variante.
sellerIdstringVendedor de la venta. Los productos propios de la tienda usan su vendedor interno.
packageIdstringID del paquete de envío, o el del producto si la variante no tiene.
shippingProfileIdstringID del perfil de envío del producto; null si no tiene.
brandIdstringID de la marca del producto; null si no tiene.
categoryIdstringID de la categoría del producto; null si no tiene.

Operaciones

MétodoRutaOperación
POST/v1/catalog/variants/sku-matchesBuscar variantes por SKU
GET/v1/catalog/variants/{variantId}Obtener variante
PATCH/v1/catalog/variants/{variantId}Actualizar variante de producto
DELETE/v1/catalog/variants/{variantId}Eliminar variante de producto
POST/v1/catalog/products/{productId}/variantsCrear variante de producto
GET/v1/catalog/products/{productId}/variantsListar variantes del producto

Última actualización: