Skip to content
Interu API Reference/
/
Retrieve Delivery

Interu API (v2_31)

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

Retrieve Delivery List

Request

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
deliveryIdstring
recordStatestring(Common.Enums.RecordState)
Enum"ACTIVE""ARCHIVED"
statusstring(Transactional.DeliveryStatus)
Enum"DELIVERED""PENDING""IN_PROGRESS"
purchaseOrderNumberstring
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}/deliveries?deliveryId=string&recordState=ACTIVE&status=DELIVERED&purchaseOrderNumber=string&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Transactional.Delivery)required
content[].​deliveryIdstringrequired

User-assigned unique identifier for the delivery.

content[].​fromstring(uri)required

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

content[].​tostring(uri)required

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

content[].​statusstringrequired

The current status of the delivery.

Enum"DELIVERED""PENDING""IN_PROGRESS"
content[].​sentstring(date-time)

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

content[].​deliveredstring(date-time)

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

content[].​itemsArray of objects(Transactional.DeliveryItem)

List of items included in the delivery.

content[].​agentsArray of strings

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

content[].​purchaseOrderNumbersArray of strings

Associated Purchase Orders

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 Delivery

Request

Security
ApiKeyAuth
Path
deliveryIdstringrequired
orgIdstringrequired

The organisation identity

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

Responses

The request has succeeded.

Bodyapplication/json
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

The current status of the delivery.

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

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

deliveredstring(date-time)

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

itemsArray of objects(Transactional.DeliveryItem)

List of items included in the delivery.

agentsArray of strings

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

purchaseOrderNumbersArray of strings

Associated Purchase Orders

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
{
  "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": [
    "string"
  ],
  "purchaseOrderNumbers": [
    "string"
  ],
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Update Delivery

Request

Security
ApiKeyAuth
Path
deliveryIdstringrequired
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
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

The current status of the delivery.

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

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

deliveredstring(date-time)

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

itemsArray of objects(Transactional.DeliveryItem)

List of items included in the delivery.

agentsArray of strings

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

purchaseOrderNumbersArray of strings

Associated Purchase Orders

curl -i -X PUT \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/deliveries/{deliveryId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "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": [
      {
        "item": "/organisations/{orgId}/items/{itemId}",
        "quantity": 0
      }
    ],
    "agents": [
      "string"
    ],
    "purchaseOrderNumbers": [
      "string"
    ]
  }'

Responses

The request has succeeded.

Bodyapplication/json
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

The current status of the delivery.

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

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

deliveredstring(date-time)

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

itemsArray of objects(Transactional.DeliveryItem)

List of items included in the delivery.

agentsArray of strings

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

purchaseOrderNumbersArray of strings

Associated Purchase Orders

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
{
  "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": [
    "string"
  ],
  "purchaseOrderNumbers": [
    "string"
  ],
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Items

Apis related to Items.

Operations

Orders

Apis related to Orders.

Operations

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations

Order Workflow

Operations

Sending Outbound

Operations
Copyright © iov42 Limited.