Skip to content
Interu API Reference/
/
Retrieve Send Record List

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

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

Send Record

Request

Send a record to a counterparty.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
receiverUristring(uri)required

The URI for the connection that you want to share the record with.

rootRecordUristring(uri)required

The URI for the main record to be shared with the counterparty.

recordUrisArray of strings

The URI of other records to include in the send.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/record-sharing/outbound/shares' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "receiverUri": "/organisations/{orgId}/connections/{connectionId}",
    "rootRecordUri": "/organisations/{orgId}/purchase-orders/{purchaseOrderId}",
    "recordUris": [
      "/organisations/{orgId}/products/{productId}"
    ]
  }'

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

receiverUristring(uri)required

The URI for the connection that you want to share the record with.

rootRecordUristring(uri)required

The URI for the main record to be shared with the counterparty.

recordUrisArray of strings

The URI of other records to include in the send.

Response
application/json
{
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z",
  "receiverUri": "/organisations/{orgId}/connections/{connectionId}",
  "rootRecordUri": "/organisations/{orgId}/purchase-orders/{purchaseOrderId}",
  "recordUris": [
    "/organisations/{orgId}/products/{productId}"
  ]
}

Retrieve Send Record List

Request

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
receiverUristring

The receiver Uri.

rootRecordUristring

The root record to search for.

curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/record-sharing/outbound/shares?receiverUri=string&rootRecordUri=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/jsonArray [
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.

receiverUristring(uri)required

The URI for the connection that you want to share the record with.

rootRecordUristring(uri)required

The URI for the main record to be shared with the counterparty.

recordUrisArray of strings

The URI of other records to include in the send.

]
Response
application/json
[
  {
    "id": "string",
    "createdBy": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "updatedTime": "2019-08-24T14:15:22Z",
    "receiverUri": "/organisations/{orgId}/connections/{connectionId}",
    "rootRecordUri": "/organisations/{orgId}/purchase-orders/{purchaseOrderId}",
    "recordUris": [ … ]
  }
]

Retrieve Send Record

Request

Send a record to a counterparty.

Security
ApiKeyAuth
Path
outboundShareIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/record-sharing/outbound/shares/{outboundShareId}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
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.

receiverUristring(uri)required

The URI for the connection that you want to share the record with.

rootRecordUristring(uri)required

The URI for the main record to be shared with the counterparty.

recordUrisArray of strings

The URI of other records to include in the send.

Response
application/json
{
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z",
  "receiverUri": "/organisations/{orgId}/connections/{connectionId}",
  "rootRecordUri": "/organisations/{orgId}/purchase-orders/{purchaseOrderId}",
  "recordUris": [
    "/organisations/{orgId}/products/{productId}"
  ]
}
Copyright © iov42 Limited.