Saltar al contenido principal
GET
List Checkouts
Esta API está en Beta. Los endpoints y los esquemas pueden cambiar sin previo aviso.
Los resultados se ordenan con el predeterminado primero y luego por actualización más reciente, e incluyen los checkouts ARCHIVED. El id de cada elemento es el checkout_code que usan los endpoints Obtener y Publicar. La paginación es opcional: sin page ni size, la respuesta es un arreglo simple con todos los checkouts que coinciden; si envías cualquiera de los dos, la respuesta pasa a un envoltorio paginado (data + pagination, donde total es el conteo completo filtrado).

Autorizaciones

PUBLIC-API-KEY
string
header
requerido

Clave de API pública del comercio. Se encuentra en el Dashboard de Yuno → Settings → API Keys.

PRIVATE-SECRET-KEY
string
header
requerido

Clave secreta privada del comercio, asociada a la clave pública. Nunca la incluyas en código del lado del cliente.

X-Account-Code
string
header
requerido

UUID del ámbito de la cuenta del comercio para la solicitud. El tenant se resuelve únicamente a partir de este encabezado.

Parámetros de consulta

name
string

Filtro de contiene, sin distinguir mayúsculas y minúsculas, sobre el nombre del checkout. Los metacaracteres de LIKE (% y _) coinciden de forma literal.

id
string

Filtro de contiene, sin distinguir mayúsculas y minúsculas, sobre el identificador del checkout.

status
enum<string>

Filtra por estado. Acepta uno o varios valores (OR): repite el parámetro o envía una lista separada por comas (status=PUBLISHED,ARCHIVED). Los valores no válidos se rechazan con 400. Si se omite: todos los estados.

Opciones disponibles:
PUBLISHED,
NOT_PUBLISHED,
ARCHIVED
created_after
string<date-time>

Límite inferior inclusivo de created_at (instante ISO-8601, p. ej., 2026-05-01T00:00:00Z).

created_before
string<date-time>

Límite superior inclusivo de created_at (instante ISO-8601).

updated_after
string<date-time>

Límite inferior inclusivo de updated_at (instante ISO-8601).

updated_before
string<date-time>

Límite superior inclusivo de updated_at (instante ISO-8601).

page
integer
predeterminado:1

Número de página (base 1). Paginación opcional: si envías page o size, la respuesta pasa al envoltorio paginado. Valor predeterminado: 1. Los valores no numéricos se rechazan con 400.

Rango requerido: x >= 1
size
integer
predeterminado:25

Tamaño de página. Paginación opcional: si envías page o size, la respuesta pasa al envoltorio paginado. Valor predeterminado: 25, con un máximo de 100. Los valores no numéricos se rechazan con 400.

Rango requerido: 1 <= x <= 100

Respuesta

Los checkouts de la cuenta. Un arreglo simple cuando page y size están ausentes; un envoltorio paginado (data + pagination) cuando está presente cualquiera de los dos. Los elementos incluyen los mismos 7 campos en ambos formatos. pagination.total es el conteo total filtrado, no el número de filas de la página.

id
string

Identificador del checkout (UUID). Úsalo como checkout_code en los endpoints de consulta y publicación.

name
string

Nombre del checkout.

description
string

Descripción del checkout.

status
enum<string>

Estado del checkout.

Opciones disponibles:
PUBLISHED,
NOT_PUBLISHED,
ARCHIVED
is_default
boolean

Indica si este checkout es el predeterminado de la cuenta.

created_at
string<date-time>

Marca de tiempo de creación (ISO-8601).

updated_at
string<date-time>

Marca de tiempo de la última actualización (ISO-8601).