Esquemes
CountryCode
^[A-Z]{2}$Codi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
PositiveDecimal
^(?!0+(?:\.0+)?$)(?:…Decimal positiu com a string, amb punt, sense coma ni notació científica. Fins a 15 xifres enteres i 6 decimals. La resposta elimina els zeros decimals finals.
WeightKilograms
Taula d'alternatives
| Alternativa | Criteris de selecció |
|---|---|
| type = string | |
| type = number |
^(?!0+(?:\.0+)?$)(?:…Decimal positiu com a string, amb punt, sense coma ni notació científica. Fins a 15 xifres enteres i 6 decimals. La resposta elimina els zeros decimals finals.
Address
streetVia i número del domicili.
postal_codeCodi postal com a text per conservar els zeros inicials.
cityLocalitat del domicili.
country^[A-Z]{2}$ · obligatoriCodi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
Shipper
nameNom o raó social.
tax_country^[A-Z]{2}$ · obligatoriCodi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
tax_idIdentificador fiscal normalitzat a majúscules i sense espais ni guions; la longitud es comprova després de normalitzar. A Espanya es validen el format i el caràcter de control de DNI, NIE i NIF d'entitats (CIF). Els NIF especials K, L i M es comproven només pel format: prefix, set caràcters alfanumèrics i lletra final. Per a altres països s'exigeix format alfanumèric sense verificar-ne el control fiscal. Aquesta validació no acredita existència ni alta censal.
Carrier
nameNom o raó social.
tax_country^[A-Z]{2}$ · obligatoriCodi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
tax_idIdentificador fiscal normalitzat a majúscules i sense espais ni guions; la longitud es comprova després de normalitzar. A Espanya es validen el format i el caràcter de control de DNI, NIE i NIF d'entitats (CIF). Els NIF especials K, L i M es comproven només pel format: prefix, set caràcters alfanumèrics i lletra final. Per a altres països s'exigeix format alfanumèric sense verificar-ne el control fiscal. Aquesta validació no acredita existència ni alta censal.
Domicili opcional del transportista. Si s'envia, cal incloure tots els camps d'Address; l'article 6 no l'exigeix com a dada mínima.
TransportLocation
placeLloc real de càrrega o descàrrega, identificable pel nom de la instal·lació o l'adreça. Amb city i country ha de permetre identificar-lo clarament; street i postal_code són opcionals. La identificació de l'empresa destinatària no és una dada mínima obligatòria.
cityLocalitat.
countryL'abast inicial cobreix transports interiors a Espanya; no substitueix el CMR internacional.
streetVia i número opcionals del lloc de càrrega o descàrrega per precisar-ne la ubicació.
postal_codeCodi postal opcional del lloc de càrrega o descàrrega, com a text per conservar zeros inicials.
AlternativeMeasure
value^(?!0+(?:\.0+)?$)(?:… · obligatoriDecimal positiu com a string, amb punt, sense coma ni notació científica. Fins a 15 xifres enteres i 6 decimals. La resposta elimina els zeros decimals finals.
unitUnitat explícita de la magnitud, fins a 255 caràcters.
Goods
descriptionDescripció de la naturalesa de la mercaderia.
Pes positiu en kg, com a número JSON o text decimal. Fins a 15 xifres enteres i 6 decimals. La resposta normalitza a text i conserva la precisió; el PDF mostra fins a 3 decimals, amb coma decimal i punts de milers. Utilitza text decimal per a evitar pèrdua de precisió en valors grans.
Una altra magnitud quan sigui difícil determinar el pes. Envia aquesta magnitud o el pes, mai tots dos.
Taula d'alternatives
| Alternativa | Criteris de selecció |
|---|---|
| type = object · Camps obligatoris: weight_kg | |
| type = object · Camps obligatoris: alternative_measure |
Pes positiu en kg, com a número JSON o text decimal. Fins a 15 xifres enteres i 6 decimals. La resposta normalitza a text i conserva la precisió; el PDF mostra fins a 3 decimals, amb coma decimal i punts de milers. Utilitza text decimal per a evitar pèrdua de precisió en valors grans.
descriptionDescripció de la naturalesa de la mercaderia.
Una altra magnitud quan sigui difícil determinar el pes. Envia aquesta magnitud o el pes, mai tots dos.
Vehicle
country^[A-Z]{2}$ · obligatoriCodi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
registrationMatrícula normalitzada a majúscules i sense espais ni guions. A Espanya s'admet la matrícula ordinària vigent, les provincials anteriors i la sèrie especial E. Per a altres països, entre 3 i 20 caràcters alfanumèrics.
trailer_country^[A-Z]{2}$Codi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
trailer_registrationMatrícula del remolc o semiremolc, normalitzada com la del tractor. A Espanya s'exigeix la sèrie R. Per a altres països, entre 3 i 20 caràcters alfanumèrics.
Taula d'alternatives
| Alternativa | Criteris de selecció |
|---|---|
| type = object · Camps obligatoris: trailer_country, trailer_registration | |
| type = object · Camps obligatoris: country, registration |
trailer_country^[A-Z]{2}$ · obligatoriCodi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
trailer_registrationMatrícula del remolc o semiremolc, normalitzada com la del tractor. A Espanya s'exigeix la sèrie R. Per a altres països, entre 3 i 20 caràcters alfanumèrics.
country^[A-Z]{2}$Codi del país de dues lletres; es normalitza a majúscules. El format no comprova la pertinença al catàleg ISO 3166-1.
registrationMatrícula normalitzada a majúscules i sense espais ni guions. A Espanya s'admet la matrícula ordinària vigent, les provincials anteriors i la sèrie especial E. Per a altres països, entre 3 i 20 caràcters alfanumèrics.
SpecialAuthorization
numberNúmero o referència de l'autorització.
issuerOrganisme emissor, si s'informa.
CreateDocumentRequest
transport_dateData real del transport en format YYYY-MM-DD; no és l'instant de creació del PDF.
Carregador contractual; pot ser diferent del magatzem d'origen i del client de DeCA.
Transportista que fa efectivament el transport, inclòs el subcontractat.
Naturalesa i pes de la mercaderia, o magnitud alternativa quan pertoqui. Envia exactament una mesura.
Vehicle efectiu; si hi ha remolc o semiremolc, informa els seus dos camps junts.
reference^[A-Za-z0-9-]+(?![\s…Referència pròpia opcional, única per organització i entorn i impresa al PDF. Identifica els reintents i permet consultar per referència. No s'allibera en eliminar el document.
Autorització especial de circulació quan calgui. Omet-la o envia null si no correspon.
observationsObservacions que els intervinents sol·licitin fer constar al document.
Objecte JSON opcional, conservat i retornat sense modificació semàntica. No s'imprimeix al PDF. Màxim 16 KiB en serialitzar-lo i 8 nivells de profunditat.
DocumentResult
uuidUUID del document emès.
reference^[A-Za-z0-9-]+(?![\s… · obligatoriReferència del client o null.
created_atInstant original de creació, en UTC.
urlURL HTTPS completa de descàrrega per QR, amb el seu secret. No la registris ni publiquis.
pdf_download_urlURL de descàrrega autenticada; requereix el Bearer de la credencial propietària dins de 24 hores.
rectifies_uuidUUID rectificat o null en una emissió inicial.
La mateixa metadata de la petició; null si no s'ha proporcionat.
document_localeIdioma del PDF escollit en emetre'l segons l'organització. Es conserva al resultat; canviar l'idioma de l'organització no modifica documents existents. No canvia camps JSON ni missatges d'error de l'API.
DocumentSummary
uuidreference^[A-Za-z0-9-]+(?![\s… · obligatoricreated_attransport_daterectifies_uuidDocumentList
ErrorResponse
Tots els errors independents detectats; sense dades de la petició, secrets ni traces.
RectifyDocumentRequest
transport_dateData real del transport en format YYYY-MM-DD; no és l'instant de creació del PDF.
Carregador contractual; pot ser diferent del magatzem d'origen i del client de DeCA.
Transportista que fa efectivament el transport, inclòs el subcontractat.
Naturalesa i pes de la mercaderia, o magnitud alternativa quan pertoqui. Envia exactament una mesura.
Vehicle efectiu; si hi ha remolc o semiremolc, informa els seus dos camps junts.
reference^[A-Za-z0-9-]+(?![\s…Referència nova del document rectificatiu, opcional i única per organització i entorn. No reutilitzis la referència del document identificat a la URL.
Autorització especial de circulació quan calgui. Omet-la o envia null si no correspon.
observationsObservacions que els intervinents sol·licitin fer constar al document.
Objecte JSON opcional, conservat i retornat sense modificació semàntica. No s'imprimeix al PDF. Màxim 16 KiB en serialitzar-lo i 8 nivells de profunditat.
DeleteDocumentRequest
reasonMotiu de l'error detectat en generar el document.
confirm_not_deliveredHa de ser true per eliminar: confirma que no s'ha lliurat al transportista ni al conductor. false retorna 409 DOCUMENT_ALREADY_DELIVERED.
confirm_not_usedHa de ser true per eliminar: confirma que no s'ha utilitzat en un transport. false retorna 409 DOCUMENT_ALREADY_USED.
DocumentStatus
statusEstat del document. No inclou informació del transport, PDF, QR, metadata ni dates.
DemoTokenResult
token^sk_demo_[0-9a-f]{64… · obligatoriPots sol·licitar un token sk_demo_ sense compte ni alta d’una organització. Dura 24 hores des de l’emissió i només funciona des de la IP pública que l’ha sol·licitat. Si canvies de xarxa o d’IP, cal sol·licitar un altre token.
expires_atCaducitat del token en UTC. Tots els seus documents i enllaços vencen en aquest instant.
document_localeIdioma dels PDF d’aquest token. Castellà per defecte.
DemoDocumentResult
uuidUUID del document emès.
reference^[A-Za-z0-9-]+(?![\s… · obligatoriReferència del client o null.
created_atInstant original de creació, en UTC.
urlURL HTTPS completa de descàrrega per QR, amb el seu secret. No la registris ni publiquis.
pdf_download_urlPots sol·licitar un token sk_demo_ sense compte ni alta d’una organització. Dura 24 hores des de l’emissió i només funciona des de la IP pública que l’ha sol·licitat. Si canvies de xarxa o d’IP, cal sol·licitar un altre token.
rectifies_uuidUUID rectificat o null en una emissió inicial.
La mateixa metadata de la petició; null si no s'ha proporcionat.
document_localeIdioma dels PDF d’aquest token. Castellà per defecte.
demoNomés a la demo; sempre true. No apareix en resultats de desenvolupament o producció.
expires_atCaducitat del token en UTC. Tots els seus documents i enllaços vencen en aquest instant.
qr_urlNomés a la demo; àlies de url.
pdf_urlNomés a la demo; àlies de pdf_download_url. Requereix el token demo i la seva IP.