Schémas
CountryCode
^[A-Z]{2}$Code pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
PositiveDecimal
^(?!0+(?:\.0+)?$)(?:…Décimal positif sous forme de string, avec un point, sans virgule ni notation scientifique. Jusqu'à 15 chiffres entiers et 6 décimales. La réponse supprime les zéros décimaux finaux.
WeightKilograms
Table des alternatives
| Alternative | Critères de sélection |
|---|---|
| type = string | |
| type = number |
^(?!0+(?:\.0+)?$)(?:…Décimal positif sous forme de string, avec un point, sans virgule ni notation scientifique. Jusqu'à 15 chiffres entiers et 6 décimales. La réponse supprime les zéros décimaux finaux.
Address
streetVoie et numéro de l'adresse.
postal_codeCode postal sous forme de texte pour conserver les zéros initiaux.
cityLocalité de l'adresse.
country^[A-Z]{2}$ · obligatoireCode pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
Shipper
nameNom ou raison sociale.
tax_country^[A-Z]{2}$ · obligatoireCode pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
tax_idIdentifiant fiscal normalisé en majuscules sans espaces ni traits d'union ; la longueur est vérifiée après normalisation. En Espagne, le format et le caractère de contrôle des DNI, NIE et NIF d'entités (CIF) sont validés. Les NIF spéciaux K, L et M sont vérifiés uniquement par format : préfixe, sept caractères alphanumériques et lettre finale. Les autres pays exigent un format alphanumérique sans vérification du contrôle fiscal. La validation ne prouve ni l'existence ni l'immatriculation fiscale.
Carrier
nameNom ou raison sociale.
tax_country^[A-Z]{2}$ · obligatoireCode pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
tax_idIdentifiant fiscal normalisé en majuscules sans espaces ni traits d'union ; la longueur est vérifiée après normalisation. En Espagne, le format et le caractère de contrôle des DNI, NIE et NIF d'entités (CIF) sont validés. Les NIF spéciaux K, L et M sont vérifiés uniquement par format : préfixe, sept caractères alphanumériques et lettre finale. Les autres pays exigent un format alphanumérique sans vérification du contrôle fiscal. La validation ne prouve ni l'existence ni l'immatriculation fiscale.
Adresse facultative du transporteur. Si elle est fournie, tous les champs d'Address sont requis ; l'article 6 ne l'exige pas comme donnée minimale.
TransportLocation
placeLieu réel de chargement ou déchargement, identifiable par nom du site ou adresse. Avec city et country, il doit permettre de l'identifier clairement ; street et postal_code sont facultatifs. L'identité de l'entreprise destinataire n'est pas une donnée minimale obligatoire.
cityLocalité.
countryLe périmètre initial couvre les transports intérieurs en Espagne ; il ne remplace pas la CMR internationale.
streetVoie et numéro facultatifs du lieu de chargement ou déchargement pour préciser sa localisation.
postal_codeCode postal facultatif du lieu de chargement ou déchargement, sous forme de texte pour conserver les zéros initiaux.
AlternativeMeasure
value^(?!0+(?:\.0+)?$)(?:… · obligatoireDécimal positif sous forme de string, avec un point, sans virgule ni notation scientifique. Jusqu'à 15 chiffres entiers et 6 décimales. La réponse supprime les zéros décimaux finaux.
unitUnité explicite de la grandeur, jusqu'à 255 caractères.
Goods
descriptionDescription de la nature de la marchandise.
Poids positif en kg, sous forme de nombre JSON ou de chaîne décimale. Jusqu’à 15 chiffres entiers et 6 décimales. La réponse normalise en chaîne et conserve la précision ; le PDF affiche jusqu’à 3 décimales, avec une virgule décimale et des points pour les milliers. Utilisez une chaîne décimale pour éviter toute perte de précision avec les grandes valeurs.
Autre grandeur lorsque le poids est difficile à déterminer. Envoyez cette grandeur ou le poids, jamais les deux.
Table des alternatives
| Alternative | Critères de sélection |
|---|---|
| type = object · Champs obligatoires: weight_kg | |
| type = object · Champs obligatoires: alternative_measure |
Poids positif en kg, sous forme de nombre JSON ou de chaîne décimale. Jusqu’à 15 chiffres entiers et 6 décimales. La réponse normalise en chaîne et conserve la précision ; le PDF affiche jusqu’à 3 décimales, avec une virgule décimale et des points pour les milliers. Utilisez une chaîne décimale pour éviter toute perte de précision avec les grandes valeurs.
descriptionDescription de la nature de la marchandise.
Autre grandeur lorsque le poids est difficile à déterminer. Envoyez cette grandeur ou le poids, jamais les deux.
Vehicle
country^[A-Z]{2}$ · obligatoireCode pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
registrationImmatriculation normalisée en majuscules sans espaces ni traits d'union. En Espagne, les immatriculations ordinaires actuelles, anciennes provinciales et la série spéciale E sont acceptées. Pour les autres pays : de 3 à 20 caractères alphanumériques.
trailer_country^[A-Z]{2}$Code pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
trailer_registrationImmatriculation de la remorque ou semi-remorque, normalisée comme celle du tracteur. En Espagne, la série R est requise. Pour les autres pays : de 3 à 20 caractères alphanumériques.
Table des alternatives
| Alternative | Critères de sélection |
|---|---|
| type = object · Champs obligatoires: trailer_country, trailer_registration | |
| type = object · Champs obligatoires: country, registration |
trailer_country^[A-Z]{2}$ · obligatoireCode pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
trailer_registrationImmatriculation de la remorque ou semi-remorque, normalisée comme celle du tracteur. En Espagne, la série R est requise. Pour les autres pays : de 3 à 20 caractères alphanumériques.
country^[A-Z]{2}$Code pays à deux lettres ; normalisé en majuscules. Le format ne vérifie pas l'appartenance au catalogue ISO 3166-1.
registrationImmatriculation normalisée en majuscules sans espaces ni traits d'union. En Espagne, les immatriculations ordinaires actuelles, anciennes provinciales et la série spéciale E sont acceptées. Pour les autres pays : de 3 à 20 caractères alphanumériques.
SpecialAuthorization
numberNuméro ou référence de l'autorisation.
issuerOrganisme émetteur, s'il est renseigné.
CreateDocumentRequest
transport_dateDate réelle du transport au format YYYY-MM-DD ; ce n'est pas l'instant de création du PDF.
Chargeur contractuel ; peut différer de l'entrepôt de départ et du client DeCA.
Transporteur effectuant réellement le transport, y compris le sous-traitant.
Nature et poids de la marchandise, ou grandeur alternative si nécessaire. Envoyez exactement une mesure.
Véhicule effectif ; si une remorque ou semi-remorque est présente, renseignez ses deux champs ensemble.
reference^[A-Za-z0-9-]+(?![\s…Référence personnelle facultative, unique par organisation et environnement et imprimée sur le PDF. Identifie les nouvelles tentatives et permet la consultation par référence. N'est pas libérée lors de la suppression du document.
Autorisation spéciale de circulation si nécessaire. Omettez-la ou envoyez null si elle ne s'applique pas.
observationsObservations que les intervenants demandent de faire figurer dans le document.
Objet JSON facultatif, conservé et renvoyé sans modification sémantique. Non imprimé sur le PDF. Maximum 16 KiB après sérialisation et 8 niveaux de profondeur.
DocumentResult
uuidUUID du document émis.
reference^[A-Za-z0-9-]+(?![\s… · obligatoireRéférence du client ou null.
created_atInstant original de création, en UTC.
urlURL HTTPS complète de téléchargement par QR, avec son secret. Ne pas enregistrer ni publier.
pdf_download_urlURL de téléchargement authentifié ; exige le Bearer de l'identifiant propriétaire dans les 24 heures.
rectifies_uuidUUID rectifié ou null lors d'une émission initiale.
La même metadata que dans la requête ; null si elle n'a pas été fournie.
document_localeLangue du PDF choisie à l'émission selon l'organisation. Conservée dans le résultat ; changer la langue de l'organisation ne modifie pas les documents existants. Ne change ni les champs JSON ni les messages d'erreur de l'API.
DocumentSummary
uuidreference^[A-Za-z0-9-]+(?![\s… · obligatoirecreated_attransport_daterectifies_uuidDocumentList
ErrorResponse
Toutes les erreurs indépendantes détectées ; sans données de requête, secrets ni traces.
RectifyDocumentRequest
transport_dateDate réelle du transport au format YYYY-MM-DD ; ce n'est pas l'instant de création du PDF.
Chargeur contractuel ; peut différer de l'entrepôt de départ et du client DeCA.
Transporteur effectuant réellement le transport, y compris le sous-traitant.
Nature et poids de la marchandise, ou grandeur alternative si nécessaire. Envoyez exactement une mesure.
Véhicule effectif ; si une remorque ou semi-remorque est présente, renseignez ses deux champs ensemble.
reference^[A-Za-z0-9-]+(?![\s…Nouvelle référence du document rectificatif, facultative et unique par organisation et environnement. Ne réutilisez pas la référence du document identifié dans l'URL.
Autorisation spéciale de circulation si nécessaire. Omettez-la ou envoyez null si elle ne s'applique pas.
observationsObservations que les intervenants demandent de faire figurer dans le document.
Objet JSON facultatif, conservé et renvoyé sans modification sémantique. Non imprimé sur le PDF. Maximum 16 KiB après sérialisation et 8 niveaux de profondeur.
DeleteDocumentRequest
reasonMotif de l'erreur détectée lors de la génération du document.
confirm_not_deliveredDoit être true pour supprimer : confirme l'absence de remise au transporteur ou au conducteur. false renvoie 409 DOCUMENT_ALREADY_DELIVERED.
confirm_not_usedDoit être true pour supprimer : confirme l'absence d'utilisation pour un transport. false renvoie 409 DOCUMENT_ALREADY_USED.
DocumentStatus
statusÉtat du document. N'inclut ni données de transport, PDF, QR, metadata ni dates.
DemoTokenResult
token^sk_demo_[0-9a-f]{64… · obligatoireVous pouvez demander un jeton sk_demo_ sans compte ni organisation enregistrée. Il dure 24 heures à partir de son émission et fonctionne uniquement depuis l’IP publique qui l’a demandé. Un changement de réseau ou d’IP nécessite un autre jeton.
expires_atDate d’expiration du jeton en UTC. Tous ses documents et liens expirent à cet instant.
document_localeLangue des PDF de ce jeton. Espagnol par défaut.
DemoDocumentResult
uuidUUID du document émis.
reference^[A-Za-z0-9-]+(?![\s… · obligatoireRéférence du client ou null.
created_atInstant original de création, en UTC.
urlURL HTTPS complète de téléchargement par QR, avec son secret. Ne pas enregistrer ni publier.
pdf_download_urlVous pouvez demander un jeton sk_demo_ sans compte ni organisation enregistrée. Il dure 24 heures à partir de son émission et fonctionne uniquement depuis l’IP publique qui l’a demandé. Un changement de réseau ou d’IP nécessite un autre jeton.
rectifies_uuidUUID rectifié ou null lors d'une émission initiale.
La même metadata que dans la requête ; null si elle n'a pas été fournie.
document_localeLangue des PDF de ce jeton. Espagnol par défaut.
demoUniquement en démo ; toujours true. Absent des résultats de développement et de production.
expires_atDate d’expiration du jeton en UTC. Tous ses documents et liens expirent à cet instant.
qr_urlUniquement en démo ; alias de url.
pdf_urlUniquement en démo ; alias de pdf_download_url. Nécessite le jeton demo et son IP.