Introduction

Learn how to observe Transit Arrival notification data with Unloading remarks data in Eurora’s system, view your arrival notification and unloading remarks data and view your arrival notification status.

Documentation

Arrival notification

• Integration Environment API Documentation

• Production Environment API Documentation

Unloading remark

• Integration Environment API Documentation

• Production Environment API Documentation

Optional endpoints for Arrival notification

Get arrival notification with statuses update within timeframe (GET)

• Purpose - Retrieve the latest information about the transit arrival notification data.

• API documentation: API Documentation - Get arrival notification with statuses update within timeframe

1. The request must have the following parameters - startDate, pageNo and pageSize.

2. Duration between startDate and endDate should not be longer than 1 week. In case endDate is not specified the system returns all arrival notifications with statuses updated startDate + 1 week

3. To set up constant polling for the status updates, the endpoint should be used as follows:

          a. Every time the request is sent to the endpoint, the endDate of the request should be stored in the system.

          b. Every new request should use the endDate of the previous request as a startDate of the current request, which results in returning all of the arrival notifications that have been updated between the last request and the current request.

Get transit arrival notification id (GET)

• Purpose - Retrieve the UUID of a specific arrival notification based on its mrn.

• API documentation: API Documentation - Get transit arrival notification id

1. Received MRN from

          a. Transit departure (Non-broker) | STEP 2: Get transit declarations with statuses updated within given timeframe (... or

          b. Transit departure (Non-broker) | Get declaration details without goods items (GET) or

          c. Transit departure (Non-broker) | Get list of transit declarations summary (GET) endpoint has to be used in this endpoint to retrieve transit arrival notification UUID.

      2. Returned body contains the arrival notification UUID - Universally unique identifier of transit arrival notification.

Get transit arrival notification detailed data (GET)

• Purpose - Allows users to retrieve all data elements of a transit arrival notification, retrieve errors and verify if there are any errors associated with the files uploaded.

• API documentation: API Documentation - Get declaration details without goods items

1. Received UUID from

          a. Transit destination (Non-broker) | Get arrival notification with statuses update within timeframe (GET) or

          b. Transit destination (Non-broker) | Get transit arrival notification id (GET) or

          c. Transit destination (Non-broker) | Get list of transit arrival notification summary (GET) endpoint has to be used in this endpoint to retrieve transit arrival notification.

      2. Returned body contains:

          a. arrivalNotification - Transit arrival notification data

          b. messageItems - Errors of the transit arrival notification data (if there are any)

Get list of transit arrival notification summary (GET)

• Purpose - Retrieve the summary information about the transit arrival notifications data.

• API documentation: API Documentation - Get list of transit arrival notification summary

1. The request must have the following parameters - pageNo, pageSize, sortBy and sortDirection.

2. The system returns the summary of all transit arrival notifications in a specific period. The period can be specified by parameters - from and to. In case “from” is not specified the system returns all arrival notifications starting with the creation date of the first arrival notification in the system and ending with “to“ date. In case “to” is not specified the system returns all arrival notifications starting with “from“ date and ending with the creation date of the last arrival notification in the system. Response is pageable and the amount of arrival notifications is based on the page(s) size.

Optional endpoints for Unloading remarks

Get list of unloading remarks summary of a transit arrival notification (GET)

• Purpose - Retrieve the summary information about unloading remarks data of a transit arrival notification.

• API documentation: API Documentation - Get list of unloading remarks summary of a transit arrival notification

1. The request must have the following parameters - arrivalNotificationId, pageNo, pageSize, sortBy and sortDirection.

2. Received arrival notification UUID from Transit destination (Non-broker) | Optional endpoints for Arrival notification endpoints has to be used in this endpoint to retrieve transit unloading remark.

3. The system returns the summary of all unloading remarks of a transit arrival notification in a specific period. The period can be specified by parameters - from and to. In case “from” is not specified the system returns all unloading remarks starting with the creation date of the first unloading remark in the system and ending with “to“ date. In case “to” is not specified the system returns all unloading remarks starting with “from“ date and ending with the creation date of the last unloading remark in the system. Response is pageable and the amount of unloading remarks is based on the page(s) size.

Get transit unloading remark detailed data (GET)

• Purpose - Allows users to retrieve all data elements of a transit unloading remark, retrieve errors and verify if there are any errors associated with the files uploaded.

• API documentation: API Documentation - Get transit unloading remark detailed data

1. Received arrival notification UUID from

          a. Transit destination (Non-broker) | Get list of unloading remarks summary of a transit arrival notification (GET) or

          b. Transit destination (Non-broker) | Optional endpoints for Arrival notification endpoint has to be used in this endpoint to retrieve transit unloading remark.

1. Returned body contains:

          a. arrivalNotificationId - Universally unique identifier of transit arrival notification

          b. unloadingRemark - Transit unloading remark data

          c. messageItems - Errors of the transit unloading remark data (if there are any)