Skip to content
Interu API Reference/
/
Retrieve DDS Reference Li...

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

Create DDS Reference

Request

Creates an EUDR DDS Reference.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
typestringrequired

This is the type of the DDS Reference. If you are generating a new DDS Reference then set this to NEW.

Enum"NEW""EXISTING"
Discriminator
statementDataobject

If creating a NEW Due Diligence Statement then this field is required.

sourceDataCreate_DDS_From_Products (object) or Create_DDS_From_Other (object)required

The source data items to base the DDS Statement on.

Any of:

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

sourceData.​sourceResourceTypestringrequired

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

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

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

sourceData.​products[].​uristring(uri)required

This is the source product URI.

sourceData.​products[].​totalQuantitynumber(decimal)required

This is the quantity to create the DDS for.

internalReferenceNumberstring

An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/extensions/eudr/references' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "type": "NEW",
    "statementData": {
      "operatorType": "OPERATOR",
      "activityType": "IMPORT",
      "countryOfActivity": "AT",
      "borderCrossCountry": "AT",
      "comment": "string",
      "geoLocationConfidential": true,
      "associatedStatements": [
        {
          "referenceNumber": "string",
          "verificationNumber": "string"
        }
      ]
    },
    "sourceData": {
      "sourceResourceType": "PRODUCT",
      "products": [
        {
          "uri": "/organisations/{orgId}/products/{productId}",
          "totalQuantity": 0
        }
      ]
    },
    "internalReferenceNumber": "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
internalReferenceNumberstring

An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field.

referenceNumberstring

The Reference Number as provided by TracesNT.

verificationNumberstring

The Verification Number provided by Traces NT. It is required if you want to reference the related DDS Statement in another DDS Statement.

hasStatementboolean

True if there is a DDS Statement associated with this reference number. This happens if it is generated or if there is a Reference Number and Validation Number and the Statement can be retrieved from Traces.

statusstring

The status of the Due Diligence Statement.

Enum"PENDING""SUBMITTED""AVAILABLE""REJECTED""CANCELLED""WITHDRAWN""ARCHIVED"
operatorUristringrequired

This is the url of the organisation or connection from which the credentials will be used for submission or retrieval of DDS Statements with Traces NT.

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
{
  "internalReferenceNumber": "string",
  "referenceNumber": "string",
  "verificationNumber": "string",
  "hasStatement": true,
  "status": "PENDING",
  "operatorUri": "string",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Retrieve DDS Reference List

Request

Gets the list of DDS References.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
internalReferencestring

The internal reference number for the DDS Reference.

statusstring(Integrations.Eudr.DDSStatus)

Get the DDS references with the provided status.

Enum"PENDING""SUBMITTED""AVAILABLE""REJECTED""CANCELLED""WITHDRAWN""ARCHIVED"
sourceResourceTypestring(Integrations.Eudr.SourceResourceType)required

This is the resource type of the source.

Enum"DELIVERY""ITEM""PRODUCT""PURCHASE_ORDER"
sizeinteger(int32)>= 1

The number of elements to return in each page. Minimum value must be 1, defaults to 20.

Default 20
pageinteger(int32)>= 0

The pageNo to return. (Zero-based)

Default 0
curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/extensions/eudr/references?internalReference=string&status=PENDING&sourceResourceType=DELIVERY&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Integrations.Eudr.DDSReference)required
content[].​internalReferenceNumberstring

An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field.

content[].​referenceNumberstring

The Reference Number as provided by TracesNT.

content[].​verificationNumberstring

The Verification Number provided by Traces NT. It is required if you want to reference the related DDS Statement in another DDS Statement.

content[].​hasStatementboolean

True if there is a DDS Statement associated with this reference number. This happens if it is generated or if there is a Reference Number and Validation Number and the Statement can be retrieved from Traces.

content[].​statusstring

The status of the Due Diligence Statement.

Enum"PENDING""SUBMITTED""AVAILABLE""REJECTED""CANCELLED""WITHDRAWN""ARCHIVED"
content[].​operatorUristringrequired

This is the url of the organisation or connection from which the credentials will be used for submission or retrieval of DDS Statements with Traces NT.

content[].​idstring

System assigned id field.

content[].​createdBystring

User who created the record.

content[].​createdTimestring(date-time)

Date & Time that the record was created.

content[].​updatedBystring

Last updated by user.

content[].​updatedTimestring(date-time)

Date & Time that the record was last updated.

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
  }
}

Find DDS Reference

Request

Finds DDS Reference for provided record ids.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
recordUrisArray of strings

The list of Record Uris to look for the DDS Reference for.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/extensions/eudr/references/find' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "recordUris": [
      "/organisations/{orgId}/deliveries/{deliveryId}"
    ]
  }'

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/jsonArray [
recordUristring(uri)required

This is the URI of the the record - i.e the Delivery or the Purchase Order.

referencesArray of objects(Integrations.Eudr.DDSReferenceDetail)

The found Due Diligence Statement References. This will only be present if References were found.

]
Response
application/json
[
  {
    "recordUri": "/organisations/{orgId}/purchase-orders/{purchaseOrderId}",
    "references": [ … ]
  }
]

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.