Skip to content
/Products

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

Materials

Apis related to Materials.

Operations

Products

Apis related to Products.

Operations

Create ProductUDID

Request

Add a new product.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
namestringrequired

The name for the product.

hsCodestring

This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system.

descriptionstring

This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system.

allowedMaterialsArray of stringsrequired

The URI(s) of the material(s) that are allowed to be used for this product.

baseUnitstring(uri)required

The URI to the base unit of measurement that this product is specified in.

defaultUnitstring(uri)

The URI to the unit of measurement that you wish to use as the default unit of measurement.

additionalUnitsArray of objects(Static.AdditionalUnit)required

A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg

additionalUnits[].​baseUnitstring(uri)required

The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.

additionalUnits[].​conversionFactornumber(decimal)required

The conversion factor from product base unit to conversion base unit.

idstring

System assigned or user defined id field.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/products' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "name": "string",
    "hsCode": "string",
    "description": "string",
    "allowedMaterials": [
      "/organisations/{orgId}/materials/{materialId}"
    ],
    "baseUnit": "/common/base-units/{unitId}",
    "defaultUnit": "/common/base-units/{unitId}",
    "additionalUnits": [
      {
        "baseUnit": "/common/base-units/{unitId}",
        "conversionFactor": 0
      }
    ],
    "id": "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
namestringrequired

The name for the product.

hsCodestring

This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system.

descriptionstring

This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system.

allowedMaterialsArray of stringsrequired

The URI(s) of the material(s) that are allowed to be used for this product.

baseUnitstring(uri)required

The URI to the base unit of measurement that this product is specified in.

defaultUnitstring(uri)

The URI to the unit of measurement that you wish to use as the default unit of measurement.

additionalUnitsArray of objects(Static.AdditionalUnit)required

A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg

additionalUnits[].​baseUnitstring(uri)required

The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.

additionalUnits[].​conversionFactornumber(decimal)required

The conversion factor from product base unit to conversion base unit.

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",
  "hsCode": "string",
  "description": "string",
  "allowedMaterials": [
    "/organisations/{orgId}/materials/{materialId}"
  ],
  "baseUnit": "/common/base-units/{unitId}",
  "defaultUnit": "/common/base-units/{unitId}",
  "additionalUnits": [
    { … }
  ],
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Retrieve Product List

Request

Gets the list of products.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
namestring
materialstring
categorystring
baseUnitstring(uri)
baseUnitTypestring(Common.Enums.BaseUnitType)
Enum"VOLUME""AREA""LENGTH""MASS""UNITS"
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}/products?name=string&material=string&category=string&baseUnit=http%3A%2F%2Fexample.com&baseUnitType=VOLUME&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.Product)required
content[].​namestringrequired

The name for the product.

content[].​hsCodestring

This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system.

content[].​descriptionstring

This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system.

content[].​allowedMaterialsArray of stringsrequired

The URI(s) of the material(s) that are allowed to be used for this product.

content[].​baseUnitstring(uri)required

The URI to the base unit of measurement that this product is specified in.

content[].​defaultUnitstring(uri)

The URI to the unit of measurement that you wish to use as the default unit of measurement.

content[].​additionalUnitsArray of objects(Static.AdditionalUnit)required

A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg

content[].​additionalUnits[].​baseUnitstring(uri)required

The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.

content[].​additionalUnits[].​conversionFactornumber(decimal)required

The conversion factor from product base unit to conversion base unit.

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 Product

Request

Retrieve an existing product.

Security
ApiKeyAuth
Path
productIdstringrequired
orgIdstringrequired

The organisation identity

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

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name for the product.

hsCodestring

This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system.

descriptionstring

This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system.

allowedMaterialsArray of stringsrequired

The URI(s) of the material(s) that are allowed to be used for this product.

baseUnitstring(uri)required

The URI to the base unit of measurement that this product is specified in.

defaultUnitstring(uri)

The URI to the unit of measurement that you wish to use as the default unit of measurement.

additionalUnitsArray of objects(Static.AdditionalUnit)required

A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg

additionalUnits[].​baseUnitstring(uri)required

The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.

additionalUnits[].​conversionFactornumber(decimal)required

The conversion factor from product base unit to conversion base unit.

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",
  "hsCode": "string",
  "description": "string",
  "allowedMaterials": [
    "/organisations/{orgId}/materials/{materialId}"
  ],
  "baseUnit": "/common/base-units/{unitId}",
  "defaultUnit": "/common/base-units/{unitId}",
  "additionalUnits": [
    { … }
  ],
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

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.