Skip to content
/Orders

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

Orders

Apis related to Orders.

Operations

Create Purchase OrderUDID

Request

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
numberstringrequired

The purchase order number.

statusstringrequired
Enum"OPEN""APPROVED""COMPLETED""CANCELLED"
orderDatestring(date-time)

The date and time of the purchase order.

expectedDeliveryDatestring(date-time)

The date and time the delivery is expected to .

supplierstring(uri)

The URI of the supplier.

buyerstring(uri)

The URI of the buyer.

deliverToLocationstring(uri)

The URI of the deliver to location.

lineItemsArray of objects(Transactional.PurchaseOrderItem)required

List of items included in the purchase order.

lineItems[].​lineItemIdstring

An optional line item id.

lineItems[].​productstring(uri)required

The URI of the product for the line item included in the purchase order.

lineItems[].​quantitynumber(decimal)required

The quantity of the product included in the purchase order.

lineItems[].​notestring

A note for each line item.

lineItems[].​productVariantstring(uri)

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

lineItems[].​additionalQuantitiesArray of objects(Transactional.AdditionalQuantity)required

Additiononal quantities can be specified directly on the item.

lineItems[].​additionalQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

lineItems[].​additionalQuantities[].​conversionQuantitynumber(decimal)required

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

lineItems[].​additionalQuantities[].​overrideQuantitynumber(decimal)required

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

notestring

A note to pass any information.

idstring

System assigned or user defined id field.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/purchase-orders' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "number": "string",
    "status": "OPEN",
    "orderDate": "2019-08-24T14:15:22Z",
    "expectedDeliveryDate": "2019-08-24T14:15:22Z",
    "supplier": "/organisations/{orgId}/connections/{connectionId}",
    "buyer": "/organisations/{orgId}/connections/{connectionId}",
    "deliverToLocation": "/organisations/{orgId}/locations/{locationId}",
    "lineItems": [
      {
        "lineItemId": "string",
        "product": "/organisations/{orgId}/products/{productId}",
        "quantity": 0,
        "note": "string",
        "productVariant": "/organisations/{orgId}/products/{productId}/variants/{variantId}",
        "additionalQuantities": [
          {
            "baseUnit": "string",
            "conversionQuantity": 0,
            "overrideQuantity": 0
          }
        ]
      }
    ],
    "note": "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
numberstringrequired

The purchase order number.

statusstringrequired
Enum"OPEN""APPROVED""COMPLETED""CANCELLED"
orderDatestring(date-time)

The date and time of the purchase order.

expectedDeliveryDatestring(date-time)

The date and time the delivery is expected to .

supplierstring(uri)

The URI of the supplier.

buyerstring(uri)

The URI of the buyer.

deliverToLocationstring(uri)

The URI of the deliver to location.

lineItemsArray of objects(Transactional.PurchaseOrderItem)required

List of items included in the purchase order.

lineItems[].​lineItemIdstring

An optional line item id.

lineItems[].​productstring(uri)required

The URI of the product for the line item included in the purchase order.

lineItems[].​quantitynumber(decimal)required

The quantity of the product included in the purchase order.

lineItems[].​notestring

A note for each line item.

lineItems[].​productVariantstring(uri)

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

lineItems[].​additionalQuantitiesArray of objects(Transactional.AdditionalQuantity)required

Additiononal quantities can be specified directly on the item.

lineItems[].​additionalQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

lineItems[].​additionalQuantities[].​conversionQuantitynumber(decimal)required

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

lineItems[].​additionalQuantities[].​overrideQuantitynumber(decimal)required

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

notestring

