Skip to content
/Order Workflow

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

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

Create Purchase Order With Delivery

Request

This allows for the creation of a purchase order and a corresponding delivery as well as assigning DDS references.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
orderobjectrequired

The details of the purchase order that you wish to create.

order.​numberstringrequired

The purchase order number.

order.​statusstringrequired

The current status of the purchase order.

Enum"OPEN""APPROVED""COMPLETED""CANCELLED"
order.​orderDatestring(date-time)

The date and time of the purchase order.

order.​expectedDeliveryDatestring(date-time)

The date and time the delivery is expected to .

order.​supplierstring(uri)

The URI of the supplier.

order.​buyerstring(uri)

The URI of the buyer.

order.​deliverToLocationstring(uri)

The URI of the deliver to location.

order.​lineItemsArray of objects(Transactional.PurchaseOrderItem)required

List of items included in the purchase order.

order.​lineItems[].​lineItemIdstring

An optional line item id.

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

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

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

The quantity of the product included in the purchase order.

order.​lineItems[].​notestring

A note for each line item.

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

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

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

Additiononal quantities can be specified directly on the item.

order.​lineItems[].​additionalQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

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

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

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

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

order.​notestring

A note to pass any information.

order.​idstring

System assigned or user defined id field.

deliveryobjectrequired

Specify delivery configuration if you wish to create a delivery

delivery.​generateboolean

Specify as true if you want to generate a delivery based on this PO. Defaults to false.

delivery.​idstring

System assigned or user defined id field - if left out then the workflow will use the PO number.

delivery.​deliveryIdstring

User-assigned unique identifier for the delivery - if left out then the workflow will use the PO number.

delivery.​fromstring(uri)required

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

delivery.​statusstring

The status of the delivery. If left out then it will default to PENDING.

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

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

delivery.​deliveredstring(date-time)

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

ddsobject

If specified DDS Statements and/or Reference Numbers can be associated with the PO and (if specified) the created delivery.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/workflows/orders' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "order": {
      "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"
    },
    "delivery": {
      "generate": true,
      "id": "string",
      "deliveryId": "string",
      "from": "/organisations/{orgId}/locations/{locationId}",
      "status": "DELIVERED",
      "sent": "2019-08-24T14:15:22Z",
      "delivered": "2019-08-24T14:15:22Z"
    },
    "dds": {
      "existing": {
        "resolve": true,
        "ignoreMissing": true,
        "references": [
          {
            "referenceNumber": "string",
            "verificationNumber": "string"
          }
        ]
      },
      "create": {
        "resolve": true,
        "internalReferenceNumber": "string",
        "statementData": {
          "operatorType": "OPERATOR",
          "activityType": "IMPORT",
          "countryOfActivity": "AT",
          "borderCrossCountry": "AT",
          "comment": "string",
          "geoLocationConfidential": true,
          "associatedStatements": [
            {
              "referenceNumber": "string",
              "verificationNumber": "string"
            }
          ]
        }
      },
      "product": {
        "filterBySupplier": true,
        "ignoreMissing": true
      }
    }
  }'

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
orderobjectrequired

This is the Purchase Order that has been created by the workflow.

order.​numberstringrequired

The purchase order number.

order.​statusstringrequired

The current status of the purchase order.

Enum"OPEN""APPROVED""COMPLETED""CANCELLED"
order.​orderDatestring(date-time)

The date and time of the purchase order.

order.​expectedDeliveryDatestring(date-time)

The date and time the delivery is expected to .

order.​supplierstring(uri)

The URI of the supplier.

order.​buyerstring(uri)

The URI of the buyer.

order.​deliverToLocationstring(uri)

The URI of the deliver to location.

order.​lineItemsArray of objects(Transactional.PurchaseOrderItem)required

List of items included in the purchase order.

order.​lineItems[].​lineItemIdstring

An optional line item id.

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

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

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

The quantity of the product included in the purchase order.

order.​lineItems[].​notestring

A note for each line item.

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

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

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

Additiononal quantities can be specified directly on the item.

order.​lineItems[].​additionalQuantities[].​baseUnitstringrequired

The additional quantity base unit of measurement.

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

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

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

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

order.​notestring

A note to pass any information.

order.​idstring

System assigned or user defined id field.

order.​createdBystring

User who created the record.

order.​createdTimestring(date-time)

Date & Time that the record was created.

order.​updatedBystring

Last updated by user.

order.​updatedTimestring(date-time)

Date & Time that the record was last updated.

deliveryobject

If specified, this is the delivery that was created by the workflow.

ddsArray of objects(Integrations.Eudr.ResolveDDSResult)

If the workflow has been called with resolve DDS configuration then it will return any DDSs that it has been able to resolve.

Response
application/json
{
  "order": {
    "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"
  },
  "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"
  },
  "dds": [
    { … }
  ]
}

Sending Outbound

Operations
Copyright © iov42 Limited.