Factuarea APIDevelopers

Create a transport document

Create a transport document (DeCA) in draft.

  • company_role says whether your company acts as contractual shipper (shipper) or effective carrier (carrier); your party is filled with your company data and the other one from contact_id or from the fields you send.
  • Pass delivery_note_ids (1 to 50 of your delivery notes) to pre-fill one shipment per delivery note with its destination, date and goods (services excluded, frozen weights); a cancelled delivery note is rejected with 422 delivery_note_cancelled.
  • A shipment that omits origin gets your default loading place or, if you have none, your registered address (an explicit origin: null leaves it without origin).
  • The id is generated by the server; shipments[].id is optional and an identifier already in use returns 422 on shipments.N.id.
  • A goods line whose quantity × gross_weight_kg exceeds 9,999,999,999.9999 kg or rounds to 0 returns 422 invalid_gross_weight on shipments.N.goods.M.gross_weight_kg.
  • A draft admits incomplete data; the minimum data is only required to issue.
  • A concurrent write that collides on an identifier returns 409 resource_conflict: nothing was saved and the request can be retried.
  • Returns 201 with the resource and a Location header.
POST
/transport_documents

Authorization

AuthorizationBearer <token>

In: header

Headers

Idempotency-Key?string

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 409 idempotency_key_reused. See the Idempotency guide.

Length1 <= length <= 255
Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json