> ## Documentation Index > Fetch the complete documentation index at: https://docs.stockshift.io/llms.txt > Use this file to discover all available pages before exploring further. # Guarda el borrador de una automatización > Reemplaza la definición del borrador, y crea un borrador cuando la automatización no tiene ninguno. Se rechaza una definición que rompe el esquema: más pasos de los que permite la configuración `max_steps` de la organización, un paso que el catálogo de pasos no tiene o una entrada que el paso no tiene. Una asignación que no encaja con su entrada se guarda y se lista en `problems`, y el borrador no se puede publicar hasta corregirla. Requiere el permiso `automation.automations.manage` y un token con `automation:write`. ## OpenAPI ````yaml /openapi.es.json put /automation/automations/{automation}/draft openapi: 3.1.2 info: title: StockShift API version: 1.0.0 description: >- La API REST de StockShift. Empieza con las guías de autenticación, alcances, paginación, errores y webhooks. servers: - url: https://app.stockshift.io/api/v1 description: Producción - url: https://app.beta.stockshift.io/api/v1 description: Beta security: - apiKey: [] - oauth2: [] tags: - name: Acciones de existencias con testigo description: >- Retiene una acción de existencias para una segunda persona, que recuenta a ciegas y firma, y lee ambas firmas. Las existencias solo cambian cuando el testigo firma. - name: Existencias del artículo description: >- Todo sobre las existencias de un artículo: dónde están, qué está prometido, cómo se rastrean y cuánto cuestan. - name: Transferencias description: >- Mueve existencias de una ubicación a otra, con tiempo en tránsito entre el envío y la recepción. - name: Costos de importación description: >- Agrega flete, aranceles y otros cargos al costo de las existencias que recibiste. - name: Conteos de existencias description: >- Cuenta lo que hay en el estante, compáralo con lo que StockShift espera y contabiliza la diferencia cuando alguien la apruebe. - name: Ubicaciones description: >- Los almacenes, salas y contenedores donde se guardan las existencias. La mayoría de las llamadas de existencias necesitan un ID de ubicación de aquí. - name: Periodos description: >- Cierra cada mes una vez informado: bloquea lo que tiene fecha en él, comprueba que no quede nada abierto y conserva el valor de las existencias al final. - name: Importaciones de inventario description: >- Carga las existencias iniciales desde un archivo CSV, con una vista previa antes de contabilizar nada. - name: Solicitudes de liberación description: >- Pide a Calidad que libere existencias retenidas, y rechaza o retira la solicitud. Liberar las existencias la cierra. - name: Firmantes description: >- Quién puede firmar acciones de existencias con testigo: de quién se verificó la identidad, cómo y cuándo, y las firmas fallidas que deben ver los revisores. - name: Existencias description: >- Cuánto hay de cada artículo y dónde. Consulta los niveles, ahora o en una fecha pasada, y contabiliza ajustes cuando se encuentren, pierdan o dañen existencias. - name: Reglas de testigo description: >- Qué acciones de existencias esperan a que una segunda persona vuelva a contar y firme, como retirar una sustancia controlada. - name: Reglas de asignación description: >- Qué lotes se toman primero cuando se reservan o se envían existencias, como primero en caducar, primero en salir. - name: Configuración de inventario description: >- Cómo maneja la organización las existencias, por ejemplo si pueden quedar en negativo y cómo se costean. - name: Lotes description: Lotes de existencias que comparten un número de lote, y cuándo vencen. - name: Movimientos description: >- El libro detrás de cada nivel de existencias. Los movimientos nunca se editan; se corrigen revirtiéndolos. - name: Números de serie description: Unidades con seguimiento individual y dónde está cada una ahora. - name: Movimientos de existencias description: >- Mueve existencias de una ubicación a otra en un solo paso, por ejemplo de un muelle a un estante, y deshaz un movimiento completo. - name: Vistas previas masivas description: >- Revisa una lista de líneas de existencias antes de un movimiento masivo, un ajuste, una retención o una impresión, y ve qué debe decidirse en cada línea. - name: Artículos description: >- Los productos y materiales que almacenas, compras, fabricas o vendes. El ID o el SKU de un artículo es lo que piden la mayoría de los demás endpoints. - name: Familias description: >- Grupos de artículos que solo se diferencian por opciones como la talla o el color, y las variantes que se hacen con ellos. - name: Importaciones de catálogo description: >- Crea o actualiza artículos desde un archivo CSV, con una vista previa antes de guardar nada. - name: Campos personalizados description: >- Campos adicionales que la organización agrega a sus artículos. Defínelos aquí y luego asigna sus valores en cada artículo. - name: Biblioteca de productos description: >- Busca un producto por su GTIN y crea un artículo con lo que la biblioteca sabe de él. - name: Unidades description: >- Unidades de medida, como each, box o kg. Los artículos se cuentan en una unidad base y se convierten desde las demás. - name: Escaneo description: >- Convierte un código de barras escaneado en el artículo, la unidad o la pieza etiquetada que identifica. - name: Proveedores description: >- Las empresas a las que compras, las personas con las que tratas allí y lo que te cobran. - name: Órdenes de compra description: >- Órdenes a proveedores. Crea un borrador, apruébalo, envíalo y recibe la mercancía contra él. - name: Importaciones de compras description: Carga proveedores y sus catálogos desde archivos CSV. - name: Configuración de compras description: >- Cómo compra la organización, por ejemplo el umbral de aprobación y cuánto puede superar una recepción a la orden. - name: Recepciones description: >- Mercancía recibida contra órdenes de compra. Revierte una recepción para corregirla o imprime etiquetas de lo que llegó. - name: Proveedores del artículo description: Qué proveedores venden un artículo, y a qué precio. - name: Exportaciones de compras description: >- Descarga proveedores o sus catálogos como CSV, en las mismas columnas que lee la importación. - name: Pedidos de venta description: >- Pedidos de clientes. Toma uno como borrador, confírmalo para reservar existencias, luego envíalo y factúralo. - name: Clientes description: Las empresas a las que vendes y las personas con las que tratas allí. - name: Facturas description: Facturas de lo que has vendido y los pagos registrados contra ellas. - name: Listas de precios description: >- Los precios que paga un cliente, con escalas por cantidad. Asígnale una lista de precios a un cliente y sus pedidos se calculan solos. - name: Cotizaciones description: >- Ofertas a clientes. Una cotización aceptada se convierte en un pedido de venta. - name: Tasas de impuestos description: Las tasas de impuesto sobre las ventas con las que se cobran las facturas. - name: Importaciones de ventas description: Carga clientes y listas de precios desde archivos CSV. - name: Devoluciones description: >- Mercancía que los clientes devuelven: autoriza la devolución, luego recíbela en las existencias y acredítala. - name: Envíos description: Lo que salió del edificio por cada pedido de venta. - name: Configuración de ventas description: >- Cómo vende la organización, por ejemplo cuándo se reservan las existencias y si las facturas pueden salir antes del envío. - name: Certificados de conformidad description: >- Certificados firmados de que los productos de un envío cumplen con el pedido, conservados exactamente como se firmaron. - name: Precios description: >- Consulta cuánto pagaría un cliente por una cantidad de un artículo antes de ponerlo en un pedido. - name: Exportaciones de ventas description: >- Descarga clientes y listas de precios como CSV, en las mismas columnas que lee la importación. - name: Órdenes de fabricación description: >- Órdenes para fabricar algo. Libera una orden de fabricación al piso, consume sus piezas y complétala hacia las existencias. - name: Reparaciones description: >- Reparaciones de unidades que los clientes devuelven: revisa la garantía, registra las piezas puestas y retiradas, y luego completa la reparación o factúrala. - name: Rutas description: >- Los pasos por los que pasa una orden de fabricación y el centro de trabajo en el que se ejecuta cada paso. - name: Centros de trabajo description: Las máquinas, celdas o equipos donde se hacen los pasos de una ruta. - name: Plazos de garantía description: >- Cuánto tiempo un artículo está en garantía y si cuenta desde el envío o la fabricación, con condiciones propias para algunos clientes. - name: Trazabilidad description: >- Rastrea un lote o número de serie hacia atrás hasta lo que entró en él, o hacia adelante hasta aquello en lo que entró. - name: Configuración de fabricación description: >- Cómo fabrica la organización, por ejemplo si las operaciones pueden superponerse y el estado en el que entran los productos terminados. - name: Programación description: Planifica las órdenes de fabricación abiertas en días hábiles. - name: Variaciones de costo description: >- Dónde una orden de fabricación completada costó más o menos que su costo estándar. - name: BOM description: >- Listas de materiales: las piezas y cantidades que forman un artículo, guardadas como revisiones. - name: Cambios de ingeniería description: >- Órdenes de cambio que proponen revisiones nuevas de BOM y las liberan una vez aprobadas. - name: Importaciones de ingeniería description: Carga listas de materiales desde un archivo CSV o una exportación de CAD. - name: Configuración de Ingeniería description: >- Cómo gestiona la organización los cambios de ingeniería, por ejemplo cuántas aprobaciones necesita una orden de cambio. - name: Exportaciones de ingeniería description: >- Descarga listas de materiales como CSV, en las mismas columnas que lee la importación. - name: Dónde se usa description: >- Encuentra todas las BOM en las que aparece un artículo, antes de cambiarlo o retirarlo. - name: Planes de inspección description: >- Qué revisar, en qué artículos y cuántos: las características, el muestreo y el punto de inspección de cada plan. - name: Inspecciones description: >- Inspecciones abiertas por recepciones, operaciones y órdenes de fabricación. Registra sus resultados para aprobar o rechazar las existencias que retienen. - name: Pronósticos description: >- La demanda esperada de cada artículo, semana por semana, y los cambios que hacen los planificadores. - name: Escenarios description: Copias del pronóstico para probar cambios sin tocar el plan real. - name: Demanda description: >- Demanda pasada de un artículo en una ubicación, a partir de la cual se construyen los pronósticos. - name: Sugerencias description: >- Lo que el plan dice que se compre o se fabrique. Acepta uno para generar la orden de compra o la orden de fabricación, o descártalo. - name: Reabastecimiento description: >- Cómo se mantiene cada artículo en existencias en cada ubicación: puntos de reorden, mínimos y máximos o revisión periódica. - name: Días festivos description: >- Días en que la organización no trabaja, que el plan omite al contar plazos de entrega. - name: Configuración de planificación description: >- Cómo planifica la organización, por ejemplo el horizonte del pronóstico y el nivel de servicio. - name: Automatizaciones description: >- Reglas que ejecutan pasos cuando ocurre algo o según una programación. Edita el borrador y luego publícalo para activarla. - name: Ejecuciones description: >- Cada vez que se ejecutó una automatización: qué la inició, qué hizo cada paso y dónde falló. - name: Aprobaciones description: >- Ejecuciones en pausa a la espera de que una persona las apruebe o rechace antes de continuar. - name: Configuración de automatización description: >- Límites de toda la organización para las automatizaciones, como las ejecuciones por minuto y si alguien puede aprobar su propia ejecución. - name: Plantillas de automatización description: Automatizaciones prediseñadas para empezar. - name: Eventos description: >- Los eventos que pueden activar una automatización y los datos que lleva cada uno. - name: Catálogo de pasos description: >- Todos los pasos que puede usar una automatización y las entradas que toma cada uno. - name: Vistas description: >- Reportes guardados: el conjunto de datos, los filtros, la agrupación y el gráfico que alguien configuró, listos para ejecutarse de nuevo. - name: Paneles description: Páginas de gráficos y KPI dispuestos en una cuadrícula. - name: Conjuntos de datos description: >- Los datos sobre los que puedes reportar y los campos de cada uno. Empieza aquí para crear un reporte. - name: Programaciones description: >- Envía un reporte por correo electrónico según una programación, o avisa a alguien cuando un valor cruza un umbral. - name: KPI description: >- Cifras individuales que vale la pena vigilar, definidas como una fórmula sobre un conjunto de datos. - name: Panel description: >- Las cifras de la pantalla de inicio de la app, por si quieres mostrar los mismos números en otro lugar. - name: Carpetas de vistas description: Carpetas que mantienen organizadas las vistas guardadas. - name: Exportaciones de Insights description: >- Exporta un informe a un archivo. Las exportaciones grandes se ejecutan en segundo plano y están listas para descargar más tarde. - name: Plantillas de reportes description: >- Reportes prediseñados, como el envejecimiento de existencias, para empezar una vista. - name: Reportes description: >- Ejecuta la definición de un reporte y obtén sus filas o su gráfico, sin guardarla antes. - name: Plantillas de panel description: Paneles prediseñados para empezar. - name: Fórmulas description: >- Comprueba una fórmula contra un conjunto de datos antes de guardarla en un KPI o en un campo calculado. - name: Conexiones description: >- Cuentas conectadas en otros sistemas, qué sincroniza cada una y el historial de sus ejecuciones de sincronización. - name: Envío description: >- Tarifas de transportistas, las etiquetas compradas para pedidos y devoluciones, y los escaneos que rastrean cada paquete. - name: Migraciones description: >- Trae registros de otro sistema: prepara archivos o una extracción, asigna las columnas, revisa las filas, confírmalas y deshaz la confirmación. - name: Abastecimiento description: >- Precios y existencias de piezas de distribuidores: busca en un distribuidor conectado, vincula artículos con sus piezas y calcula el precio de una revisión de BOM. - name: CAD description: >- Ensambles de CAD y PLM: lista los ensambles de una herramienta conectada y vigila aquellos cuyas liberaciones se convierten en importaciones de BOM. - name: Exportación de datos description: >- Todo lo que guarda la organización en un solo ZIP de archivos CSV y de líneas JSON, para que el propietario lo descargue. - name: Direcciones fiscales description: >- Las direcciones por las que un servicio de impuestos conectado calcula el impuesto de cada venta, comprobadas con él. - name: Conectores description: >- Los sistemas a los que puede conectarse StockShift y lo que puede sincronizar cada conector. - name: Conjuntos de etiquetas description: >- Todos los lotes de etiquetas impresos, para que puedas encontrar uno de nuevo y reimprimirlo. - name: Plantillas de etiquetas description: Los diseños con que se imprimen las etiquetas. - name: Piezas description: >- Busca una pieza etiquetada a partir del código de su etiqueta: el artículo, el lote o la serie y cuánto contiene. - name: Marca y plantillas description: >- El logotipo, los colores, los términos y los campos personalizados con que se imprime cada cotización, orden de compra, factura y lista de empaque. - name: Apps móviles description: >- Cómo las apps móviles de StockShift registran un dispositivo, inician sesión y se mantienen sincronizadas con el servidor. - name: Dispositivos description: >- Los teléfonos y escáneres registrados en la organización. Bloquea uno perdido, bórralo o retíralo. - name: Configuración del escáner description: >- Hojas imprimibles de códigos de barras que configuran un escáner de hardware, y las preferencias de escáner de cada persona. - name: Inscripciones description: Crea los códigos QR que inscriben dispositivos compartidos y quioscos. - name: Feeds de sincronización description: >- Descarga una instantánea de los datos que necesita un dispositivo y luego obtén los cambios desde entonces. - name: Comandos de sincronización description: >- Envía los cambios que un dispositivo hizo sin conexión. Cada comando se aplica una sola vez, sin importar cuántas veces se envíe. - name: Archivos de sincronización description: >- Descarga los archivos, como imágenes de artículos, a los que apunta un feed. - name: Perfil description: >- La cuenta propia de la persona que inició sesión: sus datos, contraseña, llaves de acceso, segundo factor y sesiones. - name: Notificaciones description: >- La bandeja de entrada del miembro que inició sesión: lo que lo necesita, lo que no ha leído, y de qué se le avisa y cómo. - name: Invitaciones description: Invita a personas a unirse a la organización y acepta una invitación. - name: Roles description: >- Roles y los permisos de cada uno. Un miembro puede hacer lo que sus roles permiten. - name: Acceso del personal description: >- Solicitudes del soporte de StockShift para ver los datos de la organización, que un propietario debe conceder. - name: Equipo description: Las personas de la organización y los roles que tienen. - name: Claves de API description: >- Crea y revoca las claves que usan los scripts y las integraciones para llamar a esta API. - name: Organizaciones description: Las organizaciones a las que pertenece la persona que inició sesión. - name: Firmas description: >- Algunas acciones necesitan una firma electrónica. Obtén aquí un token de firma y envíalo con la llamada. - name: Registro description: Regístrate para obtener una cuenta y una organización nuevas. - name: Organización description: >- Política de toda la organización: cuánto tiempo se conservan los registros, reglas de sesión, retenciones legales y cierre de la organización. - name: Aceptaciones legales description: >- Las versiones de los Términos de servicio y de la Política de privacidad que aceptó la organización, las versiones que esperan a un propietario y un certificado de cada aceptación. - name: Dirección description: >- La dirección de facturación que aparece en las facturas de la organización. - name: Historial description: Quién cambió qué campo de un registro, cuándo y a partir de qué. - name: Certificados de destrucción description: Comprueba que un certificado de destrucción de datos es auténtico. - name: Facturación description: >- Consulta o cambia el plan, compra paquetes de ejecuciones para automatizaciones, ve las facturas y actualiza el método de pago. - name: Webhooks description: >- Registra URL para que te avisen cuando pasen cosas, y consulta cada entrega y su respuesta. - name: Apps OAuth description: >- Las apps de terceros que los miembros conectaron mediante OAuth. Revoca una para cortar su acceso. - name: Hooks REST description: >- Para apps conectadas como Zapier: suscribe un evento a una URL y cancela la suscripción. - name: Servidor MCP description: >- Deja que un asistente de IA trabaje en StockShift a través del Model Context Protocol, con los mismos permisos que el miembro que lo conecta. - name: Eventos recientes description: >- Los últimos eventos de un tipo, tal como los envían las entregas, para consultar periódicamente o usar como muestras. - name: Eventos de webhook description: >- Todos los eventos que pueden enviar los webhooks y los REST hooks, con la forma de sus datos. paths: /automation/automations/{automation}/draft: put: tags: - Automatizaciones summary: Guarda el borrador de una automatización description: >- Reemplaza la definición del borrador, y crea un borrador cuando la automatización no tiene ninguno. Se rechaza una definición que rompe el esquema: más pasos de los que permite la configuración `max_steps` de la organización, un paso que el catálogo de pasos no tiene o una entrada que el paso no tiene. Una asignación que no encaja con su entrada se guarda y se lista en `problems`, y el borrador no se puede publicar hasta corregirla. Requiere el permiso `automation.automations.manage` y un token con `automation:write`. operationId: v1.automation.automations.draft.update parameters: - name: automation in: path required: true description: El ID de la automatización, un UUID. schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DraftRequest' responses: '200': description: '`AutomationResource`' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AutomationResource' required: - data headers: X-RateLimit-Limit: description: >- Solicitudes por minuto permitidas para este token, o para la dirección si no tiene uno. schema: type: integer X-RateLimit-Remaining: description: Solicitudes que quedan este minuto. schema: type: integer '401': $ref: '#/components/responses/AuthenticationException' '403': $ref: '#/components/responses/AuthorizationException' '422': $ref: '#/components/responses/ValidationException' '429': description: Demasiadas solicitudes content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' headers: Retry-After: description: Segundos hasta que se restablece el límite. schema: type: integer X-RateLimit-Limit: description: Solicitudes por minuto permitidas. schema: type: integer X-RateLimit-Remaining: description: 'Solicitudes que quedan este minuto: ninguna.' schema: type: integer x-codeSamples: - lang: typescript label: TypeScript SDK source: >- import { StockShift } from "@stockshift/sdk"; const stockshift = new StockShift({ token: process.env.STOCKSHIFT_TOKEN! }); const result = await stockshift.put("/automation/automations/{automation}/draft", { path: { automation: "01J8QZ4M..." }, body: { definition: {} }, }); components: schemas: DraftRequest: type: object description: >- La definición de una automatización para guardar como borrador: un disparador, condiciones, pasos en orden y el código de un paso de código. Cada entrada de un paso se asigna a un valor fijo, un valor de los datos del disparador o la salida de un paso anterior. El script de un paso de código nunca se toma de un borrador; se genera al publicar la versión. properties: definition: type: object description: >- Lo que hace la automatización: un disparador, condiciones y pasos en orden. properties: trigger: type: object description: Lo que inicia una ejecución. properties: type: $ref: '#/components/schemas/TriggerType' description: >- Lo que inicia una ejecución: `manual` cuando la inicia un miembro, `event` o `schedule`. inputs: type: array description: >- Lo que se le pide al miembro que inicia una ejecución, hasta 20 entradas. Un disparador de evento o de programa da sus propios datos, sin importar lo que se envíe aquí. items: type: object properties: key: type: string description: >- La clave de la entrada: letras minúsculas, dígitos, guiones y guiones bajos, empezando con una letra y de hasta 40 caracteres, única en el disparador, como `order`. pattern: ^[a-z][a-z0-9_-]{0,39}$ label: type: string description: >- La etiqueta que ve el miembro para la entrada, de hasta 80 caracteres. maxLength: 80 type: type: string description: >- El tipo de la entrada: `text`, `integer`, `number`, `boolean` o `date`. enum: - text - integer - number - boolean - date required: type: boolean description: >- Si una ejecución no puede iniciar sin un valor para la entrada. required: - key - label - type - required maxItems: 20 uniqueItems: true event: type: - string - 'null' description: >- El evento que espera un disparador de evento, como `purchasing.order.approved`. Cualquier evento de webhook excepto los propios del módulo de Automatización. Es null en cualquier otro disparador. maxLength: 120 schedule: type: - object - 'null' description: >- Cuándo se ejecuta un disparador de programación. Es null para cualquier otro disparador. properties: frequency: $ref: '#/components/schemas/ScheduleFrequency' description: >- Cada cuánto se ejecuta la programación: `every_15_minutes`, `every_30_minutes`, `every_60_minutes`, `daily`, `weekdays`, `weekly` o `monthly`. time: type: - string - 'null' description: >- La hora del día como `HH:MM`, para todas las frecuencias excepto las de minutos. weekday: type: - integer - 'null' description: >- El día de la semana de una programación semanal, de 1 para el lunes a 7 para el domingo. minimum: 1 maximum: 7 day: type: - integer - 'null' description: >- El día del mes de una programación mensual, de 1 a 31. En un mes más corto, la programación se ejecuta el último día. minimum: 1 maximum: 31 timezone: type: - string - 'null' description: >- La zona horaria del programa, como `America/Chicago`. Cuando es null, se usa la zona horaria predeterminada de la organización. required: - frequency - time - weekday - day - timezone required: - type - inputs conditions: type: object description: >- Las reglas que deben cumplir los datos del disparador para que empiece una ejecución. properties: match: $ref: '#/components/schemas/ConditionMatch' description: >- Cómo se combinan las reglas: `all` cuando deben cumplirse todas, o `any` cuando basta una. rules: type: array description: >- Las reglas, hasta 20. Una lista vacía significa que una ejecución siempre empieza. items: type: object properties: field: type: string description: >- La clave de la entrada del disparador que comprueba la regla. maxLength: 40 operator: $ref: '#/components/schemas/ConditionOperator' description: >- Cómo compara la regla: `equals`, `not_equals`, `greater_than`, `less_than`, `contains` o `is_empty`. value: type: - string - 'null' description: >- El valor con el que se compara, de hasta 255 caracteres. maxLength: 255 required: - field - operator maxItems: 20 required: - match - rules steps: type: array description: >- Los pasos en el orden en que se ejecutan, hasta el valor de `max_steps` de la organización. items: type: object properties: key: type: string description: >- La clave del paso, en el mismo formato que la clave de una entrada: única en la automatización y se conserva cuando el paso se mueve, como `step-1`. pattern: ^[a-z][a-z0-9_-]{0,39}$ type: $ref: '#/components/schemas/StepType' description: >- El tipo de paso: `action`, `notify` para enviar un correo electrónico, `webhook` para enviar JSON por POST a una URL, `approval` para esperar a que un miembro apruebe o rechace la ejecución, `code` para ejecutar el código propio de la organización o `chat` para publicar en un canal de una herramienta de chat que la organización conectó. action: type: string description: >- La clave de un paso del catálogo de pasos, como `purchasing.send-purchase-order`, `automation.send-email` o `automation.call-webhook`. maxLength: 100 inputs: type: array description: >- De dónde toma su valor cada entrada del paso, hasta 50 asignaciones. items: type: object properties: input: type: string description: >- La entrada del paso que se debe llenar, como `order_id`, o `values.` para un valor que nombra un paso de correo electrónico o de webhook, como `values.order`. maxLength: 64 source: $ref: '#/components/schemas/MappingSource' description: >- De dónde viene el valor: `fixed`, `trigger` o `step`. value: type: - string - 'null' description: >- El valor fijo como texto, con una lista o un objeto escritos como JSON, de hasta 2000 caracteres. Los valores de encabezado guardados de un paso de webhook se leen como `saved:`; devuelve la referencia sin cambios para conservar el valor. maxLength: 2000 step: type: - string - 'null' description: La clave de un paso anterior, para el origen `step`. maxLength: 40 field: type: - string - 'null' description: >- La entrada del disparador o la salida del paso anterior que se lee, para las fuentes `trigger` y `step`. maxLength: 64 required: - input - source maxItems: 50 code: type: object description: >- El código de un paso de código. Solo un paso de código lo tiene. properties: language: $ref: '#/components/schemas/CodeLanguage' description: 'El lenguaje del código: `javascript` o `typescript`.' source: type: - string - 'null' description: >- El cuerpo de una función que recibe `input` y devuelve JSON, de hasta 64 KB. maxLength: 65536 required: - key - type - action - inputs maxItems: 50 uniqueItems: true required: - trigger - conditions - steps required: - definition title: DraftRequest AutomationResource: type: object properties: id: type: string description: El ID de la automatización, un UUID. name: type: string description: >- El nombre de la automatización, como lo ven los miembros en las listas. description: type: - string - 'null' description: >- Para qué sirve la automatización, con las palabras del miembro que la escribió. Es null cuando no hay ninguna. enabled: type: boolean description: >- Si la automatización está activada y ejecuta su última versión publicada. archived: type: boolean description: >- Si la automatización está archivada. Una automatización archivada está desactivada y no se puede cambiar hasta que se restaura. current_version: type: - integer - 'null' description: >- El número de la versión que ejecuta la automatización, o null antes de publicar la primera versión. has_draft: type: boolean description: >- Si la automatización tiene un borrador. Sin uno, `definition` es la versión que se ejecuta. draft_saved_at: type: - string - 'null' description: >- Cuándo se guardó el borrador por última vez, como marca de tiempo ISO 8601 en UTC. Es null cuando no hay borrador. definition: $ref: '#/components/schemas/DefinitionResource' description: >- El borrador, o la versión que ejecuta la automatización cuando no hay borrador, o una definición en blanco cuando no hay ninguno de los dos. problems: type: array description: >- Lo que impide publicar la definición. Está vacío cuando se puede publicar. items: $ref: '#/components/schemas/ProblemResource' versions: type: array description: Las versiones publicadas, de las más nuevas a las más antiguas. items: $ref: '#/components/schemas/VersionSummaryResource' can_manage: type: boolean description: >- Si el miembro detrás del token puede editar, archivar y restaurar la automatización. Siempre es false para una automatización archivada. can_publish: type: boolean description: >- Si el miembro detrás del token puede publicar el borrador de la automatización o una versión anterior. Siempre es false para una automatización archivada. attention: type: - string - 'null' description: >- Por qué un miembro que tiene todos los permisos que necesita la automatización debe volver a publicarla, ya que una ejecución no puede actuar como su publicador. Es null cuando nada requiere atención. skipped_runs: type: integer description: >- Cuántas veces se disparó un disparador pero sus condiciones no se cumplieron, así que no empezó ninguna ejecución. can_start: type: boolean description: >- Si el miembro detrás del token puede iniciar, cancelar, reintentar y reproducir las ejecuciones de la automatización. Siempre es false para una automatización archivada. run_inputs: type: array description: Las entradas que pide la ejecución de la versión actual. items: {} secret_steps: type: array description: >- Las claves de los pasos de webhook que tienen un secreto de firma. Un paso de webhook sin uno no se puede publicar. items: type: string members: type: array description: >- Los miembros que puede nombrar un paso de correo electrónico, por ID. Vacío a menos que el miembro detrás del token pueda editar la automatización. items: type: object properties: id: type: integer description: >- El ID del miembro, que un paso de correo electrónico usa para nombrarlo. name: type: string description: El nombre del miembro, para mostrar en una lista. required: - id - name roles: type: array description: >- Los roles a los que puede enviar un paso de correo electrónico. Está vacío a menos que el miembro detrás del token pueda editar la automatización. items: type: string not_started: type: - string - 'null' description: >- Por qué el último evento o la última programación de la automatización no inició una ejecución, como una cadena de automatizaciones demasiado profunda. Se borra cuando se publica una versión. not_started_at: type: - string - 'null' description: >- Cuándo falló por última vez un evento o una programación al iniciar una ejecución, como marca de tiempo ISO 8601 en UTC. Es null cuando `not_started` es null. waiting_triggers: type: integer description: >- Cuántos eventos y programaciones esperan para iniciar ejecuciones, retenidos por el límite de ejecuciones por minuto. runs_per_minute: type: integer description: El máximo de ejecuciones que la automatización inicia en un minuto. next_run_at: type: - string - 'null' description: >- Cuándo toca la siguiente ejecución de la programación de la automatización, como marca de tiempo ISO 8601 en UTC. Es null cuando está desactivada o no tiene un disparador de programación. default_timezone: type: string description: >- La zona horaria en la que empieza un disparador de programa nuevo, como `America/Chicago`. template_key: type: - string - 'null' description: >- La clave de la plantilla inicial a partir de la cual se creó la automatización, o null. Su definición es una copia, así que las versiones posteriores de la plantilla nunca la cambian. template_version: type: - integer - 'null' description: >- La versión de la plantilla que copió, o null cuando no se creó a partir de una plantilla. required: - id - name - description - enabled - archived - current_version - has_draft - draft_saved_at - definition - problems - versions - can_manage - can_publish - attention - skipped_runs - can_start - run_inputs - secret_steps - members - roles - not_started - not_started_at - waiting_triggers - runs_per_minute - next_run_at - default_timezone - template_key - template_version title: AutomationResource description: >- Una automatización con su borrador, o la versión que ejecuta, los problemas que impiden publicar esa definición y sus versiones. ProblemDetails: type: object description: >- Un error, como detalles del problema RFC 9457. Decide según `code`, que es estable; `detail` está escrito para personas y puede cambiar. properties: type: type: string format: uri description: Enlaces a la documentación de este código. title: type: string description: El texto de estado HTTP. status: type: integer description: El código de estado HTTP. code: type: string description: Un nombre estable legible por máquina, como validation_failed. detail: type: string description: Qué salió mal, para las personas. errors: type: object description: >- Errores por campo. En validation_failed, y en un rechazo con un código propio como insufficient_stock o document_closed. additionalProperties: type: array items: type: string feature: type: string description: La función del plan que se necesita. Solo en plan_upgrade_required. reason: type: string description: >- Por qué un dispositivo debe descargar un feed de nuevo. Solo en resync_required. attempts_left: type: integer description: >- Cuántas firmas rechazadas quedan antes de que el miembro se bloquee en el dispositivo. Solo en signature_assertion_invalid. rule_ids: type: array description: >- Las reglas de testigo que cubren las existencias. Solo en verification_required. items: type: string witness: type: string description: >- Dónde firma el testigo: same_device, remote o either. Solo en verification_required. blind_recount: type: boolean description: >- Si el testigo vuelve a contar antes de ver la cantidad. Solo en verification_required. flags: type: array description: >- Las marcas que dejan abiertas las decisiones de una línea masiva, tal como las nombra la vista previa masiva. Solo en decision_required. items: type: object properties: flag: type: string description: El nombre de la marca, tal como lo da la vista previa masiva. facts: type: object description: >- Los hechos de la marca, como en la vista previa masiva; los demás son null. additionalProperties: anyOf: - type: string - type: integer - type: array items: type: string - type: 'null' choices: type: array description: >- Las decisiones que resolverían la marca, tal como las nombra la vista previa masiva. items: type: string required: - flag - facts - choices required: - type - title - status - code - detail title: ProblemDetails TriggerType: type: string description: > Lo que inicia una ejecución: alguien que la inicia a mano, un programa o un evento, como un ajuste de existencias. enum: - manual - event - schedule title: TriggerType ScheduleFrequency: type: string description: > Cada cuánto una programación inicia una ejecución: cada 15, 30 o 60 minutos, todos los días a una hora o en días hábiles a una hora. También puede iniciar una cada semana en un día o cada mes en una fecha. enum: - every_15_minutes - every_30_minutes - every_60_minutes - daily - weekdays - weekly - monthly title: ScheduleFrequency ConditionMatch: type: string description: > Si una ejecución inicia cuando se cumplen todas sus condiciones o cuando se cumple cualquiera. enum: - all - any title: ConditionMatch ConditionOperator: type: string description: > Cómo compara una condición un valor de los datos del disparador. Las condiciones se revisan cuando empieza una ejecución. enum: - equals - not_equals - greater_than - less_than - contains - is_empty title: ConditionOperator StepType: type: string description: > Lo que hace un paso. Un paso de acción hace una de las cosas que puede hacer la app, como ajustar existencias. Un paso de notificación envía un correo electrónico y un paso de webhook publica JSON en una URL. Un paso de aprobación espera a que alguien apruebe o rechace la ejecución. Un paso de código ejecuta el propio código de la organización en un entorno aislado. Un paso de chat publica en un canal de una herramienta de chat que la organización conectó, como Slack. enum: - action - notify - webhook - approval - code - chat title: StepType MappingSource: type: string description: > De dónde viene la entrada de un paso: un valor escrito a mano, un valor de los datos del disparador o un valor que dio un paso anterior. enum: - fixed - trigger - step title: MappingSource CodeLanguage: type: string description: > El lenguaje en que está escrito un paso de código. A TypeScript se le quitan los tipos al publicar la versión; ambos se ejecutan como JavaScript. enum: - javascript - typescript title: CodeLanguage DefinitionResource: type: object properties: trigger: type: object description: >- Lo que inicia una ejecución: su tipo, las entradas que pide, y el evento o el programa que espera. properties: type: type: string enum: - manual - event - schedule description: >- Lo que inicia una ejecución: `manual` cuando la inicia un miembro, `event` o `schedule`. inputs: type: array items: {} description: >- Lo que se le pide a un miembro que inicia una ejecución a mano, cada uno con su `key`, `label`, `type` y si es `required`. event: type: - string - 'null' description: >- El evento que espera un disparador de evento, como `purchasing.order.approved`. Es null en cualquier otro disparador. schedule: type: - object - 'null' properties: frequency: type: string enum: - every_15_minutes - every_30_minutes - every_60_minutes - daily - weekdays - weekly - monthly description: >- Cada cuánto se ejecuta la programación: `every_15_minutes`, `every_30_minutes`, `every_60_minutes`, `daily`, `weekdays`, `weekly` o `monthly`. time: type: - string - 'null' description: >- La hora del día como `HH:MM`. Es null para las frecuencias contadas en minutos. weekday: type: - integer - 'null' description: >- El día de la semana de una programación semanal, de 1 para el lunes a 7 para el domingo. Es null en cualquier otra frecuencia. day: type: - integer - 'null' description: >- El día del mes de una programación mensual, de 1 a 31. En un mes más corto, la programación se ejecuta el último día. Es null en cualquier otra frecuencia. timezone: type: string description: >- La zona horaria en la que se ejecuta el programa, como `America/Chicago`. required: - frequency - time - weekday - day - timezone description: >- Cuándo se ejecuta un disparador de programación. Es null para cualquier otro disparador. required: - type - inputs - event - schedule conditions: type: object description: >- Las reglas que deben cumplir los datos del disparador para que empiece una ejecución, y si deben cumplirse `all` o `any` de ellas. properties: match: type: string enum: - all - any description: >- Cómo se combinan las reglas: `all` cuando deben cumplirse todas, o `any` cuando basta una. rules: type: array items: {} description: >- Las reglas, cada una con el `field` que revisa, un `operator` y un `value`. Una lista vacía significa que una ejecución siempre empieza. required: - match - rules steps: type: array description: >- Los pasos en el orden en que se ejecutan. Un paso de código tiene su `code`, con el script que ejecuta una vez publicado; `code` es null en todos los demás pasos. items: {} required: - trigger - conditions - steps title: DefinitionResource description: >- Lo que hace una automatización: un disparador, condiciones y pasos en orden. Un disparador de evento nombra su evento, y un disparador de programa indica cuándo se ejecuta y en qué zona horaria. ProblemResource: type: object properties: step: type: - integer - 'null' description: >- La posición del paso, contada desde 1, o null cuando el problema es de toda la automatización. input: type: - string - 'null' description: >- La entrada del paso con la que tiene que ver el problema, o null cuando tiene que ver con todo el paso. message: type: string description: >- Lo que está mal, en palabras sencillas, para mostrárselo al miembro que edita la automatización. required: - step - input - message title: ProblemResource description: Un problema que impide publicar un borrador. VersionSummaryResource: type: object properties: number: type: integer description: El número de la versión. Las versiones se numeran desde 1. current: type: boolean description: Si la automatización ejecuta esta versión. copied_from: type: - integer - 'null' description: >- El número de la versión a partir de la cual se volvió a publicar esta, o null cuando se publicó desde un borrador. published_by: type: - string - 'null' description: >- El nombre del miembro que publicó la versión, o null cuando se borraron los datos personales de ese miembro. published_at: type: string description: Cuándo se publicó la versión, como marca de tiempo ISO 8601 en UTC. required: - number - current - copied_from - published_by - published_at title: VersionSummaryResource description: Una versión publicada tal como la enumera la automatización. responses: AuthenticationException: description: No autenticado content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' AuthorizationException: description: Prohibido content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' ValidationException: description: Error de validación content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' securitySchemes: apiKey: type: http description: >- Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como `Authorization: Bearer `. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como `inventory:read` o `sales:write`. Una clave con `*` tiene todos los alcances. scheme: bearer oauth2: type: oauth2 description: >- Para apps que otras personas conectan a su cuenta de StockShift. Usa el flujo de código de autorización OAuth 2.1 con PKCE (S256); no hay secreto de cliente. Descubre los endpoints en `/.well-known/oauth-authorization-server` (RFC 8414) y registra tu app en `POST /oauth/register` (RFC 7591). El miembro elige la organización y aprueba los alcances en la página de consentimiento, y el token nunca puede hacer más de lo que podría hacer el miembro. Envíalo como `Authorization: Bearer `, igual que una clave de API. Los tokens de acceso duran una hora; cada actualización devuelve un token de actualización nuevo, así que guárdalo. flows: authorizationCode: authorizationUrl: https://app.stockshift.io/oauth/authorize tokenUrl: https://app.stockshift.io/oauth/token refreshUrl: https://app.stockshift.io/oauth/token scopes: access:read: Access read audit:read: Audit read address:read: Address read address:write: Address write billing:read: Billing read catalog:read: Catalog read catalog:write: Catalog write dashboard:read: Dashboard read dashboard:write: Dashboard write developer:read: Developer read developer:write: Developer write devices:read: Devices read devices:write: Devices write documents:read: Documents read documents:write: Documents write notifications:read: Notifications read notifications:write: Notifications write inventory:read: Inventory read inventory:write: Inventory write purchasing:read: Purchasing read purchasing:write: Purchasing write quality:read: Quality read quality:write: Quality write sales:read: Sales read sales:write: Sales write engineering:read: Engineering read engineering:write: Engineering write manufacturing:read: Manufacturing read manufacturing:write: Manufacturing write automation:read: Automation read automation:write: Automation write insights:read: Insights read insights:write: Insights write integrations:read: Integrations read integrations:write: Integrations write labels:read: Labels read labels:write: Labels write library:read: Library read organization:read: Organization read organization:write: Organization write planning:read: Planning read planning:write: Planning write sync:read: Sync read sync:write: Sync write ```` ## Related topics - [Publica el borrador de una automatización](https://docs.stockshift.io/es/api-reference/automatizaciones/publica-el-borrador-de-una-automatización.md) - [Crea el borrador de una orden de fabricación](https://docs.stockshift.io/es/api-reference/órdenes-de-fabricación/crea-el-borrador-de-una-orden-de-fabricación.md) - [Crea una automatización](https://docs.stockshift.io/es/api-reference/automatizaciones/crea-una-automatización.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.