Skip to main content
API docs by Redocly

Documentation (1.0.5)

Download OpenAPI specification:Download

Documentation for the Track and Trace infrastructure

Assets

search for an Asset by display-name value and return the trackId if exists.

get an Asset Id by the display-name

Authorizations:
bearerAuth
query Parameters
displayNameValue
required
string

Display Name value

organizationId
required
string

Organization Id

supplyChainId
required
string

Supply Chain ID

workflowId
required
string

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "custodian": "string",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "displayProperty": {
    },
  • "properties": [
    ],
  • "status": "string",
  • "trackId": "string"
}

Get Assets by track ids

Get a list of Assets by its track ids

Authorizations:
bearerAuth
query Parameters
assetIds
Array of strings

Asset List of IDs

organizationId
required
string

Organization Id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

File Upload

Upload a file

This endpoint allows you to upload a file up to 50 Megabytes. There are some valid extensions to upload such as:

  • PDF, DOC, DOCX, XLS, CSV, TXT, JPG, JPEG, PNG and ZIP

If the required properties are not provided, a 422 error code will be returned.

If the request is successful, the API will return an UploadedFile object, which includes information about the file that was uploaded.

Request Body schema: multipart/form-data
assetVersion
integer <int32>
extensionFile
string
file
string <binary> (File)

File object that you want to upload.

supplyChainId
string
trackId
string
workflowDefinitionId
string

Responses

Response samples

Content type
application/json
{
  • "file-hash": "string",
  • "file-name": "string",
  • "file-url": "string"
}

Inventory

Get all balances related to an organization and inventory

Get a list of balances

Authorizations:
bearerAuth
query Parameters
organizationId
required
string

Organization Id

inventoryId
string

Inventory ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all inventory events related to a product and an inventory

Get a list of inventory events

Authorizations:
bearerAuth
query Parameters
organizationId
required
string

Organization Id

productId
string

Product ID

inventoryId
string

Inventory ID

dateFrom
string <date>

date filter from bound

dateTo
string <date>

date filter to bound

tags
Array of strings

Multiple tags filter

flow
string
Enum: "INFLOW" "OUTFLOW"

filter by flow

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer

Page of the results

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
Example
{
  • "pageContent": [
    ],
  • "contentType": "AssetFullDetailsPageDTO",
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Get the balance related an specific product

Get the balance of a product

Authorizations:
bearerAuth
query Parameters
organizationId
required
string

Organization Id

inventoryId
string

Inventory ID

productId
string

Product ID

dateFrom
string <date>

date filter from bound

dateTo
string <date>

date filter to bound

Responses

Response samples

Content type
application/json
{
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "income": "string",
  • "outcome": "string",
  • "product": {
    },
  • "quantity": "string"
}

DigitalProductPassport

Generate QR code

Generate the QR code to access the Digital Product Passport

query Parameters
token
string

Token

Responses

Step Execution

Start / Update a step in a workflow Deprecated

This endpoint allows you to start or update a step in a workflow. To do so, you'll need to provide metadata about the step and its execution in the form of a StepMetadata object in the request body.

As part of the body StepMetadata object you can also include the stepExecutorMetadata to provide any additional metadata required to run the step. The specific properties required at each endpoint are dynamic depending on what has been configured for this step in a workflow. You can see what properties are required by making a GET request to /v1/step-executions/execution-metadata/{stepDefinitionId}/{workflowDefinitionId} with the relevant step definition ID.

If the required properties are not provided, a 422 error code will be returned.

If the request is successful, the API will return a StepInstance object, which includes information about the step instance that was created.

Note that certain error codes may be returned if the required metadata is not provided or if validation issues are encountered. More information on these error codes can be found in the responses section below.

Authorizations:
bearerAuth
query Parameters
organization-id
required
string

Organization Id

Request Body schema: application/json

Metadata about the step and its execution

assetTrackId
string
stepDefinitionId
required
string
object

Additional metadata required to run the step. Information about the properties required for a specific step is available at geStepExecutionMetadataSchema section

supplyChainId
required
string
workflowDefinitionId
required
string

Responses

Request samples

Content type
application/json
{
  • "assetTrackId": "assetTrack123",
  • "stepDefinitionId": "def456",
  • "stepExecutorMetadata": {
    },
  • "supplyChainId": "chain101",
  • "workflowDefinitionId": "workflow789"
}

Response samples

Content type
application/json
{
  • "assetTrackId": "string",
  • "errorCode": "string",
  • "errorDetails": "string",
  • "id": 0,
  • "message": "string",
  • "status": "string",
  • "stepDefinitionId": "string",
  • "stepInstanceId": "string",
  • "workflowInstanceId": "string"
}

Step Share

Create a access token for the step

This endpoint allows the caller to create an access token to access the step instance form and return an URL with the param

Authorizations:
bearerAuth
query Parameters
organization-id
required
string

Organization Id

Request Body schema: application/json
definitionId
required
string

This is the unique id for the step definition

instanceId
required
string

This is the unique id for the workflow instance

Responses

Request samples

Content type
application/json
{
  • "definitionId": "string",
  • "instanceId": "string"
}

Response samples

Content type
application/json
{
  • "publicUrl": "string"
}

Workflow Execution

Execute a specific step in a workflow instance

Executes the specified step in the given workflow instance

path Parameters
instanceId
required
string
definitionId
required
string
query Parameters
organization-id
required
string

Organization Id

Request Body schema: application/json
required
object

Map of input field keys to their values for step execution

property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "executionValues": {
    }
}

Response samples

Content type
application/json
{
  • "instanceId": "string"
}

Retry a failed step with corrected data

Allows retrying a failed step with corrected metadata to resolve validation or execution errors

path Parameters
instanceId
required
string
definitionId
required
string
query Parameters
organization-id
required
string

Organization Id

Request Body schema: application/json
required
object

Map of input field keys to their values for step execution

property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "executionValues": {
    }
}

Response samples

Content type
application/json
{
  • "instanceId": "string"
}

Initialize a workflow instance and run the init step

Creates a new workflow instance and executes its initialization step

query Parameters
organization-id
required
string

Organization Id

Request Body schema: application/json
assetTrackId
required
string or null

Unique identifier of the asset. If this field is null, an asset will be created. If a value is provided, an asset will be imported.

definitionId
required
string

Unique identifier of the workflow definition to initialize

Responses

Request samples

Content type
application/json
{
  • "assetTrackId": "string",
  • "definitionId": "string"
}

Response samples

Content type
application/json
{
  • "instanceId": "string"
}