Saltar al contenido principal
PATCH
Esta API está en Beta. Los Endpoints y los esquemas pueden cambiar sin previo aviso.
El cuerpo admite cualquier combinación de name, description, status e is_default; se requiere al menos un campo. Los metadatos (name/description) se pueden editar en cualquier estado, incluido ARCHIVED; la configuración y los estilos de un checkout archivado permanecen congelados (el endpoint Publish lo rechaza).

Máquina de estados del ciclo de vida

  • Publicar (status: PUBLISHED) solo es válido desde NOT_PUBLISHED.
  • Restaurar se hace en dos pasos: un checkout ARCHIVED vuelve primero a borrador (status: NOT_PUBLISHED) y luego se puede publicar (status: PUBLISHED). Un patch directo de ARCHIVED → PUBLISHED se rechaza con 400 INVALID_STATUS_TRANSITION.
  • Hacer patch al estado actual también se rechaza con 400.
  • Promover (is_default: true) publica a la fuerza el checkout desde cualquier estado (incluido ARCHIVED) y degrada de forma atómica al predeterminado anterior. Cuando se envía junto con status, prevalece la promoción y status se ignora. is_default: false se rechaza con 400; para degradar un checkout predeterminado, promueve otro checkout.
  • El checkout predeterminado está protegido: archivarlo o despublicarlo se rechaza con 409 para que la tienda de la cuenta nunca se quede sin un checkout activo.

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.

Encabezados

X-Idempotency-Key
string

Clave opcional del cliente, de hasta 64 caracteres. Se aplica con el mejor esfuerzo; si se reenvía la misma clave, no se garantiza que se elimine la duplicación.

Parámetros de ruta

checkout_code
string
requerido

El identificador único del checkout que se va a actualizar (UUID, 36 caracteres). Los valores que no son UUID se rechazan con 400 antes de procesarse.

Cuerpo

application/json
name
string

Nuevo nombre del checkout. Único por cuenta (un nombre duplicado se rechaza con 409). Editable en cualquier estado, incluido ARCHIVED.

description
string

Nueva descripción del checkout. Editable en cualquier estado, incluido ARCHIVED.

status
enum<string>

Estado de ciclo de vida de destino. PUBLISHED solo se alcanza desde NOT_PUBLISHED; NOT_PUBLISHED se alcanza desde PUBLISHED (despublicar) o ARCHIVED (restaurar); ARCHIVED se alcanza desde PUBLISHED o NOT_PUBLISHED. Cualquier otra transición (incluida la actualización al estado actual) se rechaza con 400. Los valores desconocidos se rechazan con 400.

Opciones disponibles:
PUBLISHED,
NOT_PUBLISHED,
ARCHIVED
is_default
boolean

Solo se acepta true: promueve este checkout a predeterminado de la cuenta, lo publica de forma forzada desde cualquier estado y degrada de forma atómica al predeterminado anterior. false se rechaza con 400; para degradar, promueve otro checkout.

Respuesta

El resumen del checkout actualizado. El identificador se expone como el id de nivel superior. Consulta el status resultante con el endpoint Fetch.

id
string

Identificador del checkout (UUID).

name
string

Nombre del checkout.

description
string

Descripción del checkout.

is_default
boolean

Indica si este checkout es el predeterminado de la cuenta.

is_active
boolean

Indica si el checkout está activo (atendiendo tráfico).

created_at
string<date-time>

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