Skip to content
Interu API Reference/
/
Update Variant

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

Retrieve Variant

Request

Retrieve an existing product variant.

Security
ApiKeyAuth
Path
variantIdstringrequired
productIdstringrequired
orgIdstringrequired

The organisation identity

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

Responses

The request has succeeded.

Bodyapplication/json
idstring

System assigned or user defined id field.

descriptionstringrequired

The identity for of the variant. This needs to be unique in the context of the product.

skustring

If you want to store the SKU number separately from the description this field is available.

additionalUnitsArray of objects(Static.AdditionalUnit)required

A list of additional Units that specify the factor for converting from the base unit to other base units: e.g. unit to kg specific to this variant.

additionalUnits[].​baseUnitstring(uri)required

The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.

additionalUnits[].​conversionFactornumber(decimal)required

The conversion factor from product base unit to conversion base unit.

recordStatestring
Enum"ACTIVE""ARCHIVED"
Response
application/json
{
  "id": "string",
  "description": "string",
  "sku": "string",
  "additionalUnits": [
    { … }
  ],
  "recordState": "ACTIVE"
}

Update Variant

Request

Update an existing product.

Security
ApiKeyAuth
Path
variantIdstringrequired
productIdstringrequired
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
descriptionstringrequired

The identity for of the variant. This needs to be unique in the context of the product.

skustring

If you want to store the SKU number separately from the description this field is available.

additionalUnitsArray of objects(Static.AdditionalUnit)required

A list of additional Units that specify the factor for converting from the base unit to other base units: e.g. unit to kg specific to this variant.

additionalUnits[].​baseUnitstring(uri)required

The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.

additionalUnits[].​conversionFactornumber(decimal)required

The conversion factor from product base unit to conversion base unit.

curl -i -X PUT \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/products/{productId}/variants/{variantId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "description": "string",
    "sku": "string",
    "additionalUnits": [
      {
        "baseUnit": "/common/base-units/{unitId}",
        "conversionFactor": 0
      }
    ]
  }'

Responses

The request has succeeded.

Bodyapplication/json
idstring

System assigned or user defined id field.

descriptionstringrequired

The identity for of the variant. This needs to be unique in the context of the product.

skustring

If you want to store the SKU number separately from the description this field is available.

additionalUnitsArray of objects(Static.AdditionalUnit)required

A list of additional Units that specify the factor for converting from the base unit to other base units: e.g. unit to kg specific to this variant.

additionalUnits[].​baseUnitstring(uri)required

The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.

additionalUnits[].​conversionFactornumber(decimal)required

The conversion factor from product base unit to conversion base unit.

recordStatestring
Enum"ACTIVE""ARCHIVED"
Response
application/json
{
  "id": "string",
  "description": "string",
  "sku": "string",
  "additionalUnits": [
    { … }
  ],
  "recordState": "ACTIVE"
}

Delete Product Variant

Request

Delete a product. This will only work if the product is not referenced in any items.

Security
ApiKeyAuth
Path
variantIdstringrequired
productIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X DELETE \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/products/{productId}/variants/{variantId}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

There is no content to send for this request, but the headers may be useful.

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
Copyright © iov42 Limited.