Servicios

Crear un servicio

Registra una línea vendible que no sale del inventario: un técnico, un transporte, una jornada de trabajo.

POST
/api/v1/services

Ejemplos de petición

curl https://app.filmo.io/api/v1/services \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Técnico de iluminación",
  "serviceType": "crew",
  "description": "Jornada de técnico con carné de conducir.",
  "defaultQty": 1,
  "showInPlanner": true,
  "requirements": [
    {
      "requiredResourceType": "personnel",
      "qty": 1,
      "requiredTags": [
        "Eléctricos"
      ]
    }
  ]
}'
{
  "data": {
    "id": "service_9f3a2b",
    "name": "Example service",
    "serviceType": "Example service type",
    "description": "Example text.",
    "defaultQty": 1,
    "showInPlanner": true,
    "includeInPrice": true,
    "collectionName": "Example collection name",
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "requirements": [
      {
        "requiredResourceType": "personnel",
        "qty": 1,
        "requiredTags": [
          "Example required tags"
        ]
      }
    ],
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generado a partir del esquema

La tarifa NO se fija aquí — para eso está el patch, que tiene su propio bloque. Devuelve el servicio creado.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. services:write

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Cuerpo

application/json

Esquema del cuerpo: ServiceCreateBody

namestringObligatorio

Nombre del servicio tal como lo verá el cliente.

Límites: longitud mín. 2, longitud máx. 200

serviceTypestring

Tipo de servicio.

Opciones disponibles: crew, fleet, general

descriptionstring

Descripción del servicio.

Límites: longitud máx. 2000

collectionIdstring

Colección a la que pertenece.

Límites: longitud mín. 1

tagsstring[]

Etiquetas por nombre; una que no existe se crea.

Límites: máx. 50 elementos, cada uno: longitud máx. 100

defaultQtyinteger

Cantidad que se añade por defecto a un pedido.

Límites: mín. 1

showInPlannerboolean

Si aparece como servicio planificable.

requirementsobject[]

Recursos necesarios para prestarlo.

Límites: máx. 20 elementos

Mostrar atributos hijos
requirements.requiredResourceTypestringObligatorio

Lo necesario para prestarlo: personal o vehículo.

Opciones disponibles: personnel, vehicle

requirements.qtyintegerObligatorio

Cuántos hacen falta.

Límites: mín. 1

requirements.requiredTagsstring[]

Etiquetas que debe tener el recurso asignado. Ej.: "Carné C".

Límites: máx. 20 elementos, cada uno: longitud máx. 100

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ServiceDto

Sobre: ServiceResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Línea vendible que no procede del inventario: personal, transporte, jornadas de trabajo.

Mostrar atributos hijos
data.idstring

Identificador único del servicio.

data.namestring

Nombre del servicio tal como lo ve el cliente.

data.serviceTypestring

Tipo: crew (personal), fleet (vehículos) o general.

data.descriptionstring | null

Descripción; null si no tiene.

data.defaultQtyinteger

Cantidad que se añade por defecto a un pedido.

data.showInPlannerboolean

Si aparece como servicio planificable.

data.includeInPriceboolean

Si su importe cuenta para el total del documento.

data.collectionNamestring | null

Ruta de la colección a la que pertenece; null si no está en ninguna.

data.tagsobject[]

Etiquetas del servicio, con su identificador y nombre.

Mostrar atributos hijos
data.tags.idstring

Identificador único de la etiqueta.

data.tags.namestring

Nombre de la etiqueta.

data.requirementsobject[]

Recursos necesarios para prestarlo.

Mostrar atributos hijos
data.requirements.requiredResourceTypestring

Lo necesario para prestarlo: personal o vehículo.

Opciones disponibles: personnel, vehicle

data.requirements.qtyinteger

Cuántos hacen falta.

Límites: mín. 1

data.requirements.requiredTagsstring[]

Etiquetas que debe tener el recurso asignado. Ej.: "Carné C".

Límites: máx. 20 elementos, cada uno: longitud máx. 100

data.createdAtstring<date-time> | null

Fecha de creación en ISO 8601 UTC; null si no consta.

data.updatedAtstring<date-time> | null

Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

  • Operaciones

    Servicio

    Línea vendible que no procede del inventario: personal, transporte, jornadas de trabajo.

¿Te ha resultado útil esta página?