DeCA
Webgune nagusia
API DeCA
API DeCA

Eskemak

Deskargatu OpenAPI

CountryCode

string · pattern: ^[A-Z]{2}$

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES

PositiveDecimal

string · pattern: ^(?!0+(?:\.0+)?$)(?:…

Hamartar positiboa string gisa, puntuarekin, komarik eta notazio zientifikorik gabe. Gehienez 15 digitu oso eta 6 hamartar. Erantzunak amaierako zero hamartarrak kentzen ditu.

Adibidea: 1850.000

WeightKilograms

oneOf
Aukera bakarra bete behar da.

Aukeren taula

AukeraHautaketa-irizpideak
type = string
type = number
Aukera 1 aukeraren propietateak:
PositiveDecimal · pattern: ^(?!0+(?:\.0+)?$)(?:…

Hamartar positiboa string gisa, puntuarekin, komarik eta notazio zientifikorik gabe. Gehienez 15 digitu oso eta 6 hamartar. Erantzunak amaierako zero hamartarrak kentzen ditu.

Adibidea: 1850.000

Address

street
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Helbideko kalea eta zenbakia.

postal_code
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Posta-kodea testu gisa, hasierako zeroak gordetzeko.

city
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Helbideko herria.

country
​CountryCode · pattern: ^[A-Z]{2}$ · nahitaezkoa

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES

Shipper

Kontratuzko kargatzailea; jatorriko biltegitik eta DeCA bezeroarengandik desberdina izan daiteke.
name
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Izena edo sozietate-izena.

tax_country
​CountryCode · pattern: ^[A-Z]{2}$ · nahitaezkoa

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES
tax_id
​string · minLength: 1 · maxLength: 32 · nahitaezkoa

Identifikatzaile fiskala maiuskulaz normalizatzen da, zuriunerik eta marratxorik gabe; luzera normalizatu ondoren egiaztatzen da. Espainian DNI, NIE eta erakundeen IFZen (CIF) formatua eta kontrol-karakterea baliozkotzen dira. K, L eta M IFZ berezien formatua soilik egiaztatzen da: aurrizkia, zazpi karaktere alfanumeriko eta azken letra. Beste herrialdeetarako formatu alfanumerikoa eskatzen da, kontrol fiskala egiaztatu gabe. Baliozkotzeak ez du existentzia edo erroldako alta frogatzen.

​Address · nahitaezkoa

Carrier

Garraioa benetan egiten duen garraiolaria, azpikontratatua barne.
name
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Izena edo sozietate-izena.

tax_country
​CountryCode · pattern: ^[A-Z]{2}$ · nahitaezkoa

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES
tax_id
​string · minLength: 1 · maxLength: 32 · nahitaezkoa

Identifikatzaile fiskala maiuskulaz normalizatzen da, zuriunerik eta marratxorik gabe; luzera normalizatu ondoren egiaztatzen da. Espainian DNI, NIE eta erakundeen IFZen (CIF) formatua eta kontrol-karakterea baliozkotzen dira. K, L eta M IFZ berezien formatua soilik egiaztatzen da: aurrizkia, zazpi karaktere alfanumeriko eta azken letra. Beste herrialdeetarako formatu alfanumerikoa eskatzen da, kontrol fiskala egiaztatu gabe. Baliozkotzeak ez du existentzia edo erroldako alta frogatzen.

​object

Garraiolariaren aukerako helbidea. Bidaltzen bada, Address eremu guztiak behar dira; 6. artikuluak ez du gutxieneko datu gisa eskatzen.

TransportLocation

place
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Benetako karga- edo deskarga-lekua, instalazioaren izenaren edo helbidearen bidez identifikagarria. city eta country eremuekin lekua argi identifikatu behar du; street eta postal_code aukerakoak dira. Enpresa hartzailearen identitatea ez da nahitaezko gutxieneko datua.

city
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Herria.

country
​string · enum · nahitaezkoa

Hasierako esparruak Espainia barruko garraioak hartzen ditu; ez du nazioarteko CMRa ordezkatzen.

Onartutako balioak:
ES
street
​string · minLength: 1 · maxLength: 255

Karga- edo deskarga-lekuko aukerako kalea eta zenbakia, kokalekua zehazteko.

postal_code
​string · minLength: 1 · maxLength: 255

Karga- edo deskarga-lekuko aukerako posta-kodea, testu gisa hasierako zeroak gordetzeko.

AlternativeMeasure

Beste magnitude bat pisua zehaztea zaila denean. Bidali magnitude hau edo pisua, inoiz ez biak.
value
​PositiveDecimal · pattern: ^(?!0+(?:\.0+)?$)(?:… · nahitaezkoa

Hamartar positiboa string gisa, puntuarekin, komarik eta notazio zientifikorik gabe. Gehienez 15 digitu oso eta 6 hamartar. Erantzunak amaierako zero hamartarrak kentzen ditu.

Adibidea: 1850.000
unit
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Magnitudearen unitate esplizitua, gehienez 255 karaktere.

Adibidea: palés

Goods

Salgaien izaera eta pisua, edo ordezko magnitudea dagokionean. Bidali neurri bakarra.
description
​string · minLength: 1 · maxLength: 2000 · nahitaezkoa

Salgaien izaeraren deskribapena.

​WeightKilograms

Pisu positiboa kg-tan, JSON zenbaki edo testu hamartar gisa. Gehienez 15 digitu oso eta 6 hamartar. Erantzunak testu gisa normalizatzen du eta zehaztasuna gordetzen du; PDFak gehienez 3 hamartar erakusten ditu, koma hamartarrarekin eta milakoak puntuz bereizita. Balio handietan zehaztasuna ez galtzeko, erabili testu hamartarra.

Adibidea: 1850.5
​AlternativeMeasure

Beste magnitude bat pisua zehaztea zaila denean. Bidali magnitude hau edo pisua, inoiz ez biak.

oneOf
Aukera bakarra bete behar da.

Aukeren taula

AukeraHautaketa-irizpideak
type = object · Nahitaezko eremuak: weight_kg
type = object · Nahitaezko eremuak: alternative_measure
Aukera 1 aukeraren propietateak:
​WeightKilograms · nahitaezkoa

Pisu positiboa kg-tan, JSON zenbaki edo testu hamartar gisa. Gehienez 15 digitu oso eta 6 hamartar. Erantzunak testu gisa normalizatzen du eta zehaztasuna gordetzen du; PDFak gehienez 3 hamartar erakusten ditu, koma hamartarrarekin eta milakoak puntuz bereizita. Balio handietan zehaztasuna ez galtzeko, erabili testu hamartarra.

Adibidea: 1850.5
description
​string · minLength: 1 · maxLength: 2000

Salgaien izaeraren deskribapena.

​AlternativeMeasure

Beste magnitude bat pisua zehaztea zaila denean. Bidali magnitude hau edo pisua, inoiz ez biak.

Vehicle

Benetako ibilgailua; atoia edo erdiatoia badago, bete haren bi eremuak batera.
country
​CountryCode · pattern: ^[A-Z]{2}$ · nahitaezkoa

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES
registration
​string · minLength: 1 · maxLength: 20 · nahitaezkoa

Matrikula maiuskulaz normalizatzen da, zuriunerik eta marratxorik gabe. Espainian egungo ohiko matrikulak, lehengo probintzia-matrikulak eta E serie berezia onartzen dira. Beste herrialdeetarako, 3 eta 20 karaktere alfanumeriko artean.

Adibidea: 4827 MNL
trailer_country
​CountryCode · pattern: ^[A-Z]{2}$

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES
trailer_registration
​string · minLength: 1 · maxLength: 20

Atoiaren edo erdiatoiaren matrikula, traktorearena bezala normalizatua. Espainian R seriea eskatzen da. Beste herrialdeetarako, 3 eta 20 karaktere alfanumeriko artean.

Adibidea: R 5832 BCD
oneOf
Aukera bakarra bete behar da.

Aukeren taula

AukeraHautaketa-irizpideak
type = object · Nahitaezko eremuak: trailer_country, trailer_registration
type = object · Nahitaezko eremuak: country, registration
Aukera 1 aukeraren propietateak:
trailer_country
​CountryCode · pattern: ^[A-Z]{2}$ · nahitaezkoa

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES
trailer_registration
​string · minLength: 1 · maxLength: 20 · nahitaezkoa

Atoiaren edo erdiatoiaren matrikula, traktorearena bezala normalizatua. Espainian R seriea eskatzen da. Beste herrialdeetarako, 3 eta 20 karaktere alfanumeriko artean.

Adibidea: R 5832 BCD
country
​CountryCode · pattern: ^[A-Z]{2}$

Bi letrako herrialde-kodea; maiuskulaz normalizatzen da. Formatuak ez du ISO 3166-1 katalogoko kidetza egiaztatzen.

Adibidea: ES
registration
​string · minLength: 1 · maxLength: 20

Matrikula maiuskulaz normalizatzen da, zuriunerik eta marratxorik gabe. Espainian egungo ohiko matrikulak, lehengo probintzia-matrikulak eta E serie berezia onartzen dira. Beste herrialdeetarako, 3 eta 20 karaktere alfanumeriko artean.

Adibidea: 4827 MNL

SpecialAuthorization

Zirkulazio-baimen berezia beharrezkoa denean. Ez bidali edo bidali null ez badagokio.
number
​string · minLength: 1 · maxLength: 255 · nahitaezkoa

Baimenaren zenbakia edo erreferentzia.

issuer
​string · minLength: 1 · maxLength: 255

Erakunde igorlea, adierazten bada.

CreateDocumentRequest

transport_date
​string · date · nahitaezkoa

Benetako garraio-data YYYY-MM-DD formatuan; ez da PDFaren sorrera-unea.

​Shipper · nahitaezkoa

Kontratuzko kargatzailea; jatorriko biltegitik eta DeCA bezeroarengandik desberdina izan daiteke.

​Carrier · nahitaezkoa

Garraioa benetan egiten duen garraiolaria, azpikontratatua barne.

​TransportLocation · nahitaezkoa
​TransportLocation · nahitaezkoa
​Goods · nahitaezkoa

Salgaien izaera eta pisua, edo ordezko magnitudea dagokionean. Bidali neurri bakarra.

​Vehicle · nahitaezkoa

Benetako ibilgailua; atoia edo erdiatoia badago, bete haren bi eremuak batera.

reference
​string | null · minLength: 1 · maxLength: 120 · pattern: ^[A-Za-z0-9-]+(?![\s…

Norberaren aukerako erreferentzia, erakunde eta ingurune bakoitzeko bakarra eta PDFan inprimatua. Berriz saiatzeak identifikatzen ditu eta erreferentzia bidez kontsultatzeko aukera ematen du. Ez da askatzen dokumentua ezabatzean.

​SpecialAuthorization

Zirkulazio-baimen berezia beharrezkoa denean. Ez bidali edo bidali null ez badagokio.

observations
​string | null · maxLength: 4000

Parte-hartzaileek dokumentuan jasotzeko eskatzen dituzten oharrak.

​object | null

Aukerako JSON objektua, aldaketa semantikorik gabe gorde eta itzultzen dena. Ez da PDFan inprimatzen. Gehienez 16 KiB serializatzean eta 8 sakonera-maila.

DocumentResult

uuid
​string · uuid · nahitaezkoa

Jaulkitako dokumentuaren UUIDa.

reference
​string | null · pattern: ^[A-Za-z0-9-]+(?![\s… · nahitaezkoa

Bezeroaren erreferentzia edo null.

created_at
​string · date-time · nahitaezkoa

Jatorrizko sorrera-unea, UTCn.

url
​string · uri · nahitaezkoa

QR bidez deskargatzeko HTTPS URL osoa, sekretua barne. Ez erregistratu edo argitaratu.

​object · nahitaezkoa
pdf_download_url
​string · uri · nahitaezkoa

Deskarga autentifikatuaren URLa; kredentzial jabearen Bearerra behar du 24 orduko epean.

rectifies_uuid
​string | null · uuid · nahitaezkoa

Zuzendutako UUIDa edo null hasierako jaulkipenean.

​CreateDocumentRequest · nahitaezkoa
​object | null · nahitaezkoa

Eskaeraren metadata bera; null eman ez bada.

document_locale
​string · enum · nahitaezkoa

Jaulkitzean erakundearen arabera hautatutako PDFaren hizkuntza. Emaitzan gordetzen da; erakundearen hizkuntza aldatzeak ez ditu lehendik dauden dokumentuak aldatzen. Ez ditu JSON eremuak edo APIaren errore-mezuak aldatzen.

Onartutako balioak:
es
ca
gl
ca-valencia
eu
en
pt-pt
fr

DocumentSummary

uuid
​string · uuid · nahitaezkoa
reference
​string | null · pattern: ^[A-Za-z0-9-]+(?![\s… · nahitaezkoa
created_at
​string · date-time · nahitaezkoa
transport_date
​string · date · nahitaezkoa
rectifies_uuid
​string | null · uuid · nahitaezkoa

DocumentList

​DocumentSummary[] · nahitaezkoa
​object · nahitaezkoa

ErrorResponse

​object[] · minItems: 1 · nahitaezkoa

Detektatutako errore independente guztiak; eskaera-daturik, sekreturik edo aztarnarik gabe.

RectifyDocumentRequest

Garraioaren zuzendutako datu guztiak. Aurreko dokumentua URLan identifikatzen da. reference sartzen bada, dokumentu zuzentzailearen erreferentzia berria izan behar du.
transport_date
​string · date · nahitaezkoa

Benetako garraio-data YYYY-MM-DD formatuan; ez da PDFaren sorrera-unea.

​Shipper · nahitaezkoa

Kontratuzko kargatzailea; jatorriko biltegitik eta DeCA bezeroarengandik desberdina izan daiteke.

​Carrier · nahitaezkoa

Garraioa benetan egiten duen garraiolaria, azpikontratatua barne.

​TransportLocation · nahitaezkoa
​TransportLocation · nahitaezkoa
​Goods · nahitaezkoa

Salgaien izaera eta pisua, edo ordezko magnitudea dagokionean. Bidali neurri bakarra.

​Vehicle · nahitaezkoa

Benetako ibilgailua; atoia edo erdiatoia badago, bete haren bi eremuak batera.

reference
​string | null · minLength: 1 · maxLength: 120 · pattern: ^[A-Za-z0-9-]+(?![\s…

Dokumentu zuzentzailearen erreferentzia berria, aukerakoa eta erakunde eta ingurune bakoitzeko bakarra. Ez berrerabili URLan identifikatutako dokumentuaren erreferentzia.

​SpecialAuthorization

Zirkulazio-baimen berezia beharrezkoa denean. Ez bidali edo bidali null ez badagokio.

observations
​string | null · maxLength: 4000

Parte-hartzaileek dokumentuan jasotzeko eskatzen dituzten oharrak.

​object | null

Aukerako JSON objektua, aldaketa semantikorik gabe gorde eta itzultzen dena. Ez da PDFan inprimatzen. Gehienez 16 KiB serializatzean eta 8 sakonera-maila.

DeleteDocumentRequest

reason
​string · minLength: 1 · maxLength: 2000 · nahitaezkoa

Dokumentua sortzean detektatutako akatsaren arrazoia.

confirm_not_delivered
​boolean · nahitaezkoa

Ezabatzeko true izan behar du: garraiolariari edo gidariari entregatu ez zaiola baieztatzen du. false balioak 409 DOCUMENT_ALREADY_DELIVERED itzultzen du.

confirm_not_used
​boolean · nahitaezkoa

Ezabatzeko true izan behar du: garraio batean erabili ez dela baieztatzen du. false balioak 409 DOCUMENT_ALREADY_USED itzultzen du.

DocumentStatus

status
​string · enum · nahitaezkoa

Dokumentuaren egoera. Ez du garraio-informaziorik, PDFrik, QRrik, metadatarik edo datarik.

Onartutako balioak:
active
deleted

DemoTokenResult

token
​string · pattern: ^sk_demo_[0-9a-f]{64… · nahitaezkoa

sk_demo_ token bat eska dezakezu konturik edo erakunderik erregistratu gabe. Jaulkitzen denetik 24 ordu irauten du eta eskatu duen IP publikotik bakarrik funtzionatzen du. Sarea edo IPa aldatuz gero, beste token bat eskatu behar da.

expires_at
​string · date-time · nahitaezkoa

Tokenaren iraungitze-unea UTCn. Haren dokumentu eta esteka guztiak une honetan iraungitzen dira.

document_locale
​string · enum · nahitaezkoa

Token honen PDFen hizkuntza. Gaztelania lehenespenez.

Onartutako balioak:
es
ca
gl
ca-valencia
eu
en
pt-pt
fr

DemoDocumentResult

Demoak demo: true, expires_at, qr_url (url eremuaren aliasa) eta pdf_url (pdf_download_url eremuaren aliasa) gehitzen ditu. document_locale tokena eskatzean aukeratutako hizkuntza da (es lehenespenez). Aldi baterako datuak eta PDFak benetako artxibotik bereizita daude eta ez dira benetako dokumentuak bezala zifratzen.
uuid
​string · uuid · nahitaezkoa

Jaulkitako dokumentuaren UUIDa.

reference
​string | null · pattern: ^[A-Za-z0-9-]+(?![\s… · nahitaezkoa

Bezeroaren erreferentzia edo null.

created_at
​string · date-time · nahitaezkoa

Jatorrizko sorrera-unea, UTCn.

url
​string · uri · nahitaezkoa

QR bidez deskargatzeko HTTPS URL osoa, sekretua barne. Ez erregistratu edo argitaratu.

​object · nahitaezkoa
pdf_download_url
​string · uri · nahitaezkoa

sk_demo_ token bat eska dezakezu konturik edo erakunderik erregistratu gabe. Jaulkitzen denetik 24 ordu irauten du eta eskatu duen IP publikotik bakarrik funtzionatzen du. Sarea edo IPa aldatuz gero, beste token bat eskatu behar da.

rectifies_uuid
​string | null · uuid · nahitaezkoa

Zuzendutako UUIDa edo null hasierako jaulkipenean.

​CreateDocumentRequest · nahitaezkoa
​object | null · nahitaezkoa

Eskaeraren metadata bera; null eman ez bada.

document_locale
​string · enum · nahitaezkoa

Token honen PDFen hizkuntza. Gaztelania lehenespenez.

Onartutako balioak:
es
ca
gl
ca-valencia
eu
en
pt-pt
fr
demo
​boolean · enum · nahitaezkoa

Demoan soilik; beti true da. Ez da garapeneko edo produkzioko emaitzetan agertzen.

Onartutako balioak:
true
expires_at
​string · date-time · nahitaezkoa

Tokenaren iraungitze-unea UTCn. Haren dokumentu eta esteka guztiak une honetan iraungitzen dira.

qr_url
​string · uri · nahitaezkoa

Demoan soilik; url eremuaren aliasa.

pdf_url
​string · uri · nahitaezkoa

Demoan soilik; pdf_download_url eremuaren aliasa. Demo-tokena eta haren IPa behar ditu.