Skip to content
Interu API Reference/
/
Retrieve Location

Interu API (v2_28)

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

Retrieve Location List

Request

Gets the list of locations.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
namestring
countryCodesArray of strings
typeIdsArray of strings
recordStatestring(Common.Enums.RecordState)
Enum"ACTIVE""ARCHIVED"
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}/locations?name=string&countryCodes=string&typeIds=string&recordState=ACTIVE&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Static.Location)required
content[].​namestringrequired

The name of the location/site.

content[].​typesArray of stringsrequired

The URI(s) of the type(s) of the location/site.

content[].​addressobjectrequired
content[].​address.​streetstring

The mainline of the address.

content[].​address.​regionstring

Region of the address.

content[].​address.​zipCodestring

Zip/postal code for the address.

content[].​address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
content[].​recordStatestring
Enum"ACTIVE""ARCHIVED"
content[].​idstring

System assigned or user defined 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
  }
}

Retrieve Location

Request

Retrieves an existing location.

Security
ApiKeyAuth
Path
locationIdstringrequired
orgIdstringrequired

The organisation identity

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

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name of the location/site.

typesArray of stringsrequired

The URI(s) of the type(s) of the location/site.

addressobjectrequired
address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
recordStatestring
Enum"ACTIVE""ARCHIVED"
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",
  "types": [
    "/organisations/{orgId}/location-types/{locationTypeId}"
  ],
  "address": {
    "street": "string",
    "region": "string",
    "zipCode": "string",
    "country": "AF"
  },
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Update Location

Request

Updates an existing location.

Security
ApiKeyAuth
Path
locationIdstringrequired
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
namestringrequired

The name of the location/site.

typesArray of stringsrequired

The URI(s) of the type(s) of the location/site.

addressobjectrequired
address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
curl -i -X PUT \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/locations/{locationId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "name": "string",
    "types": [
      "/organisations/{orgId}/location-types/{locationTypeId}"
    ],
    "address": {
      "street": "string",
      "region": "string",
      "zipCode": "string",
      "country": "AF"
    }
  }'

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name of the location/site.

typesArray of stringsrequired

The URI(s) of the type(s) of the location/site.

addressobjectrequired
address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
recordStatestring
Enum"ACTIVE""ARCHIVED"
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",
  "types": [
    "/organisations/{orgId}/location-types/{locationTypeId}"
  ],
  "address": {
    "street": "string",
    "region": "string",
    "zipCode": "string",
    "country": "AF"
  },
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

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
Copyright © iov42 Limited.