A note to pass any information.

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
{
  "number": "string",
  "status": "OPEN",
  "orderDate": "2019-08-24T14:15:22Z",
  "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  "supplier": "/organisations/{orgId}/connections/{connectionId}",
  "buyer": "/organisations/{orgId}/connections/{connectionId}",
  "deliverToLocation": "/organisations/{orgId}/locations/{locationId}",
  "lineItems": [
    { … }
  ],
  "note": "string",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Retrieve Purchase Order List

Request

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
numberArray of strings
supplierUrisArray of strings
buyerUrisArray of strings
deliverToLocationIdsArray of strings
productIdsArray of strings
recordStatestring(Common.Enums.RecordState)
Enum"ACTIVE""ARCHIVED"
statusArray of strings(Transactional.PurchaseOrderStatus)
Items Enum"OPEN""APPROVED""COMPLETED""CANCELLED"
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}/purchase-orders?number=string&supplierUris=string&buyerUris=string&deliverToLocationIds=string&productIds=string&recordState=ACTIVE&status=OPEN&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Transactional.PurchaseOrder)required
content[].​numberstringrequired

The purchase order number.

content[].​statusstringrequired
Enum"OPEN""APPROVED""COMPLETED""CANCELLED"
content[].​orderDatestring(date-time)

The date and time of the purchase order.

content[].​expectedDeliveryDatestring(date-time)

The date and time the delivery is expected to .

content[].​supplierstring(uri)

The URI of the supplier.

content[].​buyerstring(uri)

The URI of the buyer.

content[].​deliverToLocationstring(uri)

The URI of the deliver to location.

content[].​lineItemsArray of objects(Transactional.PurchaseOrderItem)required

List of items included in the purchase order.

content[].​lineItems[].​lineItemIdstring

An optional line item id.

content[].​lineItems[].​productstring(uri)required

The URI of the product for the line item included in the purchase order.

content[].​lineItems[].​quantitynumber(decimal)required

The quantity of the product included in the purchase order.

content[].​lineItems[].​notestring

A note for each line item.

content[].​lineItems[].​productVariantstring(uri)

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

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

Additiononal quantities can be specified directly on the item.

content[].​lineItems[].​additionalQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

content[].​lineItems[].​additionalQuantities[].​conversionQuantitynumber(decimal)required

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

content[].​lineItems[].​additionalQuantities[].​overrideQuantitynumber(decimal)required

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

content[].​notestring

A note to pass any information.

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 Purchase Order

Request

Security
ApiKeyAuth
Path
purchaseOrderIdstringrequired
orgIdstringrequired

The organisation identity

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

Responses

The request has succeeded.

Bodyapplication/json
numberstringrequired

The purchase order number.

statusstringrequired
Enum"OPEN""APPROVED""COMPLETED""CANCELLED"
orderDatestring(date-time)

The date and time of the purchase order.

expectedDeliveryDatestring(date-time)

The date and time the delivery is expected to .

supplierstring(uri)

The URI of the supplier.

buyerstring(uri)

The URI of the buyer.

deliverToLocationstring(uri)

The URI of the deliver to location.

lineItemsArray of objects(Transactional.PurchaseOrderItem)required

List of items included in the purchase order.

lineItems[].​lineItemIdstring

An optional line item id.

lineItems[].​productstring(uri)required

The URI of the product for the line item included in the purchase order.

lineItems[].​quantitynumber(decimal)required

The quantity of the product included in the purchase order.

lineItems[].​notestring

A note for each line item.

lineItems[].​productVariantstring(uri)

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

lineItems[].​additionalQuantitiesArray of objects(Transactional.AdditionalQuantity)required

Additiononal quantities can be specified directly on the item.

lineItems[].​additionalQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

lineItems[].​additionalQuantities[].​conversionQuantitynumber(decimal)required

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

lineItems[].​additionalQuantities[].​overrideQuantitynumber(decimal)required

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

notestring

A note to pass any information.

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
{
  "number": "string",
  "status": "OPEN",
  "orderDate": "2019-08-24T14:15:22Z",
  "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  "supplier": "/organisations/{orgId}/connections/{connectionId}",
  "buyer": "/organisations/{orgId}/connections/{connectionId}",
  "deliverToLocation": "/organisations/{orgId}/locations/{locationId}",
  "lineItems": [
    { … }
  ],
  "note": "string",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations
Copyright © iov42 Limited.