The Notification and Disclosure solution includes a set of interfaces for querying validation and status

This interface (API) includes several endpoints for each message level:

• Transport
• Master consignment
• House consignment

There are two types of endpoints for each level:

• Validation of messages
• Retrieving the status of messages

Validation endpoints:

• These endpoints return the validation status and MRN (Movement Reference Number, Norwegian Customs' reference to the message) upon submission of messages.
• The client submits LRN (client's own reference to the message) for the submitted message and receives MRN (upon successful submission) and validation status (always).

Explanation of validation statuses can be found here.

Transport

/transport/validation-status/{requestId}

Master consignment

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

House consignment

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

Status endpoints:

These endpoints provide a submission status and an overview of underlying levels (where applicable).

Transport:

The input parameter for these endpoints is the MRN for the transport message, i.e., the MRN returned for a successful submission of a transport message.

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

  Use this to view all master consignments and all house consignments linked to a transport. The endpoint provides a summary of weight for master consignments and house consignments and the specified weight for each master consignment and consignment. The "received" field on the master consignment indicates that the master consignment message has been submitted. A "false" value here indicates that the reference to the master consignment is provided in the transport message, but the master consignment message has not been received.

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

  Use this to view all master consignments linked to a transport.

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

  Use this to view all house consignments linked to a transport. For each consignment, a list of missing documentation references will also be returned if applicable. See link to incompleteDocumentationReasonList documentation.

Master consignment:

The input parameter for these endpoints is the MRN for the master consignment message, i.e., the MRN returned for a successful submission of a master consignment message.

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

  Use this to view a master consignment and all house consignments linked to it. The endpoint provides a summary of weight and house consignments linked to the master consignment and the specified weight for each master consignment and consignment. The "received" field on the master consignment indicates that the master consignment message has been submitted. A "false" value here indicates that the reference to the master consignment is provided in the transport message, but the master consignment message has not been received.

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

  /master-consignment/transport-document/status

  The input parameter here is the master consignment's document number (documentNumber, type, and carrierId). Use these to view all house consignments linked to a master consignment, based on the MRN or document number of the master consignment. For each consignment, a list of missing documentation references will also be returned if applicable. See link to incompleteDocumentationReasonList documentation.

House consignment:

The input parameter for these endpoints is the MRN for the house consignment message, i.e., the MRN returned for a successful submission of a house consignment message.

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

  Use these to view the status of a consignment based on the MRN of the consignment. For the consignment, a list of missing documentation references will also be returned if applicable. See link to incompleteDocumentationReasonList documentation.

• /house-consignment/transport-document/status

  The input parameter here is the consignment's document number (documentNumber, type, and carrierId). Use these to view the status of a consignment based on the document number of the consignment. For the consignment, a list of missing documentation references will also be returned if applicable. See link to incompleteDocumentationReasonList documentation.

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

  The input parameter here is the postal receptacle's ID number (receptacleIdentificationNumber). Use this to view the status of house consignments linked to a postal receptacle based on the postal receptacle's ID. Used only for UPU postal shipments.