Skip to content
/Items

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

Deliveries

Apis related to Deliveries.

Operations

Items

Apis related to Items.

Operations

Create ItemUDID

Request

Add a stock item to the system.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
itemIdstringrequired

User defined id for the item.

productstring(uri)required

URI for the product that the item is.

createdAtLocationstring(uri)required

URI for the location where the product was created.

materialsArray of strings

List of material URIs that are used within the item.

currentLocationstring(uri)required

URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).

createdobjectrequired
created.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
created.​onstring(date-time)

If Type is EXACT then this precise date is used.

created.​startstring(date-time)

If type is RANGE then this is the start date.

created.​endstring(date-time)

If type is RANGE then this is the end date.

initialQuantitynumber(decimal)required

This quantity contained within this item at the point when it was created.

additionalInitialQuantitiesArray of objects(Transactional.AdditionalQuantity)required

Additiononal quantities can be specified directly on the item.

additionalInitialQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

additionalInitialQuantities[].​conversionQuantitynumber(decimal)required

The additional quantity calculated if the product has a conversion to that base unit.

additionalInitialQuantities[].​overrideQuantitynumber(decimal)required

An override quantity provided irrespective of whether or not there is a conversion on the product.

remainingQuantitynumber(decimal)

If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process.

productVariantstring(uri)

The uri of the product variant if applicable to this item.

batchNumbersArray of strings

If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers.

idstring

System assigned or user defined id field.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/items' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "itemId": "string",
    "product": "/organisations/{orgId}/products/{productId}",
    "createdAtLocation": "/organisations/{orgId}/locations/{locationId}",
    "materials": [
      "/organisations/{orgId}/materials/{materialId}"
    ],
    "currentLocation": "/organisations/{orgId}/locations/{locationId}",
    "created": {
      "type": "EXACT",
      "on": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z"
    },
    "initialQuantity": 0,
    "additionalInitialQuantities": [
      {
        "baseUnit": "string",
        "conversionQuantity": 0,
        "overrideQuantity": 0
      }
    ],
    "remainingQuantity": 0,
    "productVariant": "/organisations/{orgId}/products/{productId}/variants/{variantId}",
    "batchNumbers": [
      "string"
    ],
    "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
itemIdstringrequired

User defined id for the item.

productstring(uri)required

URI for the product that the item is.

createdAtLocationstring(uri)required

URI for the location where the product was created.

materialsArray of strings

List of material URIs that are used within the item.

currentLocationstring(uri)required

URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).

createdobjectrequired
created.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
created.​onstring(date-time)

If Type is EXACT then this precise date is used.

created.​startstring(date-time)

If type is RANGE then this is the start date.

created.​endstring(date-time)

If type is RANGE then this is the end date.

initialQuantitynumber(decimal)required

This quantity contained within this item at the point when it was created.

additionalInitialQuantitiesArray of objects(Transactional.AdditionalQuantity)required

Additiononal quantities can be specified directly on the item.

additionalInitialQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

additionalInitialQuantities[].​conversionQuantitynumber(decimal)required

The additional quantity calculated if the product has a conversion to that base unit.

additionalInitialQuantities[].​overrideQuantitynumber(decimal)required

An override quantity provided irrespective of whether or not there is a conversion on the product.

remainingQuantitynumber(decimal)

If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process.

productVariantstring(uri)

The uri of the product variant if applicable to this item.

batchNumbersArray of strings

If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers.

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
{
  "itemId": "string",
  "product": "/organisations/{orgId}/products/{productId}",
  "createdAtLocation": "/organisations/{orgId}/locations/{locationId}",
  "materials": [
    "/organisations/{orgId}/materials/{materialId}"
  ],
  "currentLocation": "/organisations/{orgId}/locations/{locationId}",
  "created": {
    "type": "EXACT",
    "on": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "initialQuantity": 0,
  "additionalInitialQuantities": [
    { … }
  ],
  "remainingQuantity": 0,
  "productVariant": "/organisations/{orgId}/products/{productId}/variants/{variantId}",
  "batchNumbers": [
    "string"
  ],
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Retrieve Item List

Request

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
currentLocationstring

Find items that have the provided location.

itemIdstring

Find item with the given item id.

productIdsArray of strings

Find items that have the given product ids.

createdAtLocationIdsArray of strings

Find items that where created at the provided locations.

currentLocationIdsArray of strings

Find items that are at the current location.

recordStatestring(Common.Enums.RecordState)
Enum"ACTIVE""ARCHIVED"
batchNumbersArray of strings

Find any items that have the provided batch numbers.

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}/items?currentLocation=string&itemId=string&productIds=string&createdAtLocationIds=string&currentLocationIds=string&recordState=ACTIVE&batchNumbers=string&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Transactional.Item)required
content[].​itemIdstringrequired

