Esquemas
CountryCode
^[A-Z]{2}$Código de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
PositiveDecimal
^(?!0+(?:\.0+)?$)(?:…Decimal positivo como string, con punto, sen coma nin notación científica. Ata 15 cifras enteiras e 6 decimais. A resposta elimina os ceros decimais finais.
WeightKilograms
Táboa de alternativas
| Alternativa | Criterios de selección |
|---|---|
| type = string | |
| type = number |
^(?!0+(?:\.0+)?$)(?:…Decimal positivo como string, con punto, sen coma nin notación científica. Ata 15 cifras enteiras e 6 decimais. A resposta elimina os ceros decimais finais.
Address
streetVía e número do domicilio.
postal_codeCódigo postal como texto para conservar os ceros iniciais.
cityLocalidade do domicilio.
country^[A-Z]{2}$ · obrigatorioCódigo de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
Shipper
nameNome ou razón social.
tax_country^[A-Z]{2}$ · obrigatorioCódigo de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
tax_idIdentificador fiscal normalizado a maiúsculas sen espazos nin guións; a lonxitude compróbase tras normalizar. En España valídanse formato e carácter de control de DNI, NIE e NIF de entidades (CIF). Os NIF especiais K, L e M compróbanse só polo formato: prefixo, sete caracteres alfanuméricos e letra final. Para outros países esíxese formato alfanumérico sen verificar o control fiscal. Esta validación non acredita existencia nin alta censal.
Carrier
nameNome ou razón social.
tax_country^[A-Z]{2}$ · obrigatorioCódigo de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
tax_idIdentificador fiscal normalizado a maiúsculas sen espazos nin guións; a lonxitude compróbase tras normalizar. En España valídanse formato e carácter de control de DNI, NIE e NIF de entidades (CIF). Os NIF especiais K, L e M compróbanse só polo formato: prefixo, sete caracteres alfanuméricos e letra final. Para outros países esíxese formato alfanumérico sen verificar o control fiscal. Esta validación non acredita existencia nin alta censal.
Domicilio opcional do transportista. Se se envía, debe incluír todos os campos de Address; o artigo 6 non o esixe como dato mínimo.
TransportLocation
placeLugar real de carga ou descarga, identificable polo nome da instalación ou o enderezo. Con city e country debe permitir identificalo claramente; street e postal_code son opcionais. A identidade da empresa destinataria non é un dato mínimo obrigatorio.
cityLocalidade.
countryO alcance inicial abrangue transportes interiores en España; non substitúe o CMR internacional.
streetVía e número opcionais do lugar de carga ou descarga para precisar a súa localización.
postal_codeCódigo postal opcional do lugar de carga ou descarga, como texto para conservar ceros iniciais.
AlternativeMeasure
value^(?!0+(?:\.0+)?$)(?:… · obrigatorioDecimal positivo como string, con punto, sen coma nin notación científica. Ata 15 cifras enteiras e 6 decimais. A resposta elimina os ceros decimais finais.
unitUnidade explícita da magnitude, ata 255 caracteres.
Goods
descriptionDescrición da natureza da mercadoría.
Peso positivo en kg, como número JSON ou texto decimal. Ata 15 cifras enteiras e 6 decimais. A resposta normaliza a texto e conserva a precisión; o PDF mostra ata 3 decimais, con coma decimal e puntos de milleiros. Usa texto decimal para evitar perda de precisión en valores grandes.
Outra magnitude cando sexa difícil determinar o peso. Envía esta magnitude ou o peso, nunca ambas.
Táboa de alternativas
| Alternativa | Criterios de selección |
|---|---|
| type = object · Campos obrigatorios: weight_kg | |
| type = object · Campos obrigatorios: alternative_measure |
Peso positivo en kg, como número JSON ou texto decimal. Ata 15 cifras enteiras e 6 decimais. A resposta normaliza a texto e conserva a precisión; o PDF mostra ata 3 decimais, con coma decimal e puntos de milleiros. Usa texto decimal para evitar perda de precisión en valores grandes.
descriptionDescrición da natureza da mercadoría.
Outra magnitude cando sexa difícil determinar o peso. Envía esta magnitude ou o peso, nunca ambas.
Vehicle
country^[A-Z]{2}$ · obrigatorioCódigo de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
registrationMatrícula normalizada a maiúsculas e sen espazos nin guións. Para España admítense a matrícula ordinaria vixente, as provinciais anteriores e a serie especial E. Para outros países, entre 3 e 20 caracteres alfanuméricos.
trailer_country^[A-Z]{2}$Código de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
trailer_registrationMatrícula do remolque ou semirremolque, normalizada como a do tractor. Para España esíxese a serie R. Para outros países, entre 3 e 20 caracteres alfanuméricos.
Táboa de alternativas
| Alternativa | Criterios de selección |
|---|---|
| type = object · Campos obrigatorios: trailer_country, trailer_registration | |
| type = object · Campos obrigatorios: country, registration |
trailer_country^[A-Z]{2}$ · obrigatorioCódigo de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
trailer_registrationMatrícula do remolque ou semirremolque, normalizada como a do tractor. Para España esíxese a serie R. Para outros países, entre 3 e 20 caracteres alfanuméricos.
country^[A-Z]{2}$Código de país de dúas letras; normalízase a maiúsculas. O formato non comproba a pertenza ao catálogo ISO 3166-1.
registrationMatrícula normalizada a maiúsculas e sen espazos nin guións. Para España admítense a matrícula ordinaria vixente, as provinciais anteriores e a serie especial E. Para outros países, entre 3 e 20 caracteres alfanuméricos.
SpecialAuthorization
numberNúmero ou referencia da autorización.
issuerOrganismo emisor, se se informa.
CreateDocumentRequest
transport_dateData real do transporte en formato YYYY-MM-DD; non é o instante de creación do PDF.
Cargador contractual; pode ser diferente do almacén de orixe e do cliente de DeCA.
Transportista que realiza efectivamente o transporte, incluído o subcontratado.
Natureza e peso da mercadoría, ou magnitude alternativa cando corresponda. Envía exactamente unha medida.
Vehículo efectivo; se hai remolque ou semirremolque, informa os dous campos xuntos.
reference^[A-Za-z0-9-]+(?![\s…Referencia propia opcional, única por organización e contorno e impresa no PDF. Identifica os reintentos e permite consultar por referencia. Non se libera ao eliminar o documento.
Autorización especial de circulación cando sexa necesaria. Omítea ou envía null se non procede.
observationsObservacións que os intervenientes soliciten facer constar no documento.
Obxecto JSON opcional, conservado e devolto sen modificación semántica. Non se imprime no PDF. Máximo 16 KiB ao serializalo e 8 niveis de profundidade.
DocumentResult
uuidUUID do documento emitido.
reference^[A-Za-z0-9-]+(?![\s… · obrigatorioReferencia do cliente ou null.
created_atInstante orixinal de creación, en UTC.
urlURL HTTPS completa de descarga por QR, incluído o seu segredo. Non a rexistres nin publiques.
pdf_download_urlURL de descarga autenticada; require o Bearer da credencial propietaria dentro de 24 horas.
rectifies_uuidUUID rectificado ou null nunha emisión inicial.
A mesma metadata da petición; null se non se proporcionou.
document_localeIdioma do PDF escollido ao emitilo segundo a organización. Consérvase no resultado; cambiar o idioma da organización non modifica documentos existentes. Non cambia campos JSON nin mensaxes de erro da API.
DocumentSummary
uuidreference^[A-Za-z0-9-]+(?![\s… · obrigatoriocreated_attransport_daterectifies_uuidDocumentList
ErrorResponse
Todos os erros independentes detectados; sen datos de petición, segredos nin trazas.
RectifyDocumentRequest
transport_dateData real do transporte en formato YYYY-MM-DD; non é o instante de creación do PDF.
Cargador contractual; pode ser diferente do almacén de orixe e do cliente de DeCA.
Transportista que realiza efectivamente o transporte, incluído o subcontratado.
Natureza e peso da mercadoría, ou magnitude alternativa cando corresponda. Envía exactamente unha medida.
Vehículo efectivo; se hai remolque ou semirremolque, informa os dous campos xuntos.
reference^[A-Za-z0-9-]+(?![\s…Referencia nova do documento rectificativo, opcional e única por organización e contorno. Non reutilices a referencia do documento identificado na URL.
Autorización especial de circulación cando sexa necesaria. Omítea ou envía null se non procede.
observationsObservacións que os intervenientes soliciten facer constar no documento.
Obxecto JSON opcional, conservado e devolto sen modificación semántica. Non se imprime no PDF. Máximo 16 KiB ao serializalo e 8 niveis de profundidade.
DeleteDocumentRequest
reasonMotivo do erro detectado ao xerar o documento.
confirm_not_deliveredDebe ser true para eliminar: confirma que non se entregou ao transportista nin ao condutor. false devolve 409 DOCUMENT_ALREADY_DELIVERED.
confirm_not_usedDebe ser true para eliminar: confirma que non se utilizou nun transporte. false devolve 409 DOCUMENT_ALREADY_USED.
DocumentStatus
statusEstado do documento. Non inclúe información do transporte, PDF, QR, metadata nin datas.
DemoTokenResult
token^sk_demo_[0-9a-f]{64… · obrigatorioPodes solicitar un token sk_demo_ sen conta nin alta dunha organización. Dura 24 horas desde a súa emisión e só funciona desde a IP pública que o solicitou. Cambiar de rede ou de IP require solicitar outro token.
expires_atCaducidade do token en UTC. Todos os seus documentos e ligazóns vencen neste instante.
document_localeIdioma dos PDF deste token. Castelán por defecto.
DemoDocumentResult
uuidUUID do documento emitido.
reference^[A-Za-z0-9-]+(?![\s… · obrigatorioReferencia do cliente ou null.
created_atInstante orixinal de creación, en UTC.
urlURL HTTPS completa de descarga por QR, incluído o seu segredo. Non a rexistres nin publiques.
pdf_download_urlPodes solicitar un token sk_demo_ sen conta nin alta dunha organización. Dura 24 horas desde a súa emisión e só funciona desde a IP pública que o solicitou. Cambiar de rede ou de IP require solicitar outro token.
rectifies_uuidUUID rectificado ou null nunha emisión inicial.
A mesma metadata da petición; null se non se proporcionou.
document_localeIdioma dos PDF deste token. Castelán por defecto.
demoSó na demo; sempre true. Non aparece en resultados de desenvolvemento ou produción.
expires_atCaducidade do token en UTC. Todos os seus documentos e ligazóns vencen neste instante.
qr_urlSó na demo; alias de url.
pdf_urlSó na demo; alias de pdf_download_url. Require o token demo e a súa IP.