Actualitzar un document de control en esborrany

Actualitza parcialment un document de control en draft: un camp absent es conserva, un null explícit l'esborra i shipments substitueix la llista completa.

Qualsevol altre estat retorna 422 transport_document_cannot_be_edited; un document emès es canvia amb POST /v1/transport_documents/{id}/modify.
shipments[].id només identifica un enviament d'aquest document (qualsevol altre retorna 422 parameter_invalid_value a shipments.N.id); una línia de mercaderia amb un pes impossible retorna 422 invalid_gross_weight.
Una escriptura simultània que xoca en un identificador retorna 409 resource_conflict, reintentable: no s'ha desat res.

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que fa segurs els reintents: la primera resposta es cacheja i es reprodueix a les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'Idempotency.

Longitud1 <= length <= 255

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

company_role?string

Valor a"shipper" | "carrier"

special_authorization?|

Longitudlength <= 100

transport_date?|

Formatdate

observations?|

Longitudlength <= 5000

vehicle?

shipments?array<>|

Elementsitems <= 50

shipper?

carrier?

Cos de la resposta

`application/json`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/transport_documents/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01", {  method: "PUT",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-transport_documents-update"} },  body: JSON.stringify({  "vehicle": {    "trailer_plate": "R5678FGH"  },  "special_authorization": "AEC-2026/0142"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f9a01",
    "object": "transport_document",
    "number": null,
    "status": "draft",
    "company_role": "shipper",
    "public_url": null,
    "current_version": null,
    "shipper": {
      "name": "Distribuciones Olivar SL",
      "tax_id": "A58818501",
      "tax_id_country": "ES",
      "address": {
        "line": "Calle Industria 5",
        "postal_code": "28901",
        "city": "Getafe",
        "province": "Madrid",
        "country": "ES",
        "name": null
      },
      "contact_id": null
    },
    "carrier": {
      "name": "Transportes Pérez SL",
      "tax_id": "B12345674",
      "tax_id_country": "ES",
      "address": null,
      "contact_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01"
    },
    "vehicle": {
      "tractor_plate": "1234BCD",
      "tractor_plate_country": "ES",
      "trailer_plate": "R1234BCD",
      "trailer_plate_country": "ES"
    },
    "special_authorization": null,
    "transport_date": "2026-10-06",
    "observations": "Entrega en horario de mañana.",
    "shipments": [
      {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f9a11",
        "origin": {
          "line": "Calle Industria 5",
          "postal_code": "28901",
          "city": "Getafe",
          "province": "Madrid",
          "country": "ES",
          "name": "Nave Getafe"
        },
        "destination": {
          "line": "Avenida de Europa 20",
          "postal_code": "45005",
          "city": "Toledo",
          "province": "Toledo",
          "country": "ES",
          "name": "Ultramarinos Toledo"
        },
        "transport_date": "2026-10-06",
        "goods": [
          {
            "description": "Aceituna gordal aliñada",
            "additional_description": "Mantener refrigerado.",
            "quantity": "10.0000",
            "unit": "cajas",
            "gross_weight_kg": "12.5000"
          }
        ],
        "declared_measure": {
          "type": "weight",
          "weight_kg": "125.0000",
          "value": null,
          "unit": null
        },
        "delivery_note_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a06",
        "source_changed": false,
        "source_changes": [],
        "source_missing": false,
        "observations": "Albarán ALB-2026-00231"
      },
      {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f9a12",
        "origin": {
          "line": "Calle Industria 5",
          "postal_code": "28901",
          "city": "Getafe",
          "province": "Madrid",
          "country": "ES",
          "name": "Nave Getafe"
        },
        "destination": {
          "line": "Plaza Mayor 3",
          "postal_code": "45600",
          "city": "Talavera de la Reina",
          "province": "Toledo",
          "country": "ES",
          "name": null
        },
        "transport_date": null,
        "goods": [
          {
            "description": "Palés de aceite de oliva",
            "additional_description": null,
            "quantity": "2.0000",
            "unit": "palés",
            "gross_weight_kg": null
          }
        ],
        "declared_measure": {
          "type": "other",
          "weight_kg": null,
          "value": "2.0000",
          "unit": "palés"
        },
        "delivery_note_id": null,
        "source_changed": false,
        "source_changes": [],
        "source_missing": false,
        "observations": null
      }
    ],
    "versions": [],
    "issued_at": null,
    "last_modified_at": null,
    "closed_at": null,
    "close_mode": null,
    "reopen_deadline": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "superseded_at": null,
    "superseding_reference": null,
    "retention_until": null,
    "files_purged_at": null,
    "created_at": "2026-10-05T15:58:12+00:00",
    "updated_at": "2026-10-06T07:10:00+00:00"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_7c61a5b01e9f4be3b4d0924e83"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'transport_documents:write'. Tu API key solo tiene los scopes: transport_documents:read.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_cd1d40b38f47b7b7f3b9cdc347"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "transport_document_not_found",
    "message": "DeCA no encontrado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#transport_document_not_found",
    "request_id": "req_a0e007439367b619c0e16983b2"
  }
}