User defined id for the item.

content[].​productstring(uri)required

URI for the product that the item is.

content[].​createdAtLocationstring(uri)required

URI for the location where the product was created.

content[].​materialsArray of strings

List of material URIs that are used within the item.

content[].​currentLocationstring(uri)required

URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).

content[].​createdobjectrequired
content[].​created.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
content[].​created.​onstring(date-time)

If Type is EXACT then this precise date is used.

content[].​created.​startstring(date-time)

If type is RANGE then this is the start date.

content[].​created.​endstring(date-time)

If type is RANGE then this is the end date.

content[].​initialQuantitynumber(decimal)required

This quantity contained within this item at the point when it was created.

content[].​additionalInitialQuantitiesArray of objects(Transactional.AdditionalQuantity)required

Additiononal quantities can be specified directly on the item.

content[].​additionalInitialQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

content[].​additionalInitialQuantities[].​conversionQuantitynumber(decimal)required

The additional quantity calculated if the product has a conversion to that base unit.

content[].​additionalInitialQuantities[].​overrideQuantitynumber(decimal)required

An override quantity provided irrespective of whether or not there is a conversion on the product.

content[].​remainingQuantitynumber(decimal)

If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process.

content[].​productVariantstring(uri)

The uri of the product variant if applicable to this item.

content[].​batchNumbersArray of strings

If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers.

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 Item

Request

Security
ApiKeyAuth
Path
itemIdstringrequired
orgIdstringrequired

The organisation identity

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

Responses

The request has succeeded.

Bodyapplication/json
itemIdstringrequired

User defined id for the item.

productstring(uri)required

URI for the product that the item is.

createdAtLocationstring(uri)required

URI for the location where the product was created.

materialsArray of strings

List of material URIs that are used within the item.

currentLocationstring(uri)required

URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).

createdobjectrequired
created.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
created.​onstring(date-time)

If Type is EXACT then this precise date is used.

created.​startstring(date-time)

If type is RANGE then this is the start date.

created.​endstring(date-time)

If type is RANGE then this is the end date.

initialQuantitynumber(decimal)required

This quantity contained within this item at the point when it was created.

additionalInitialQuantitiesArray of objects(Transactional.AdditionalQuantity)required

Additiononal quantities can be specified directly on the item.

additionalInitialQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

additionalInitialQuantities[].​conversionQuantitynumber(decimal)required

The additional quantity calculated if the product has a conversion to that base unit.

additionalInitialQuantities[].​overrideQuantitynumber(decimal)required

An override quantity provided irrespective of whether or not there is a conversion on the product.

remainingQuantitynumber(decimal)

If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process.

productVariantstring(uri)

The uri of the product variant if applicable to this item.

batchNumbersArray of strings

If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers.

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
{
  "itemId": "string",
  "product": "/organisations/{orgId}/products/{productId}",
  "createdAtLocation": "/organisations/{orgId}/locations/{locationId}",
  "materials": [
    "/organisations/{orgId}/materials/{materialId}"
  ],
  "currentLocation": "/organisations/{orgId}/locations/{locationId}",
  "created": {
    "type": "EXACT",
    "on": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "initialQuantity": 0,
  "additionalInitialQuantities": [
    { … }
  ],
  "remainingQuantity": 0,
  "productVariant": "/organisations/{orgId}/products/{productId}/variants/{variantId}",
  "batchNumbers": [
    "string"
  ],
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Orders

Apis related to Orders.

Operations

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations
Copyright © iov42 Limited.