Løsningen for melde- og opplysning har API for spørring om validering og status

Dette grensesnittet omfatter flere endepunkter for hvert meldingsnivå:

• Transport
• Hovedforsendelse (Master consignment)
• Forsendelse (House consignment)

Det er to typer endepunkter for hvert nivå:

• Validering av meldinger
• Hente status på meldinger

Valideringsendepunkter:

Disse endepunktene er de som returnerer valideringsstatus og MRN ((Movement Reference Number, Tolletatens referanse til meldingen) ved innsending av meldinger.

Klient sender inn LRN (egen referanse til meldingen) for innsendt melding og får tilbake MRN (ved vellykket innsending) og valideringsstatus (alltid).

Forklaring på valideringsstatuser finnes her.

Transport

/transport/validation-status/{requestId}

Hovedforsendelse (Master consignment)

/master-consignment/validation-status/{requestId}

Forsendelse (House consignment)

/house-consignment/validation-status/{requestId}

Statusendepunkter:

Disse endepunktene gir status på innsendingen og en oversikt over underliggende nivåer der dette er relevant. For å hente status på en innsending må forespørselen sendes fra samme organisasjonsnummer som opprinnelig sendte inn meldingen. For underliggende nivåer kan man også se status for forsendelser som er sendt inn av andre aktører.

Transport

Inngangsparameter til disse endepunktene er MRN for transportmeldingen, altså den MRN som blir returnert for en vellykket innsending av en melding om transport.

• /transport/{mrn}/status-with-descendants

  Bruk dette når du ønsker å se alle hovedforsendelser og alle forsendelser som er knyttet til en transport. Endepunktet gir en oppsummering av vekt for hovedforsendelser og forsendelser og oppgitt vekt for hver hovedforsendelse og hver forsendelse. Feltet "received" på hovedforsendelse indikerer at melding om hovedforsendelse er sendt inn. En verdi "false" her indikerer at referansen til hovedforsendelsen er oppgitt i transportmeldingen, men melding om hovedforsendelse er ikke mottatt.

• /transport/{mrn}/master-consignment/transport-document/status

  Bruk denne for å se alle hovedforsendelser som er knyttet til en transport.

• /transport/{mrn}/house-consignment/transport-document/status

  Bruk denne for å se alle forsendelser som er knyttet til en transport. For hver forsendelse vil det også bli returnert en liste med manglende dokumentasjonsreferanser dersom det er aktuelt. Se link til incompleteDocumentationReasonList dokumentasjon.

Hovedforsendelse (Master consignment):

Inngangsparameter til disse endepunktene er MRN for meldingen om hovedforsendelse, altså den MRN som blir returnert for en vellykket innsending av en melding om hovedforsendelse (master).

• /master-consignment/{mrn}/status-with-descendants

  Bruk dette når du ønsker å se en hovedforsendelse og alle forsendelser som er knyttet til den. Endepunktet gir en oppsummering av vekt og forsendelser knyttet til hovedforsendelsen og oppgitt vekt for hver hovedforsendelse og hver forsendelse. Feltet "received" på hovedforsendelse indikerer at melding om hovedforsendelse er sendt inn. En verdi "false" her indikerer at referansen til hovedforsendelsen er oppgitt i transportmeldingen, men melding om hovedforsendelse er ikke mottatt.

• /master-consignment/{mrn}/transport-document/status

  /master-consignment/transport-document/status

  Inngangsparameter her er hovedforsendelsens dokumentnummer/fraktbrevnummer (documentNumber, type og carrierId). Bruk disse for å se alle forsendelser som er knyttet til en hovedforsendelse, basert på MRN eller dokumentnummeret til hovedforsendelsen. For hver forsendelse vil det også bli returnert en liste med manglende dokumentasjonsreferanser dersom det er aktuelt. Se link til incompleteDocumentationReasonList dokumentasjon.

Forsendelse (House consignment):

Inngangsparameter til disse endepunktene er MRN for meldingen om forsendelse, altså den MRN som blir returnert for en vellykket innsending av en melding om forsendelse (house).

• /house-consignment/{mrn}/transport-document/status

  Bruk disse for å se status for en forsendelse basert på MRN til forsendelsen. For forsendelsen vil det også bli returnert en liste med manglende dokumentasjonsreferanser dersom det er aktuelt. Se link til incompleteDocumentationReasonList dokumentasjon.

• /house-consignment/transport-document/status

  Inngangsparameter her er forsendelsens dokumentnummer/fraktbrevnummer (documentNumber, type og carrierId). Bruk disse for å se status for en forsendelse basert på dokumentnummeret til forsendelsen. For forsendelsen vil det også bli returnert en liste med manglende dokumentasjonsreferanser dersom det er aktuelt. Se link til incompleteDocumentationReasonList dokumentasjon.

• /house-consignment/postal-receptacle/{receptacleIdentificationNumber}/transport-document/status

  Inngangsparameter her er postsekk/postbeholders id-nummer (receptacleIdentificationNumber). Bruk denne for å se status for forsendelser som er knyttet til en postsekk/postbeholder basert på postsekk/postbeholder sin id. Brukes kun for UPU postsendinger.