Skip to content
/
Outbound Delivery Workflo...

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

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations

Create Delivery from Inputs

Request

This allows for the creation of an 'outbound' delivery based on a variety of potential inputs and differing outputs.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
Any of:

Supports the creation of a delivery with items that are selected directly from provided input items.

idstring

System assigned or user defined id field.

deliveryIdstringrequired

User-assigned unique identifier for the delivery.

fromstring(uri)required

The URI of the location from which the delivery is being delivered from.

tostring(uri)required

The URI of the location to which the delivery is being delivered to.

statusstringrequired
Enum"DELIVERED""PENDING""IN_PROGRESS"
sentstring(date-time)

The date and time of when the delivery has/will been sent.

deliveredstring(date-time)

The date and time of when the delivery has/will been delivered.

purchaseOrderNumbersArray of strings

List of purchase order numbers that you want to associate with the delivery.

agentsArray of strings

List of organisations that act as agents for the delivery.

lineItemsArray of objectsrequired

The line item definitions for the inputs and outputs for a delivery.

lineItems[].​inputsArray of objects(Workflow.ItemsInput)required

Identifies the input items to use in creating the outbound delivery.

lineItems[].​inputs[].​itemstring(uri)required

The item id to use as input.

lineItems[].​inputs[].​currentLocationstring(uri)required

The current location of the items to select from.

lineItems[].​outputsArray of objects(Workflow.ItemOutput)required

Identifies details of the output items to be created in the outbound delivery.

lineItems[].​outputs[].​idstring

The record id to assign to the output item.

lineItems[].​outputs[].​itemIdstringrequired

The item id to assign to the output item.

lineItems[].​outputs[].​quantityinteger(int32)required

The quantity of item to include in the delivery.

lineItems[].​inputDatestring(date-time)

The input date for the created process.

lineItems[].​outputDatestring(date-time)

The output date for the created process.

lineItems[].​processTypestring(uri)required

The URI of the Process Type that represents the task of linking inbound to outbound.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/workflows/deliveries' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "id": "string",
    "deliveryId": "string",
    "from": "/organisations/{orgId}/locations/{locationId}",
    "to": "/organisations/{orgId}/locations/{locationId}",
    "status": "DELIVERED",
    "sent": "2019-08-24T14:15:22Z",
    "delivered": "2019-08-24T14:15:22Z",
    "purchaseOrderNumbers": [
      "string"
    ],
    "agents": [
      "/organisations/{orgId}/connections/{connectionId}"
    ],
    "lineItems": [
      {
        "inputs": [
          {
            "item": "/organisations/{orgId}/items/{itemId}",
            "currentLocation": "/organisations/{orgId}/locations/{locationId}"
          }
        ],
        "outputs": [
          {
            "id": "string",
            "itemId": "string",
            "quantity": 0
          }
        ],
        "inputDate": "2019-08-24T14:15:22Z",
        "outputDate": "2019-08-24T14:15:22Z",
        "processType": "/organisations/{orgId}/process-types/{processTypeId}"
      }
    ]
  }'

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
deliveryobjectrequired
delivery.​deliveryIdstringrequired

User-assigned unique identifier for the delivery.

delivery.​fromstring(uri)required

The URI of the location from which the delivery is being delivered from.

delivery.​tostring(uri)required

The URI of the location to which the delivery is being delivered to.

delivery.​statusstringrequired
Enum"DELIVERED""PENDING""IN_PROGRESS"
delivery.​sentstring(date-time)

The date and time of when the delivery has been sent.

delivery.​deliveredstring(date-time)

The date and time of when the delivery has been delivered.

delivery.​itemsArray of objects(Transactional.DeliveryItem)

List of items included in the delivery.

delivery.​agentsArray of strings

List of agent organisation URIs that are associated with the delivery.

delivery.​purchaseOrderNumbersArray of strings

Associated Purchase Orders

delivery.​idstring

System assigned or user defined id field.

delivery.​createdBystring

User who created the record.

delivery.​createdTimestring(date-time)

Date & Time that the record was created.

delivery.​updatedBystring

Last updated by user.

delivery.​updatedTimestring(date-time)

Date & Time that the record was last updated.

Response
application/json
{
  "delivery": {
    "deliveryId": "string",
    "from": "/organisations/{orgId}/locations/{locationId}",
    "to": "/organisations/{orgId}/locations/{locationId}",
    "status": "DELIVERED",
    "sent": "2019-08-24T14:15:22Z",
    "delivered": "2019-08-24T14:15:22Z",
    "items": [ … ],
    "agents": [ … ],
    "purchaseOrderNumbers": [ … ],
    "id": "string",
    "createdBy": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "updatedTime": "2019-08-24T14:15:22Z"
  }
}
Copyright © iov42 Limited.