Skip to content
Interu API Reference/
/
Update Connection

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

Connections

Apis related to Connections.

Operations

Retrieve Connection

Request

Retrieve an existing connection.

Security
ApiKeyAuth
Path
connectionIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/connections/{connectionId}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name of the connected organisation.

publicUristring

This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up.

parentUristring

If this connection is actually part of your group of companies then this should point to your organisation URI.

websitestring

The corporate website for this organisation.

emailstring

Contact email address for the organisation.

addressobjectrequired

The address of the corporate headquarters.

address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired

Alpha-2 code of the ISO 3166 Country Codes specification.

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
connectStatusstringrequired

This is the status of connection to the organisation. In order to send records to or receive record from an organisation the two organisations must be connected.

Enum"CONNECTED""DISCONNECTED"
connectStatusUpdatedTimestring(date-time)

The time and date when the connection status was updated.

idstring

System assigned or user defined 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
{
  "name": "string",
  "publicUri": "string",
  "parentUri": "string",
  "website": "string",
  "email": "string",
  "address": {
    "street": "string",
    "region": "string",
    "zipCode": "string",
    "country": "AF"
  },
  "connectStatus": "CONNECTED",
  "connectStatusUpdatedTime": "2019-08-24T14:15:22Z",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Update Connection

Request

Update the details of an existing connection.

Security
ApiKeyAuth
Path
connectionIdstringrequired
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
namestringrequired

The name of the connected organisation.

publicUristring

This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up.

parentUristring

If this connection is actually part of your group of companies then this should point to your organisation URI.

websitestring

The corporate website for this organisation.

emailstring

Contact email address for the organisation.

addressobjectrequired

The address of the corporate headquarters.

address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired

Alpha-2 code of the ISO 3166 Country Codes specification.

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
curl -i -X PUT \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/connections/{connectionId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "name": "string",
    "publicUri": "string",
    "parentUri": "string",
    "website": "string",
    "email": "string",
    "address": {
      "street": "string",
      "region": "string",
      "zipCode": "string",
      "country": "AF"
    }
  }'

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name of the connected organisation.

publicUristring

This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up.

parentUristring

If this connection is actually part of your group of companies then this should point to your organisation URI.

websitestring

The corporate website for this organisation.

emailstring

Contact email address for the organisation.

addressobjectrequired

The address of the corporate headquarters.

address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired

Alpha-2 code of the ISO 3166 Country Codes specification.

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
connectStatusstringrequired

This is the status of connection to the organisation. In order to send records to or receive record from an organisation the two organisations must be connected.

Enum"CONNECTED""DISCONNECTED"
connectStatusUpdatedTimestring(date-time)

The time and date when the connection status was updated.

idstring

System assigned or user defined 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
{
  "name": "string",
  "publicUri": "string",
  "parentUri": "string",
  "website": "string",
  "email": "string",
  "address": {
    "street": "string",
    "region": "string",
    "zipCode": "string",
    "country": "AF"
  },
  "connectStatus": "CONNECTED",
  "connectStatusUpdatedTime": "2019-08-24T14:15:22Z",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Delete Connection

Request

Delete an existing connection.

Security
ApiKeyAuth
Path
connectionIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X DELETE \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/connections/{connectionId}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

There is no content to send for this request, but the headers may be useful.

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.