Esquemas
CountryCode
^[A-Z]{2}$Código do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
PositiveDecimal
^(?!0+(?:\.0+)?$)(?:…Decimal positivo como string, com ponto, sem vírgula nem notação científica. Até 15 algarismos inteiros e 6 decimais. A resposta elimina os zeros decimais finais.
WeightKilograms
Tabela de alternativas
| Alternativa | Critérios de seleção |
|---|---|
| type = string | |
| type = number |
^(?!0+(?:\.0+)?$)(?:…Decimal positivo como string, com ponto, sem vírgula nem notação científica. Até 15 algarismos inteiros e 6 decimais. A resposta elimina os zeros decimais finais.
Address
streetRua e número da morada.
postal_codeCódigo postal como texto para preservar zeros iniciais.
cityLocalidade da morada.
country^[A-Z]{2}$ · obrigatórioCódigo do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
Shipper
nameNome ou denominação social.
tax_country^[A-Z]{2}$ · obrigatórioCódigo do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
tax_idIdentificador fiscal normalizado para maiúsculas sem espaços nem hífenes; o comprimento é verificado após normalização. Em Espanha validam-se formato e caráter de controlo de DNI, NIE e NIF de entidades (CIF). Os NIF especiais K, L e M são verificados apenas pelo formato: prefixo, sete carateres alfanuméricos e letra final. Para outros países exige-se formato alfanumérico sem verificação do controlo fiscal. A validação não comprova existência nem registo fiscal.
Carrier
nameNome ou denominação social.
tax_country^[A-Z]{2}$ · obrigatórioCódigo do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
tax_idIdentificador fiscal normalizado para maiúsculas sem espaços nem hífenes; o comprimento é verificado após normalização. Em Espanha validam-se formato e caráter de controlo de DNI, NIE e NIF de entidades (CIF). Os NIF especiais K, L e M são verificados apenas pelo formato: prefixo, sete carateres alfanuméricos e letra final. Para outros países exige-se formato alfanumérico sem verificação do controlo fiscal. A validação não comprova existência nem registo fiscal.
Morada opcional do transportador. Se fornecida, exige todos os campos de Address; o artigo 6 não a exige como dado mínimo.
TransportLocation
placeLocal real de carga ou descarga, identificável pelo nome da instalação ou morada. Com city e country deve permitir identificá-lo claramente; street e postal_code são opcionais. A identidade da empresa destinatária não é um dado mínimo obrigatório.
cityLocalidade.
countryO âmbito inicial abrange transportes internos em Espanha; não substitui o CMR internacional.
streetRua e número opcionais do local de carga ou descarga para precisar a localização.
postal_codeCódigo postal opcional do local de carga ou descarga, como texto para preservar zeros iniciais.
AlternativeMeasure
value^(?!0+(?:\.0+)?$)(?:… · obrigatórioDecimal positivo como string, com ponto, sem vírgula nem notação científica. Até 15 algarismos inteiros e 6 decimais. A resposta elimina os zeros decimais finais.
unitUnidade explícita da grandeza, até 255 carateres.
Goods
descriptionDescrição da natureza da mercadoria.
Peso positivo em kg, como número JSON ou texto decimal. Até 15 algarismos inteiros e 6 decimais. A resposta normaliza para texto e conserva a precisão; o PDF apresenta até 3 decimais, com vírgula decimal e pontos para os milhares. Utilize texto decimal para evitar perda de precisão em valores elevados.
Outra grandeza quando for difícil determinar o peso. Envie esta grandeza ou o peso, nunca ambos.
Tabela de alternativas
| Alternativa | Critérios de seleção |
|---|---|
| type = object · Campos obrigatórios: weight_kg | |
| type = object · Campos obrigatórios: alternative_measure |
Peso positivo em kg, como número JSON ou texto decimal. Até 15 algarismos inteiros e 6 decimais. A resposta normaliza para texto e conserva a precisão; o PDF apresenta até 3 decimais, com vírgula decimal e pontos para os milhares. Utilize texto decimal para evitar perda de precisão em valores elevados.
descriptionDescrição da natureza da mercadoria.
Outra grandeza quando for difícil determinar o peso. Envie esta grandeza ou o peso, nunca ambos.
Vehicle
country^[A-Z]{2}$ · obrigatórioCódigo do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
registrationMatrícula normalizada para maiúsculas sem espaços nem hífenes. Em Espanha são admitidas a matrícula ordinária vigente, as provinciais anteriores e a série especial E. Para outros países, entre 3 e 20 carateres alfanuméricos.
trailer_country^[A-Z]{2}$Código do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
trailer_registrationMatrícula do reboque ou semirreboque, normalizada como a do trator. Em Espanha exige-se a série R. Para outros países, entre 3 e 20 carateres alfanuméricos.
Tabela de alternativas
| Alternativa | Critérios de seleção |
|---|---|
| type = object · Campos obrigatórios: trailer_country, trailer_registration | |
| type = object · Campos obrigatórios: country, registration |
trailer_country^[A-Z]{2}$ · obrigatórioCódigo do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
trailer_registrationMatrícula do reboque ou semirreboque, normalizada como a do trator. Em Espanha exige-se a série R. Para outros países, entre 3 e 20 carateres alfanuméricos.
country^[A-Z]{2}$Código do país com duas letras; normalizado para maiúsculas. O formato não verifica a pertença ao catálogo ISO 3166-1.
registrationMatrícula normalizada para maiúsculas sem espaços nem hífenes. Em Espanha são admitidas a matrícula ordinária vigente, as provinciais anteriores e a série especial E. Para outros países, entre 3 e 20 carateres alfanuméricos.
SpecialAuthorization
numberNúmero ou referência da autorização.
issuerOrganismo emissor, se indicado.
CreateDocumentRequest
transport_dateData real do transporte em formato YYYY-MM-DD; não é o instante de criação do PDF.
Carregador contratual; pode diferir do armazém de origem e do cliente da DeCA.
Transportador que efetua realmente o transporte, incluindo o subcontratado.
Natureza e peso da mercadoria, ou grandeza alternativa quando aplicável. Envie exatamente uma medida.
Veículo efetivo; se houver reboque ou semirreboque, preencha os dois campos em conjunto.
reference^[A-Za-z0-9-]+(?![\s…Referência própria opcional, única por organização e ambiente e impressa no PDF. Identifica novas tentativas e permite consultar por referência. Não é libertada ao eliminar o documento.
Autorização especial de circulação quando necessária. Omita ou envie null se não se aplicar.
observationsObservações cuja inclusão no documento seja pedida pelos intervenientes.
Objeto JSON opcional, conservado e devolvido sem alteração semântica. Não é impresso no PDF. Máximo de 16 KiB ao serializar e 8 níveis de profundidade.
DocumentResult
uuidUUID do documento emitido.
reference^[A-Za-z0-9-]+(?![\s… · obrigatórioReferência do cliente ou null.
created_atInstante original de criação, em UTC.
urlURL HTTPS completa de descarga por QR, incluindo o segredo. Não registe nem publique.
pdf_download_urlURL de descarga autenticada; requer Bearer da credencial proprietária no prazo de 24 horas.
rectifies_uuidUUID retificado ou null numa emissão inicial.
A mesma metadata do pedido; null se não foi fornecida.
document_localeIdioma do PDF escolhido na emissão segundo a organização. Conservado no resultado; alterar o idioma da organização não modifica documentos existentes. Não altera campos JSON nem mensagens de erro da API.
DocumentSummary
uuidreference^[A-Za-z0-9-]+(?![\s… · obrigatóriocreated_attransport_daterectifies_uuidDocumentList
ErrorResponse
Todos os erros independentes detetados; sem dados do pedido, segredos nem rastos.
RectifyDocumentRequest
transport_dateData real do transporte em formato YYYY-MM-DD; não é o instante de criação do PDF.
Carregador contratual; pode diferir do armazém de origem e do cliente da DeCA.
Transportador que efetua realmente o transporte, incluindo o subcontratado.
Natureza e peso da mercadoria, ou grandeza alternativa quando aplicável. Envie exatamente uma medida.
Veículo efetivo; se houver reboque ou semirreboque, preencha os dois campos em conjunto.
reference^[A-Za-z0-9-]+(?![\s…Nova referência do documento retificativo, opcional e única por organização e ambiente. Não reutilize a referência do documento identificado na URL.
Autorização especial de circulação quando necessária. Omita ou envie null se não se aplicar.
observationsObservações cuja inclusão no documento seja pedida pelos intervenientes.
Objeto JSON opcional, conservado e devolvido sem alteração semântica. Não é impresso no PDF. Máximo de 16 KiB ao serializar e 8 níveis de profundidade.
DeleteDocumentRequest
reasonMotivo do erro detetado ao gerar o documento.
confirm_not_deliveredDeve ser true para eliminar: confirma que não foi entregue ao transportador nem ao condutor. false devolve 409 DOCUMENT_ALREADY_DELIVERED.
confirm_not_usedDeve ser true para eliminar: confirma que não foi utilizado num transporte. false devolve 409 DOCUMENT_ALREADY_USED.
DocumentStatus
statusEstado do documento. Não inclui informação do transporte, PDF, QR, metadata nem datas.
DemoTokenResult
token^sk_demo_[0-9a-f]{64… · obrigatórioPodes pedir um token sk_demo_ sem uma conta nem o registo de uma organização. Dura 24 horas a partir da emissão e funciona apenas a partir do IP público que o pediu. Mudar de rede ou de IP exige outro token.
expires_atData de expiração do token em UTC. Todos os seus documentos e ligações expiram neste instante.
document_localeIdioma dos PDF deste token. Espanhol por predefinição.
DemoDocumentResult
uuidUUID do documento emitido.
reference^[A-Za-z0-9-]+(?![\s… · obrigatórioReferência do cliente ou null.
created_atInstante original de criação, em UTC.
urlURL HTTPS completa de descarga por QR, incluindo o segredo. Não registe nem publique.
pdf_download_urlPodes pedir um token sk_demo_ sem uma conta nem o registo de uma organização. Dura 24 horas a partir da emissão e funciona apenas a partir do IP público que o pediu. Mudar de rede ou de IP exige outro token.
rectifies_uuidUUID retificado ou null numa emissão inicial.
A mesma metadata do pedido; null se não foi fornecida.
document_localeIdioma dos PDF deste token. Espanhol por predefinição.
demoApenas na demo; sempre true. Não aparece nos resultados de desenvolvimento ou produção.
expires_atData de expiração do token em UTC. Todos os seus documentos e ligações expiram neste instante.
qr_urlApenas na demo; alias de url.
pdf_urlApenas na demo; alias de pdf_download_url. Exige o token demo e o seu IP.