Introduction
Learn how to create Transit Declaration data into Eurora’s system, update/ modify declaration data, view your declaration data and view your declaration status.
Documentation
Mandatory endpoints
STEP 1: Create or update transit declaration (POST)
-
Purpose - “Create or update transit declaration” endpoint must be used to send transit declarations data to Eurora.
-
API documentation: API Documentation - Create or update transit declaration
API REQUEST URL - https://api.eurora.com/customs-transit/external/v1/declaration
NB! Ensure that you are using the Customs service.
-
If the broker is Eurora, then every declaration must contain Eurora as declarant
-
Successful response returns the declaration UUID which can be used later to request the status of the declaration processing.
STEP 2: Get transit declarations with statuses updated within given timeframe (GET)
-
Purpose - Retrieve the latest information about the transit declarations data.
-
API documentation: API Documentation - Get transit declarations with statuses updated within given timeframe
API REQUEST URL - https://api.eurora.com/customs-transit/external/v1/declaration/statuses
NB! Ensure that you are using the Customs service.
-
The request must have the following parameters - startDate, pageNo and pageSize.
-
Duration between startDate and endDate should not be longer than 1 week. In case endDate is not specified the system returns all declarations with statuses updated startDate + 1 week
-
To set up constant polling for the status updates, the endpoint should be used as follows:
-
Every time the request is sent to the endpoint, the endDate of the request should be stored in the system.
-
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 declarations that have been updated between the last request and the current request.
-
Optional endpoints
Get declaration details without goods items (GET)
-
Purpose - Allows users to retrieve all data elements of a transit declaration, retrieve errors and verify if there are any errors associated with the data uploaded.
-
API documentation: API Documentation - Get declaration details without goods items
API REQUEST URL - https://api.eurora.com/customs-transit/external/v1/declaration/{id}
NB! Ensure that you are using the Customs service.
-
Received UUID from Transit departure (Non-broker) | STEP 1: Create or update transit declaration (POST) endpoint has to be used in this endpoint to retrieve transit declaration.
-
Returned body contains:
-
declarationData - Transit declaration data
-
messageItems - Errors of the transit declaration data (if there are any)
-
Get transit declaration goods items data (GET)
-
Purpose - Allows users to retrieve all data elements of a goods items (of transit declaration).
-
API documentation: API Documentation - Get transit declaration goods items data
API REQUEST URL - https://api.eurora.com/customs-transit/external/v1/declaration/{id}/goods-items
NB! Ensure that you are using the Customs service.
-
Received UUID from Transit departure (Non-broker) | STEP 1: Create or update transit declaration (POST) endpoint has to be used in this endpoint to retrieve goods items (of transit declaration).
-
Returned body contains:
-
goodsItems - Goods items data of transit declaration
-
Get list of transit declarations summary (GET)
-
Purpose - Retrieve the summary information about transit declaration data.
-
API documentation: API Documentation - Get list of transit declarations summary
API REQUEST URL - https://api.eurora.com/customs-transit/external/v1/declaration/summaries
NB! Ensure that you are using the Customs service.
-
The request must have the following parameters - pageNo, pageSize, sortBy and sortDirection.
-
The system returns the summary of all transit declarations in a specific period. The period can be specified by parameters - from and to. In case “from” is not specified the system returns all declarations starting with the creation date of the first declaration in the system and ending with “to“ date. In case “to” is not specified the system returns all declarations starting with “from“ date and ending with the creation date of the last declaration in the system. Response is pageable and the amount of declaration is based on the page(s) size.