Skip to content
Interu API Reference/
/
Retrieve Source Data Refe...

Interu API (v2_31)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server
https://developer.interu.io/_mock/reference/api
UAT
https://api.uat.interu.io

Validation

Apis related to Validation.

Operations

Base Units

Apis related to Base Units.

Operations

Country List

Apis related to Country List.

Operations

Standards

Apis related to Standards.

Operations

Document Types

Apis related to Document Types.

Operations

Location Types

Apis related to Location Types.

Operations

Process Types

Apis related to Process Types.

Operations

Attachments

Apis related to Attachments.

Operations

Documents

Apis related to Documents.

Operations

EUDR

Apis related to EUDR and Due Diligence Statement Submission.

Operations

Retrieve Direct Records

Request

Gets the list of DDS Reference Direct Records.

Security
ApiKeyAuth
Path
referenceIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of stringsrequired
pageobject(iov42.Core.Paging.Page)required
page.​sizeinteger(int32)required
page.​pageinteger(int32)required
page.​totalElementsinteger(int32)required
page.​totalPagesinteger(int32)required
Response
application/json
{
  "content": [
    [ … ]
  ],
  "page": {
    "size": 0,
    "page": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

Retrieve Source Data References

Request

Retrieve Source Data for references

Security
ApiKeyAuth
Path
referenceIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/extensions/eudr/references/{referenceId}/source-data' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
Any of:

Create a DDS from a product. Requires the specification of a quantity to create.

sourceResourceTypestringrequired

This is the resource type of the source. Note that for create a Product DDS this can only be PRODUCT

Value"PRODUCT"
productsArray of objects(Integrations.Eudr.ProductQuantity)<= 100 itemsrequired

This is information on the products to generate a DDS for.

products[].​uristring(uri)required

This is the source product URI.

products[].​totalQuantitynumber(decimal)required

This is the quantity to create the DDS for.

Response
application/json
{
  "sourceResourceType": "PRODUCT",
  "products": [
    { … }
  ]
}

Generate DDS Statement

Request

Creates a Due Diligence Statement based on the provided parameters and the attached records.

Security
ApiKeyAuth
Path
referenceIdstringrequired
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
operatorTypestring(Integrations.Eudr.OperatorType)
Value"OPERATOR"
activityTypestring

The activity type.

Enum"IMPORT""EXPORT""DOMESTIC"
countryOfActivitystring

This is the country where the economic activity is taking place, typically (but not always) this is the operator's place of activity.

Enum"AT""BE""BG""HR""CY""CZ""DK""EE""FI""FR"
borderCrossCountrystring

This is required for IMPORT or EXPORT activities.

Enum"AT""BE""BG""HR""CY""CZ""DK""EE""FI""FR"
commentstring
geoLocationConfidentialboolean

IF this is set to true then downstream consumers of your DDS Reference will not have access to the Geo Location information.

associatedStatementsArray of objects(Integrations.Eudr.AssociatedStatement)
curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "operatorType": "OPERATOR",
    "activityType": "IMPORT",
    "countryOfActivity": "AT",
    "borderCrossCountry": "AT",
    "comment": "string",
    "geoLocationConfidential": true,
    "associatedStatements": [
      {
        "referenceNumber": "string",
        "verificationNumber": "string"
      }
    ]
  }'

Responses

The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.

Headers
Locationstring

Location of the created resource

Bodyapplication/json
versionintegerrequired
operatorTypestring(Integrations.Eudr.OperatorType)
Value"OPERATOR"
activityTypestring

The activity type.

Enum"IMPORT""EXPORT""DOMESTIC"
countryOfActivitystring

This is the country where the economic activity is taking place, typically (but not always) this is the operator's place of activity.

Enum"AT""BE""BG""HR""CY""CZ""DK""EE""FI""FR"
borderCrossCountrystring

This is required for IMPORT or EXPORT activities.

Enum"AT""BE""BG""HR""CY""CZ""DK""EE""FI""FR"
commoditiesArray of objects(Integrations.Eudr.Commodity)
commentstring
geoLocationConfidentialboolean

IF this is set to true then downstream consumers of your DDS Reference will not have access to the Geo Location information.

associatedStatementsArray of objects(Integrations.Eudr.AssociatedStatement)
idstring

System assigned id field.

createdBystring

User who created the record.

createdTimestring(date-time)

Date & Time that the record was created.

updatedBystring

Last updated by user.

updatedTimestring(date-time)

Date & Time that the record was last updated.

Response
application/json
{
  "version": 0,
  "operatorType": "OPERATOR",
  "activityType": "IMPORT",
  "countryOfActivity": "AT",
  "borderCrossCountry": "AT",
  "commodities": [
    { … }
  ],
  "comment": "string",
  "geoLocationConfidential": true,
  "associatedStatements": [
    { … }
  ],
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Connections

Apis related to Connections.

Operations

Locations

Apis related to Locations.

Operations

Materials

Apis related to Materials.

Operations

Products

Apis related to Products.

Operations

Deliveries

Apis related to Deliveries.

Operations

Items

Apis related to Items.

Operations

Orders

Apis related to Orders.

Operations

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations

Order Workflow

Operations

Sending Outbound

Operations
Copyright © iov42 Limited.