PUT /v1/transport_documents/{transport_document} · 409 idempotency_key_reused

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_d319fbcb47cc820d57f0edb8b1"
  }
}

PUT /v1/transport_documents/{transport_document} · 409 resource_conflict

{
  "error": {
    "type": "conflict_error",
    "code": "resource_conflict",
    "message": "Se ha detectado otra escritura concurrente sobre los mismos datos. Vuelve a intentarlo dentro de unos segundos: la operación es reintentable y no ha dejado nada a medias.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_conflict",
    "request_id": "req_ff1bb12d99a11dc03ea767c0a4"
  }
}

PUT /v1/transport_documents/{transport_document} · 422 transport_document_cannot_be_edited

{
  "error": {
    "type": "invalid_request_error",
    "code": "transport_document_cannot_be_edited",
    "message": "El DeCA DC-2026-042 no se puede editar: está en estado «Emitido». Solo se edita un borrador; un DeCA emitido se cambia con una modificación.",
    "doc_url": "https://docs.factuarea.com/guides/errors#transport_document_cannot_be_edited",
    "request_id": "req_cb3dcfe0b2093ab5a72c69eca6"
  }
}

PUT /v1/transport_documents/{transport_document} · 422 invalid_param_value

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "La fecha de transporte debe tener el formato AAAA-MM-DD.",
    "param": "transport_date",
    "errors": [
      {
        "param": "transport_date",
        "code": "parameter_invalid_value",
        "message": "La fecha de transporte debe tener el formato AAAA-MM-DD."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_239e7c78a6b00bfffdbf0e6767"
  }
}

PUT /v1/transport_documents/{transport_document} · 422 invalid_gross_weight

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_gross_weight",
    "message": "El peso de la línea 1 del envío 1 no es válido: 2000000 unidades de 5000000 kg dan un peso de línea que debe ser mayor que 0 kg y no superar 9999999999.9999 kg. Revisa la cantidad o el peso por unidad.",
    "param": "shipments.0.goods.0.gross_weight_kg",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_gross_weight",
    "request_id": "req_03b8f2cf58370e7067b94b388f"
  }
}

PUT /v1/transport_documents/{transport_document} · 422 parameter_invalid_value

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_value",
    "message": "Este identificador de envío no pertenece a este DeCA. Para añadir un envío nuevo, envíalo sin «id».",
    "param": "shipments.0.id",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_value",
    "request_id": "req_5212eaf8f7afa99f0002256b83"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_93b0ea7698bef427a6e620a217"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_f03904bd1b39d188ecee6e776d"
  }
}

Actualitzar un document de control en esborrany

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Actualitzar un document de control en esborrany

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

200application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`