Skip to navigation

Listar variantes

Las combinaciones activas de la cuenta. Se escriben a través de su producto — son sus opciones cruzadas, no registros sueltos — pero se leen aquí, porque una integración tiene a mano un SKU y no un producto más un par de valores de opción.

Cada una trae su price_id: úsalo en items[].price_id al crear un checkout para vender esa combinación.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Query parameters

pageintegerOptionalDefaults to 1
limitintegerOptional<=100

Response

Una página de variantes

idstringOptional
product_idstringOptional

El producto al que pertenece esta combinación. El SKU es único por producto, no por cuenta, así que es lo que permite resolver una fila de la lista.

statusenumOptional
Allowed values:
titlestringOptional

Los valores unidos por " / ".

option_valueslist of stringsOptional
skustring or nullOptional
price_idstringOptional
El precio de esta variante.
amount_in_centsintegerOptional
currencystringOptional
inventory_quantityinteger or nullOptional

Existencias de esta variante. null es ilimitado. Baja con cada venta pagada de esta variante y puede quedar en negativo si se vendió más de lo que había; un número escrito aquí es cero o más.

low_stock_thresholdinteger or nullOptional

Desde qué cantidad se considera baja esta variante. null usa el valor por defecto de la cuenta.