Introduction

This document defines the activities necessary to integrate with Eurora system for submitting export declarations. This page lists main endpoints and their intended use.

Integrating with Eurora

Take the following steps to integrate with the Eurora API:

1. Eurora will create your account and issue you an API key. You will need to use this API key as your X-Auth-Token header parameter whenever you make a query.

2. Choose the API endpoints you wish to integrate with (see descriptions below).

3. Integrate with the chosen endpoints in Eurora's Integration environment. Use our Integration environment to test the endpoints and send us test data.

4. After testing and confirming the process flows are working, integrate with the endpoints in Eurora's Production environment to start sending us live data.

Eurora's Integration environment API documentation can be found here.

Eurora's Production environment API documentation can be found here.

Sending declaration data to Eurora

Sending shipment data to Eurora consists of two steps. First, the client should send export declaration data to Eurora. Second, after the Eurora system has registered export declaration, the client should submit export declaration to customs.

Important:

• Customs country specific data validations are triggered when user submits export declaration.

• In case you need to make corrections into existing declaration, make sure you have included declaration’s unique identifier (id) into the input of the “Create or update export declaration” endpoint.

• When declaration data is updated by “Create or update export declaration” endpoint, the status of the declaration is always changed back to DRAFT.

Create or update export declaration (POST)

• URL: https://api.eurora.com/customs-export/v1/declaration

• API documentation: https://api.eurora.com/customs-export-external-v1#operation/createOrUpdateExportDeclaration

• Purpose: This endpoint is used for sending export declaration data to Eurora.

• When to use: Use this endpoint when you want to create a new export declaration or modify an existing one. Existing declaration data can be modified if the declaration has not been sent to customs (Declaration status is DRAFT, INCOMPLETE or SUBMITTED_TECHNICAL_ERROR) or the declaration has been submitted, but has not been accepted by the Customs, because it did not pass validations (Declaration status is E_VALIDATION_NOT_OK). The status of the declaration is always changed to DRAFT after saving. Endpoint returns declaration’s unique identifier (uuid), which must be used to submit the declaration to customs or retrieve declaration data from the Eurora system.

• Example: Customer receives a list of validation errors when trying to submit export declaration that does not contain all the mandatory data for given customs country. Create or update export declaration endpoint must be used for sending corrected declaration data to Eurora system.

Submit export declaration to customs (POST)

• URL: https://api.eurora.com/customs-export/v1/declaration/submit/{id}

• API documentation: https://api.eurora.com/customs-export-external-v1#operation/submitExportDeclarationToCustoms

• Purpose: This endpoint is used for submitting an export declaration to customs.

• When to use: Use this endpoint when the declaration data has been successfully stored into Eurora system and the declaration status is DRAFT, INCOMPLETE, SUBMITTED_TECHNICAL_ERROR or E_VALDATION_NOT_OK. When the data validations pass, the export declaration message is sent to Customs.

• Example: Customer has successfully sent export declaration data to Eurora system.

Requesting declaration data from Eurora

After sending data to Eurora you can also request data back from Eurora to get overview of export declaration data. 

Get export declaration messages (GET)

• URL: https://api.eurora.com/customs-export/v1/declaration/{id}

• API documentation: https://api.eurora.com/customs-export-external-v1#operation/getExportDeclaration

• Purpose: Request current declaration status and latest messages (for example, validation errors) related to given declaration.

• When to use: This endpoint is used to check the status of a declaration and messages related to last status update.

• Example: Customer has successfully submitted an export declaration. Customs has received the export declaration message, but has found errors in the data. Customs send a message that contains a list of validation errors back to Eurora. Get declaration messages endpoint must be used to receive validation errors found by customs. Based on this feedback from customs, customer makes corrections in export declaration data and re-submits the declaration.

Get export declaration (GET)

• URL: https://api.eurora.com/customs-export/v1/declaration/messages/{id}

• API documentation: https://api.eurora.com/customs-export-external-v1#operation/getExportDeclarationMessages

• Purpose: Request detailed declaration data after it is successfully sent to Eurora system.

• When to use: This endpoint is used to receive all of the data of an export declaration stored in Eurora system including LRN number generated by Eurora and MRN number given by Customs.

• Example: Customer has requested declaration status (by using “Get export declaration messages” endpoint) and received information that given export declaration has been accepted by Customs (Declaration status is E_ACCEPTED). Get export declaration endpoint must be used to receive the MRN number that is assigned to given export declaration by Customs.

Cancelling export declaration

Cancel export declaration (POST)

• URL: https://api.eurora.com/customs-export/v1/declaration/cancel

• API documentation: https://api.eurora.com/customs-export-external-v1#operation/cancelExportDeclaration

• Purpose: This endpoint allows to cancel an export declaration. Existing declaration can be cancelled if the declaration has not been sent to Customs (Declaration status is DRAFT, INCOMPLETE , SUBMITTED_TECHNICAL_ERROR, E_VALIDATION_NOT_OK) or when declaration is already sent to Customs (Declaration status is E_ACCEPTED, E_GOODS_RELEASED, E_UNKNOWN, E_CANCELLATION_REJECTED). In the latter case, export declaration is cancelled when the request is accepted by Customs.

• When to use: This endpoint is used to cancel erroneous export declarations or to request stopping further export procedures after the export declaration has been submitted to Customs.

• Example: The consignee decides to cancel the export declaration after the goods have been already released for export by Customs. Cancel declaration endpoint must be used to send a cancellation request to Customs.

API Documentation