LionRT API API Reference

Events based response and automations blockchain for today's value chains.

API Endpoint
https://mvp.lionrt.com/
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.0

super user

POST /v1/auth

Get SuperUser Bearer token for authenticated calls.

Login object contains email and base64 encrypted password as attributes.

Request Example
{
  "email": "string",
  "password": "string"
}
200 OK

Token object for future authenticated calls.

default

error response object

Response Example (200 OK)
{
  "token": "string",
  "expirationTime": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/auth

Expires Bearer token and invalidates future authenticated calls with the existing token.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

200 OK

success response object

default

default response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/auth

authenticate against a User account for permission based actions permissioned actions can have override with additional headers permissions override is restricted to SuperUser the suggested mechanism should authenticate a User for their access token API actions are signed by the effector token Bearer: either an authenticated User with set of permissions or SuperUser and their Organization

Login object contains email and base64 encrypted password as attributes.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

Request Example
{
  "email": "string",
  "password": "string"
}
200 OK

Token object for future authenticated calls.

default

error response object

Response Example (200 OK)
{
  "token": "string",
  "expirationTime": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/organization

Onboard new Organization.

Organization registration object

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

Request Example
{
  "name": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "metadata": {
    "about": "string",
    "story": "string",
    "founder": "string",
    "established": "string",
    "compliance": "string",
    "regulation": "string",
    "disclosure": "string",
    "notes": "string",
    "miscellaneous": "string"
  },
  "purpose": "string",
  "createdBy": "string"
}
200 OK

new Organization

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "qr": "string",
  "employees": [
    {
      "0": "string",
      "id": "string",
      "latestBlock": "string",
      "key": "string",
      "operatorPermission": "number",
      "adminPermissions": [
        "number"
      ],
      "organization": "string",
      "email": "string",
      "purpose": "string",
      "name": "string",
      "isOperator": "boolean",
      "isAdmin": "boolean",
      "createdBy": "string"
    }
  ],
  "destinations": [
    {
      "phone": "string",
      "email": "string",
      "authorized": "boolean",
      "authorizedDate": "string"
    }
  ],
  "templates": [
    {
      "name": "string",
      "internalId": "string",
      "thresholds": {
        "type": "string",
        "max": "number",
        "min": "number"
      },
      "audit": "boolean",
      "alert": "boolean",
      "recipients": [
        {
          "phone": "string",
          "email": "string",
          "authorized": "boolean",
          "authorizedDate": "string"
        }
      ],
      "destinations": [
        "string"
      ],
      "policies": [
        {
          "policy": "string",
          "name": "string",
          "contact": "object",
          "actions": [
            {
              "exception": {}
            }
          ]
        }
      ]
    }
  ],
  "name": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "metadata": {
    "about": "string",
    "story": "string",
    "founder": "string",
    "established": "string",
    "compliance": "string",
    "regulation": "string",
    "disclosure": "string",
    "notes": "string",
    "miscellaneous": "string"
  },
  "purpose": "string",
  "createdBy": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/users

read list of SuperUser (API Key) Users

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

200 OK

list of Users

type
default

error response object

Response Example (200 OK)
[
  {
    "0": "string",
    "id": "string",
    "latestBlock": "string",
    "key": "string",
    "operatorPermission": "number",
    "adminPermissions": [
      "number"
    ],
    "organization": "string",
    "email": "string",
    "purpose": "string",
    "name": "string",
    "isOperator": "boolean",
    "isAdmin": "boolean",
    "createdBy": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/organizations

read list of SuperUser (API Key) Organizations this action is restricted to SuperUsers

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

200 OK

list of Organizations

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "qr": "string",
  "employees": [
    {
      "0": "string",
      "id": "string",
      "latestBlock": "string",
      "key": "string",
      "operatorPermission": "number",
      "adminPermissions": [
        "number"
      ],
      "organization": "string",
      "email": "string",
      "purpose": "string",
      "name": "string",
      "isOperator": "boolean",
      "isAdmin": "boolean",
      "createdBy": "string"
    }
  ],
  "destinations": [
    {
      "phone": "string",
      "email": "string",
      "authorized": "boolean",
      "authorizedDate": "string"
    }
  ],
  "templates": [
    {
      "name": "string",
      "internalId": "string",
      "thresholds": {
        "type": "string",
        "max": "number",
        "min": "number"
      },
      "audit": "boolean",
      "alert": "boolean",
      "recipients": [
        {
          "phone": "string",
          "email": "string",
          "authorized": "boolean",
          "authorizedDate": "string"
        }
      ],
      "destinations": [
        "string"
      ],
      "policies": [
        {
          "policy": "string",
          "name": "string",
          "contact": "object",
          "actions": [
            {
              "exception": {}
            }
          ]
        }
      ]
    }
  ],
  "name": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "metadata": {
    "about": "string",
    "story": "string",
    "founder": "string",
    "established": "string",
    "compliance": "string",
    "regulation": "string",
    "disclosure": "string",
    "notes"quot;: "string",
    "miscellaneous": "string"
  },
  "purpose": "string",
  "createdBy": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

base

POST /v1/api/base/public

update public Organization metadata intended for Organization marketing materials & media. can update avatar, banner, and media items

Organization public marketing metadata

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "avatar": {
    "avatar": "string"
  },
  "banner": {
    "banner": "string"
  },
  "media": [
    {
      "type": "string",
      "url": "string"
    }
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

PUT /v1/api/base/public

Update Organization metadata.

Organization metadata object(s)

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "metadata": {
    "about": "string",
    "story": "string",
    "founder": "string",
    "established": "string",
    "compliance": "string",
    "regulation": "string",
    "disclosure": "string",
    "notes": "string",
    "miscellaneous": "string"
  }
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/base/employees

Read list of employees for one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

list of employees

type
default

error response object

Response Example (200 OK)
[
  {
    "0": "string",
    "id": "string",
    "latestBlock": "string",
    "key": "string",
    "operatorPermission": "number",
    "adminPermissions": [
      "number"
    ],
    "organization": "string",
    "email": "string",
    "purpose": "string",
    "name": "string",
    "isOperator": "boolean",
    "isAdmin": "boolean",
    "createdBy": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/base/employees

Onboard new User as employee of an Organization.

User registration object

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "organization": "string",
  "email": "string",
  "purpose": "string",
  "name": "string",
  "isOperator": "boolean",
  "isAdmin": "boolean",
  "createdBy": "string"
}
200 OK

new User

default

error response object

Response Example (200 OK)
{
  "0": "string",
  "id": "string",
  "latestBlock": "string",
  "key": "string",
  "operatorPermission": "number",
  "adminPermissions": [
    "number"
  ],
  "organization": "string",
  "email": "string",
  "purpose": "string",
  "name": "string",
  "isOperator": "boolean",
  "isAdmin": "boolean",
  "createdBy": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

PUT /v1/api/base/employees

Update User permissions.

Permissions object(s)

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "admin": {
    "adminPermissions": [
      "number"
    ]
  },
  "operator": {
    "operatorPermission": "number"
  },
  "field": [
    "string"
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

DELETE /v1/api/base/employees

Remove User from an Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/base/template

Create a new Contract template of one Organization.

Add Organization Contract template

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "name": "string",
  "internalId": "string",
  "thresholds": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "audit": "boolean",
  "alert": "boolean",
  "recipients": [
    {
      "phone": "string",
      "email": "string",
      "authorized": "boolean",
      "authorizedDate": "string"
    }
  ],
  "destinations": [
    "string"
  ],
  "policies": [
    {
      "policy": "string",
      "name": "string",
      "contact": "object",
      "actions": [
        {
          "exception": {
            "id": "string",
            "terms": [
              {
                "files": [
                  "string"
                ],
                "recipients": [
                  {
                    "name": "string",
                    "phone": "string",
                    "email": "string"
                  }
                ],
                "message": "string",
                "term": "string"
              }
            ],
            "formattedPerformanceData": "object",
            "organizations": [
              {
                "id": "string",
                "qr": "string",
                "employees": [
                  {
                    "adminPermissions": [
                      "number"
                    ],
                    "organization": "string",
                    "email": "string",
                    "purpose": "string",
                    "name": "string",
                    "isOperator": "boolean",
                    "isAdmin": "boolean",
                    "createdBy": "string"
                  }
                ],
                "name": "string",
                "address": {
                  "address1": "string",
                  "address2": "string",
                  "address3": "string",
                  "lat": "number",
                  "lng": "number",
                  "formatted": "string"
                },
                "contact": {
                  "name": "string",
                  "phone": "string",
                  "email": "string"
                },
                "metadata": {
                  "about": "string",
                  "story": "string",
                  "founder": "string",
                  "established": "string",
                  "compliance": "string",
                  "regulation": "string",
                  "disclosure": "string",
                  "notes": "string",
                  "miscellaneous": "string"
                },
                "purpose": "string",
                "createdBy": "string"
              }
            ]
          }
        }
      ]
    }
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

DELETE /v1/api/base/template

Delete a Contract template of one Organization.

object with template identifier

template: string

identifier of the template to remove from an Organization

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "template": "string"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/base/templates

Read list of Contract templates of one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

list of templates

default

error response object

Response Example (200 OK)
[
  {
    "name": "string",
    "internalId": "string",
    "thresholds": {
      "type": "string",
      "max": "number",
      "min": "number"
    },
    "audit": "boolean",
    "alert": "boolean",
    "recipients": [
      {
        "phone": "string",
        "email": "string",
        "authorized": "boolean",
        "authorizedDate": "string"
      }
    ],
    "destinations": [
      "string"
    ],
    "policies": [
      {
        "policy": "string",
        "name": "string",
        "contact": "object",
        "actions": [
          {
            "exception": {
              "id": "string",
              "terms": [
                {
                  "files": [
                    "string"
                  ],
                  "recipients": [
                    {
                      "name": "string",
                      "phone": "string",
                      "email": "string"
                    }
                  ],
                  "message": "string",
                  "term": "string"
                }
              ],
              "formattedPerformanceData": "object",
              "organizations": [
                {
                  "id": "string",
                  "qr": "string",
                  "employees": [
                    {
                      "adminPermissions": [
                        "number"
                      ],
                      "organization": "string",
                      "email": "string",
                      "purpose": "string",
                      "name": "string",
                      "isOperator": "boolean",
                      "isAdmin": "boolean",
                      "createdBy": "string"
                    }
                  ],
                  "name": "string",
                  "address": {
                    "address1": "string",
                    "address2": "string",
                    "address3": "string",
                    "lat": "number",
                    "lng": "number",
                    "formatted": "string"
                  },
                  "contact": {
                    "name": "string",
                    "phone": "string",
                    "email": "string"
                  },
                  "metadata": {
                    "about": "string",
                    "story": "string",
                    "founder": "string",
                    "established": "string",
                    "compliance": "string",
                    "regulation": "string",
                    "disclosure": "string",
                    "notes": "string",
                    "miscellaneous": "string"
                  },
                  "purpose": "string",
                  "createdBy": "string"
                }
              ]
            }
          }
        ]
      }
    ]
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

iot

iot

GET /v1/api/iot

Get list of Devices of one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

list of Devices

default

error response object

Response Example (200 OK)
[
  {
    "id": "string",
    "key": "string",
    "organization": "string",
    "templates": [
      [
        {
          "name": "string",
          "internalId": "string",
          "thresholds": {
            "type": "string",
            "max": "number",
            "min": "number"
          },
          "audit": "boolean",
          "alert": "boolean",
          "recipients": [
            {
              "phone": "string",
              "email": "string",
              "authorized": "boolean",
              "authorizedDate": "string"
            }
          ],
          "destinations": [
            "string"
          ],
          "policies": [
            {
              "policy": "string",
              "name": "string",
              "contact": "object",
              "actions": [
                {
                  "exception": {
                    "id": "string",
                    "terms": [
                      {
                        "files": [
                          "string"
                        ],
                        "recipients": [
                          {
                            "name": "string",
                            "phone": "string",
                            "email": "string"
                          }
                        ],
                        "message": "string",
                        "term": "string"
                      }
                    ],
                    "formattedPerformanceData": "object",
                    "organizations": [
                      {
                        "name": "string",
                        "address": {
                          "address1": "string",
                          "address2": "string",
                          "address3": "string",
                          "lat": "number",
                          "lng": "number",
                          "formatted": "string"
                        },
                        "contact": {
                          "name": "string",
                          "phone": "string",
                          "email": "string"
                        },
                        "metadata": {}
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      ]
    ],
    "deviceID": "string",
    "topic": "string",
    "app": "string",
    "internalId": "string",
    "frequency": "number",
    "nickname": "string",
    "ssid": "string",
    "password": "string",
    "sensors": [
      {
        "type": "string",
        "key": "string",
        "id": "string"
      }
    ],
    "connectors": [
      {
        "ssid": "string",
        "password": "string",
        "key": "string"
      }
    ]
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}
iot

POST /v1/api/iot

Register new Device of one Organization.

new Device to register for one Organization

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "deviceID": "string",
  "topic": "string",
  "app": "string",
  "internalId": "string",
  "frequency": "number",
  "nickname": "string",
  "ssid": "string",
  "password": "string",
  "sensors": [
    {
      "type": "string",
      "key": "string",
      "id": "string"
    }
  ],
  "connectors": [
    {
      "ssid": "string",
      "password": "string",
      "key": "string"
    }
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}
iot

PUT /v1/api/iot

Bind sensor Device(s) to connector Device.

bind Devices to connector with closed local network the bound sensor Devices can not be operated independently while bound to unbind Device from connector, update Device settings with the following: { connector: { $unbind: true } } in the request body of the Device update (PUT /v1/api/device/{device_id})

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "internalIds": [
    "string"
  ],
  "connector": "string"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/device/{device_id}

Read Device of one Organization.

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Device readings

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "type": "string",
  "values": [
    {
      "value": "number"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/device/{device_id}

Initiate IoT Contract. These are usually logistics field Contracts made on the fly. Also applies to dedicated cold chain operations or similar.

Contract details

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "inventory": [
    "string"
  ],
  "location": [
    "number"
  ],
  "origination": {
    "city": "string",
    "state": "string",
    "country": "string",
    "time": "string",
    "jurisdiction": "string",
    "statute": "string"
  },
  "name": "string",
  "internalId": "string",
  "connector": "string",
  "thresholds": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "lightSensitive": "boolean",
  "motionSensitive": "boolean",
  "temperatureSensitive": "boolean",
  "destinationTime": "string",
  "destinationContact": "string",
  "destinationLocation": [
    "number"
  ],
  "destinationAddress": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "organization": "string",
  "recipient": "string"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

PUT /v1/api/device/{device_id}

Update settings to Device of one Organization. Update frequency with a valid number between 60 (1 minute) and 3600 (1 hour). Update internalId with a new internal identifier value. Update groups and create one or more parenting relationships with a list of group names. Update templates to make Device ready for Contracts in the field during logistics. Transact a block or contract already in progress

update Device settings

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "frequency": "number",
  "internalId": "string",
  "groups": [
    "string"
  ],
  "templates": [
    {
      "name": "string",
      "internalId": "string",
      "thresholds": {
        "type": "string",
        "max": "number",
        "min": "number"
      },
      "audit": "boolean",
      "alert": "boolean",
      "recipients": [
        {
          "phone": "string",
          "email": "string",
          "authorized": "boolean",
          "authorizedDate": "string"
        }
      ],
      "destinations": [
        "string"
      ],
      "policies": [
        {
          "policy": "string",
          "name": "string",
          "contact": "object",
          "actions": [
            {
              "exception": {
                "id": "string",
                "terms": [
                  {
                    "files": [
                      "string"
                    ],
                    "recipients": [
                      {
                        "name": "string",
                        "phone": "string",
                        "email": "string"
                      }
                    ],
                    "message": "string",
                    "term": "string"
                  }
                ],
                "formattedPerformanceData": "object",
                "organizations": [
                  {
                    "id": "string",
                    "qr": "string",
                    "employees": [
                      {
                        "organization": "string",
                        "email": "string",
                        "purpose": "string",
                        "name": "string",
                        "isOperator": "boolean",
                        "isAdmin": "boolean"
                      }
                    ],
                    "name": "string",
                    "address": {
                      "address1": "string",
                      "address2": "string",
                      "address3": "string",
                      "lat": "number",
                      "lng": "number",
                      "formatted": "string"
                    },
                    "contact": {
                      "name": "string",
                      "phone": "string",
                      "email": "string"
                    },
                    "metadata": {
                      "about": "string",
                      "story": "string",
                      "founder": "string",
                      "established": "string",
                      "compliance": "string",
                      "regulation": "string",
                      "disclosure": "string",
                      "notes": "string",
                      "miscellaneous": "string"
                    },
                    "purpose": "string",
                    "createdBy": "string"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}
iot

DELETE /v1/api/device/{device_id}

Invalidate a Device of one Organization.

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/supply/{id}/report

Issue a PDF report or data of one Supply Contract of one Organization. The report details the data relating to a Contract and it's performance.

id
in path
string lyAlyxxgoph8Wq98NQ7r

id of a Block or Contract or Leg

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

formatted report from: ( 1 ) Contract ( 2 ) Block ( 3 ) Legs the report will vary on input and requester permissions

default

error response object

Response Example (200 OK)
{
  "contract": {
    "id": "string",
    "goods": [
      {
        "name": "string",
        "sku": "string",
        "dimensions": {
          "itemLength": "number",
          "itemWidth": "number",
          "itemHeight": "number",
          "itemWeight": "number",
          "itemWeightUnits": "string",
          "shippingLength": "number",
          "shippingWidth": "number",
          "shippingHeight": "number",
          "shippingWeight": "number",
          "shippingWeightUnits": "string"
        },
        "media": [
          {
            "type": "string",
            "url": "string"
          }
        ],
        "inventory": [
          {
            "unit": "string",
            "quantity": "number",
            "manufacturer": {
              "id": "string"
            },
            "treatments": [
              {
                "id": "string",
                "metadata": {
                  "vendor": "string",
                  "name": "string",
                  "batchInfo": "string",
                  "purpose": "string",
                  "dosage": "string",
                  "additional": "string",
                  "contact": "string"
                },
                "hidden": "boolean"
              }
            ],
            "notes": "string",
            "id": "string"
          }
        ]
      }
    ],
    "inventory": [
      "string"
    ],
    "location": [
      "number"
    ],
    "origination": {
      "city": "string",
      "state": "string",
      "country": "string",
      "time": "string",
      "jurisdiction": "string",
      "statute": "string"
    },
    "name": "string",
    "internalId": "string",
    "connector": "string",
    "thresholds": {
      "type": "string",
      "max": "number",
      "min": "number"
    },
    "lightSensitive": "boolean",
    "motionSensitive": "boolean",
    "temperatureSensitive": "boolean",
    "destinationTime": "string",
    "destinationContact": "string",
    "destinationLocation": [
      "number"
    ],
    "destinationAddress": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    },
    "organization": "string",
    "recipient": "string"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

logistics

GET /v1/api/device/{device_id}

Read Device of one Organization.

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Device readings

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "type": "string",
  "values": [
    {
      "value": "number"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/device/{device_id}

Initiate IoT Contract. These are usually logistics field Contracts made on the fly. Also applies to dedicated cold chain operations or similar.

Contract details

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "inventory": [
    "string"
  ],
  "location": [
    "number"
  ],
  "origination": {
    "city": "string",
    "state": "string",
    "country": "string",
    "time": "string",
    "jurisdiction": "string",
    "statute": "string"
  },
  "name": "string",
  "internalId": "string",
  "connector": "string",
  "thresholds": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "lightSensitive": "boolean",
  "motionSensitive": "boolean",
  "temperatureSensitive": "boolean",
  "destinationTime": "string",
  "destinationContact": "string",
  "destinationLocation": [
    "number"
  ],
  "destinationAddress": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "organization": "string",
  "recipient": "string"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

PUT /v1/api/device/{device_id}

Update settings to Device of one Organization. Update frequency with a valid number between 60 (1 minute) and 3600 (1 hour). Update internalId with a new internal identifier value. Update groups and create one or more parenting relationships with a list of group names. Update templates to make Device ready for Contracts in the field during logistics. Transact a block or contract already in progress

update Device settings

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "frequency": "number",
  "internalId": "string",
  "groups": [
    "string"
  ],
  "templates": [
    {
      "name": "string",
      "internalId": "string",
      "thresholds": {
        "type": "string",
        "max": "number",
        "min": "number"
      },
      "audit": "boolean",
      "alert": "boolean",
      "recipients": [
        {
          "phone": "string",
          "email": "string",
          "authorized": "boolean",
          "authorizedDate": "string"
        }
      ],
      "destinations": [
        "string"
      ],
      "policies": [
        {
          "policy": "string",
          "name": "string",
          "contact": "object",
          "actions": [
            {
              "exception": {
                "id": "string",
                "terms": [
                  {
                    "files": [
                      "string"
                    ],
                    "recipients": [
                      {
                        "name": "string",
                        "phone": "string",
                        "email": "string"
                      }
                    ],
                    "message": "string",
                    "term": "string"
                  }
                ],
                "formattedPerformanceData": "object",
                "organizations": [
                  {
                    "id": "string",
                    "qr": "string",
                    "employees": [
                      {
                        "organization": "string",
                        "email": "string",
                        "purpose": "string",
                        "name": "string",
                        "isOperator": "boolean",
                        "isAdmin": "boolean"
                      }
                    ],
                    "name": "string",
                    "address": {
                      "address1": "string",
                      "address2": "string",
                      "address3": "string",
                      "lat": "number",
                      "lng": "number",
                      "formatted": "string"
                    },
                    "contact": {
                      "name": "string",
                      "phone": "string",
                      "email": "string"
                    },
                    "metadata": {
                      "about": "string",
                      "story": "string",
                      "founder": "string",
                      "established": "string",
                      "compliance": "string",
                      "regulation": "string",
                      "disclosure": "string",
                      "notes": "string",
                      "miscellaneous": "string"
                    },
                    "purpose": "string",
                    "createdBy": "string"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/supply/{id}/report

Issue a PDF report or data of one Supply Contract of one Organization. The report details the data relating to a Contract and it's performance.

id
in path
string lyAlyxxgoph8Wq98NQ7r

id of a Block or Contract or Leg

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

formatted report from: ( 1 ) Contract ( 2 ) Block ( 3 ) Legs the report will vary on input and requester permissions

default

error response object

Response Example (200 OK)
{
  "contract": {
    "id": "string",
    "goods": [
      {
        "name": "string",
        "sku": "string",
        "dimensions": {
          "itemLength": "number",
          "itemWidth": "number",
          "itemHeight": "number",
          "itemWeight": "number",
          "itemWeightUnits": "string",
          "shippingLength": "number",
          "shippingWidth": "number",
          "shippingHeight": "number",
          "shippingWeight": "number",
          "shippingWeightUnits": "string"
        },
        "media": [
          {
            "type": "string",
            "url": "string"
          }
        ],
        "inventory": [
          {
            "unit": "string",
            "quantity": "number",
            "manufacturer": {
              "id": "string"
            },
            "treatments": [
              {
                "id": "string",
                "metadata": {
                  "vendor": "string",
                  "name": "string",
                  "batchInfo": "string",
                  "purpose": "string",
                  "dosage": "string",
                  "additional": "string",
                  "contact": "string"
                },
                "hidden": "boolean"
              }
            ],
            "notes": "string",
            "id": "string"
          }
        ]
      }
    ],
    "inventory": [
      "string"
    ],
    "location": [
      "number"
    ],
    "origination": {
      "city": "string",
      "state": "string",
      "country": "string",
      "time": "string",
      "jurisdiction": "string",
      "statute": "string"
    },
    "name": "string",
    "internalId": "string",
    "connector": "string",
    "thresholds": {
      "type": "string",
      "max": "number",
      "min": "number"
    },
    "lightSensitive": "boolean",
    "motionSensitive": "boolean",
    "temperatureSensitive": "boolean",
    "destinationTime": "string",
    "destinationContact": "string",
    "destinationLocation": [
      "number"
    ],
    "destinationAddress": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    },
    "organization": "string",
    "recipient": "string"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/logistics/transaction

A Transaction is a transfer of performance responsibility from one User to another. This can correspond to an operator from the same or another Organization as the original operator.

New Operator onboarding

operator: Operator
contract: string

identifier of the Contract to transact

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "operator": {
    "id": "string",
    "operator": {
      "contact": {
        "name": "string",
        "phone": "string",
        "email": "string"
      },
      "address": {
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "lat": "number",
        "lng": "number",
        "formatted": "string"
      }
    }
  },
  "contract": "string"
}
200 OK
Leg

Leg object

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "terminating": "boolean",
  "organization": {
    "id": "string",
    "qr": "string",
    "employees": [
      {
        "0": "string",
        "id": "string",
        "latestBlock": "string",
        "key": "string",
        "operatorPermission": "number",
        "adminPermissions": [
          "number"
        ],
        "organization": "string",
        "email": "string",
        "purpose": "string",
        "name": "string",
        "isOperator": "boolean",
        "isAdmin": "boolean",
        "createdBy": "string"
      }
    ],
    "destinations": [
      {
        "phone": "string",
        "email": "string",
        "authorized": "boolean",
        "authorizedDate": "string"
      }
    ],
    "templates": [
      {
        "name": "string",
        "internalId": "string",
        "thresholds": {
          "type": "string",
          "max": "number",
          "min": "number"
        },
        "audit": "boolean",
        "alert": "boolean",
        "recipients": [
          {
            "phone": "string",
            "email": "string",
            "authorized": "boolean",
            "authorizedDate": "string"
          }
        ],
        "destinations": [
          "string"
        ],
        "policies": [
          {
            "policy": "string",
            "name": "string",
            "contact": "object",
            "actions": [
              null
            ]
          }
        ]
      }
    ],
    "name": "string",
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    },
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "metadata": {
      "about": "string",
      "story": "string",
      "founder": "string",
      "established": "string",
      "compliance": "string",
      "regulation": "string",
      "disclosure": "string",
      "notes": "string",
      "miscellaneous": "string"
    },
    "purpose": "string",
    "createdBy": "string"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/logistics/performance

Get latest Contract identifier.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Contract identifier

default

error response object

Response Example (200 OK)
{
  "id": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/logistics/performance

Initiate logistics performance Contract in the field or signify the beginning performance of an IoT Device Contract. Contracts may be continued via Transactions defined above.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "id": "string"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

PUT /v1/api/logistics/performance

Append performance data to Contract or mark end performance of a Contract.

Performance unit to append to Leg

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "date": "string",
  "location": [
    "number"
  ],
  "notes": "string",
  "media": [
    {
      "type": "string",
      "url": "string"
    }
  ],
  "deviceData": [
    {
      "id": "string",
      "type": "string",
      "values": [
        {
          "value": "number"
        }
      ]
    }
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

claims

GET /v1/api/device/{device_id}

Read Device of one Organization.

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Device readings

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "type": "string",
  "values": [
    {
      "value": "number"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/claims/{id}

Initiate Claim as Organization. If Claim is initiated will return the status of the claim.

id
in path
string lyAlyxxgoph8Wq98NQ7r

id of Contract Block or Leg

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Device readings

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "type": "string",
  "values": [
    {
      "value": "number"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /claims/{id}

Initiate Last-Mile customer If Claim is initiated will return the status of the claim.

Customer information

id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Transaction to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "name": "string",
  "email": "string"
}
200 OK

Claim result

default

error response object

Response Example (200 OK)
{
  "contract": {
    "inventory": [
      "string"
    ],
    "location": [
      "number"
    ],
    "origination": {
      "city": "string",
      "state": "string",
      "country": "string",
      "time": "string",
      "jurisdiction": "string",
      "statute": "string"
    },
    "name": "string",
    "internalId": "string",
    "connector": "string",
    "thresholds": {
      "type": "string",
      "max": "number",
      "min": "number"
    },
    "lightSensitive": "boolean",
    "motionSensitive": "boolean",
    "temperatureSensitive": "boolean",
    "destinationTime": "string",
    "destinationContact": "string",
    "destinationLocation": [
      "number"
    ],
    "destinationAddress": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    }
  },
  "message": "string",
  "mode": "string",
  "from": {
    "0": "string",
    "id": "string",
    "latestBlock": "string",
    "key": "string",
    "operatorPermission": "number",
    "adminPermissions": [
      "number"
    ],
    "organization": "string",
    "email": "string",
    "purpose": "string",
    "name": "string",
    "isOperator": "boolean",
    "isAdmin": "boolean",
    "createdBy": "string"
  },
  "to": {
    "0": "string",
    "id": "string",
    "latestBlock": "string",
    "key": "string",
    "operatorPermission": "number",
    "adminPermissions": [
      "number"
    ],
    "organization": "string",
    "email": "string",
    "purpose": "string",
    "name": "string",
    "isOperator": "boolean",
    "isAdmin": "boolean",
    "createdBy": "string"
  },
  "unread": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

device

PUT /v1/api/device/{device_id}

Update settings to Device of one Organization. Update frequency with a valid number between 60 (1 minute) and 3600 (1 hour). Update internalId with a new internal identifier value. Update groups and create one or more parenting relationships with a list of group names. Update templates to make Device ready for Contracts in the field during logistics. Transact a block or contract already in progress

update Device settings

device_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Device to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "frequency": "number",
  "internalId": "string",
  "groups": [
    "string"
  ],
  "templates": [
    {
      "name": "string",
      "internalId": "string",
      "thresholds": {
        "type": "string",
        "max": "number",
        "min": "number"
      },
      "audit": "boolean",
      "alert": "boolean",
      "recipients": [
        {
          "phone": "string",
          "email": "string",
          "authorized": "boolean",
          "authorizedDate": "string"
        }
      ],
      "destinations": [
        "string"
      ],
      "policies": [
        {
          "policy": "string",
          "name": "string",
          "contact": "object",
          "actions": [
            {
              "exception": {
                "id": "string",
                "terms": [
                  {
                    "files": [
                      "string"
                    ],
                    "recipients": [
                      {
                        "name": "string",
                        "phone": "string",
                        "email": "string"
                      }
                    ],
                    "message": "string",
                    "term": "string"
                  }
                ],
                "formattedPerformanceData": "object",
                "organizations": [
                  {
                    "id": "string",
                    "qr": "string",
                    "employees": [
                      {
                        "organization": "string",
                        "email": "string",
                        "purpose": "string",
                        "name": "string",
                        "isOperator": "boolean",
                        "isAdmin": "boolean"
                      }
                    ],
                    "name": "string",
                    "address": {
                      "address1": "string",
                      "address2": "string",
                      "address3": "string",
                      "lat": "number",
                      "lng": "number",
                      "formatted": "string"
                    },
                    "contact": {
                      "name": "string",
                      "phone": "string",
                      "email": "string"
                    },
                    "metadata": {
                      "about": "string",
                      "story": "string",
                      "founder": "string",
                      "established": "string",
                      "compliance": "string",
                      "regulation": "string",
                      "disclosure": "string",
                      "notes": "string",
                      "miscellaneous": "string"
                    },
                    "purpose": "string",
                    "createdBy": "string"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

supply

GET /v1/api/supply/suppliers

Read Suppliers of one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

list of Suppliers

default

error response object

Response Example (200 OK)
[
  {
    "id": "string",
    "name": "string",
    "phone": "string",
    "organization": "string",
    "self": "string",
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    }
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/supply/suppliers

Add Suppliers to one Organization. Requires Inventory item as designated recipient of each Treatment.

new Suppliers list to register for one Organization

NewSupplier
Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
[
  {
    "name": "string",
    "phone": "string",
    "organization": "string",
    "self": "string",
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    }
  }
]
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

DELETE /v1/api/supply/suppliers

Batch remove Suppliers of one Organization.

new Suppliers list to register for one Organization

list of Suppliers as public hashed identifiers

string
Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
[
  "string"
]
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/supply/inventory

Read Inventory of one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Inventory list

default

error response object

Response Example (200 OK)
[
  {
    "id": "string",
    "category": "string",
    "superCategory": "string",
    "basicInfo": {
      "shelfLife": "string",
      "unitPrice": "string",
      "description": "string"
    },
    "productionMetadata": [
      {
        "vendor": "string",
        "name": "string",
        "batchInfo": "string",
        "purpose": "string",
        "dosage": "string",
        "additional": "string",
        "contact": "string"
      }
    ],
    "guidelines": {
      "tempMin": "number",
      "tempMax": "number",
      "lightSensitive": "boolean",
      "motionSensitive": "boolean",
      "handlingInstructions": "string",
      "normalUsage": "string",
      "productAllergies": "string"
    },
    "legal": {
      "disclaimer": "string",
      "limitations": "string",
      "notes": "string"
    },
    "media": [
      {
        "type": "string",
        "url": "string"
      }
    ],
    "scheduleB": "string",
    "quantity": "number",
    "sku": "string",
    "dimensions": {
      "itemLength": "number",
      "itemWidth": "number",
      "itemHeight": "number",
      "itemWeight": "number",
      "itemWeightUnits": "string",
      "shippingLength": "number",
      "shippingWidth": "number",
      "shippingHeight": "number",
      "shippingWeight": "number",
      "shippingWeightUnits": "string"
    },
    "organization": "string",
    "manufacturer": {
      "id": "string",
      "raw": {
        "contact": {
          "name": "string",
          "phone": "string",
          "email": "string"
        },
        "address": {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "lat": "number",
          "lng": "number",
          "formatted": "string"
        }
      }
    }
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/supply/inventory

Add Inventory of one Organization.

Inventory items

NewInventory
Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
[
  {
    "category": "string",
    "superCategory": "string",
    "basicInfo": {
      "shelfLife": "string",
      "unitPrice": "string",
      "description": "string"
    },
    "productionMetadata": [
      {
        "vendor": "string",
        "name": "string",
        "batchInfo": "string",
        "purpose": "string",
        "dosage": "string",
        "additional": "string",
        "contact": "string"
      }
    ],
    "guidelines": {
      "tempMin": "number",
      "tempMax": "number",
      "lightSensitive": "boolean",
      "motionSensitive": "boolean",
      "handlingInstructions": "string",
      "normalUsage": "string",
      "productAllergies": "string"
    },
    "legal": {
      "disclaimer": "string",
      "limitations": "string",
      "notes": "string"
    },
    "media": [
      {
        "type": "string",
        "url": "string"
      }
    ],
    "scheduleB": "string",
    "quantity": "number",
    "sku": "string",
    "dimensions": {
      "itemLength": "number",
      "itemWidth": "number",
      "itemHeight": "number",
      "itemWeight": "number",
      "itemWeightUnits": "string",
      "shippingLength": "number",
      "shippingWidth": "number",
      "shippingHeight": "number",
      "shippingWeight": "number",
      "shippingWeightUnits": "string"
    },
    "organization": "string",
    "manufacturer": {
      "id": "string",
      "raw": {
        "contact": {
          "name": "string",
          "phone": "string",
          "email": "string"
        },
        "address": {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "lat": "number",
          "lng": "number",
          "formatted": "string"
        }
      }
    }
  }
]
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

DELETE /v1/api/supply/inventory

Remove Inventory of one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/supply/contract

Create Supply Contract Master Contract (Manufacturer's Contract).

Contract details

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "inventory": [
    "string"
  ],
  "location": [
    "number"
  ],
  "origination": {
    "city": "string",
    "state": "string",
    "country": "string",
    "time": "string",
    "jurisdiction": "string",
    "statute": "string"
  },
  "name": "string",
  "internalId": "string",
  "connector": "string",
  "thresholds": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "lightSensitive": "boolean",
  "motionSensitive": "boolean",
  "temperatureSensitive": "boolean",
  "destinationTime": "string",
  "destinationContact": "string",
  "destinationLocation": [
    "number"
  ],
  "destinationAddress": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "organization": "string",
  "recipient": "string"
}
200 OK

new Block

default

error response object

Response Example (200 OK)
{
  "id": "string",
  "createdBy": {
    "0": "string",
    "id": "string",
    "latestBlock": "string",
    "key": "string",
    "operatorPermission": "number",
    "adminPermissions": [
      "number"
    ],
    "organization": "string",
    "email": "string",
    "purpose": "string",
    "name": "string",
    "isOperator": "boolean",
    "isAdmin": "boolean",
    "createdBy": "string"
  },
  "originOrganization": {
    "id": "string",
    "qr": "string",
    "employees": [
      {
        "0": "string",
        "id": "string",
        "latestBlock": "string",
        "key": "string",
        "operatorPermission": "number",
        "adminPermissions": [
          "number"
        ],
        "organization": "string",
        "email": "string",
        "purpose": "string",
        "name": "string",
        "isOperator": "boolean",
        "isAdmin": "boolean",
        "createdBy": "string"
      }
    ],
    "destinations": [
      {
        "phone": "string",
        "email": "string",
        "authorized": "boolean",
        "authorizedDate": "string"
      }
    ],
    "templates": [
      {}
    ],
    "name": "string",
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    },
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "metadata": {
      "about": "string",
      "story": "string",
      "founder": "string",
      "established": "string",
      "compliance": "string",
      "regulation": "string",
      "disclosure": "string",
      "notes": "string",
      "miscellaneous": "string"
    },
    "purpose": "string",
    "createdBy": "string"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/risk/{inventory_id}/availability

Read Real-Time availability of one Inventory item of one Organization.

inventory_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Inventory item to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Item Quantity

type
object
default

error response object

Response Example (200 OK)
{
  "quantity": "number"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

PUT /v1/api/risk/{inventory_id}/availability

Update Real-Time parameters of one Inventory item of one Organization. Parameters for update can include metadata and quantity availability.

Inventory items

quantity: number

quantity of Inventory item that is available

inventory_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Inventory item to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "quantity": "number"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

quality

GET /v1/api/supply/suppliers

Read Suppliers of one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

list of Suppliers

default

error response object

Response Example (200 OK)
[
  {
    "id": "string",
    "name": "string",
    "phone": "string",
    "organization": "string",
    "self": "string",
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    }
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/quality/agencies

Read Agencies of one Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

list of Agencies

default

error response object

Response Example (200 OK)
[
  {
    "id": "string",
    "organization": "string",
    "tests": [
      "string"
    ],
    "name": "string",
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    },
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    }
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/quality/agencies

Batch create Agencies of one Organization.

new Agency to be added for Organization

list of new Agencies to add

NewAgency
Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
[
  {
    "name": "string",
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    },
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    }
  }
]
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

DELETE /v1/api/quality/agencies

Batch remove Agencies of one Organization.

list of Agency public identifiers to remove this action is limited to Admins with permissions

list of Agencies as Ids

string
Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
[
  "string"
]
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/quality/contract/tests

Read Tests by Organization.

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

list of Tests

default

error response object

Response Example (200 OK)
[
  {
    "id": "string",
    "agency": "string",
    "verified": {
      "authorizer": "string",
      "notes": "string",
      "validated": "boolean"
    },
    "organization": "string",
    "name": "string",
    "internalId": "string",
    "notes": "string",
    "results": [
      {
        "value": "number",
        "parameter": "string"
      }
    ],
    "limits": [
      {
        "value": "number",
        "parameter": "string"
      }
    ],
    "expires": "string",
    "inventory": [
      "string"
    ],
    "parent": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/quality/contract/tests

Add Test to Organization Inventory items. Test performed against a known batch of Inventory.

new Test added by Agency

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "organization": "string",
  "name": "string",
  "internalId": "string",
  "notes": "string",
  "results": [
    {
      "value": "number",
      "parameter": "string"
    }
  ],
  "limits": [
    {
      "value": "number",
      "parameter": "string"
    }
  ],
  "expires": "string",
  "inventory": [
    "string"
  ],
  "parent": "string"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/quality/reconciliation

Add on-site testing results for automated reconciliation. Requires Test Report on the Contract under evauation.

new Test added by Agency

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "organization": "string",
  "name": "string",
  "internalId": "string",
  "notes": "string",
  "results": [
    {
      "value": "number",
      "parameter": "string"
    }
  ],
  "limits": [
    {
      "value": "number",
      "parameter": "string"
    }
  ],
  "expires": "string",
  "inventory": [
    "string"
  ],
  "parent": "string"
}
200 OK

reconciliation results

type
object
default

error response object

Response Example (200 OK)
{
  "exception": {
    "id": "string",
    "terms": [
      {
        "files": [
          "string"
        ],
        "recipients": [
          {
            "name": "string",
            "phone": "string",
            "email": "string"
          }
        ],
        "message": "string",
        "term": "string"
      }
    ],
    "formattedPerformanceData": "object",
    "organizations": [
      {
        "id": "string",
        "qr": "string",
        "employees": [
          {
            "0": "string",
            "id": "string",
            "latestBlock": "string",
            "key": "string",
            "operatorPermission": "number",
            "adminPermissions": [
              "number"
            ],
            "organization": "string",
            "email": "string",
            "purpose": "string",
            "name": "string",
            "isOperator": "boolean",
            "isAdmin": "boolean",
            "createdBy": "string"
          }
        ],
        "destinations": [
          {
            "phone": "string",
            "email": "string",
            "authorized": "boolean",
            "authorizedDate": "string"
          }
        ],
        "templates": [
          {
            "name": "string",
            "internalId": "string",
            "thresholds": {
              "type": "string",
              "max": "number",
              "min": "number"
            },
            "audit": "boolean",
            "alert": "boolean",
            "recipients": [
              null
            ]
          }
        ],
        "name": "string",
        "address": {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "lat": "number",
          "lng": "number",
          "formatted": "string"
        },
        "contact": {
          "name": "string",
          "phone": "string",
          "email": "string"
        },
        "metadata": {
          "about": "string",
          "story": "string",
          "founder": "string",
          "established": "string",
          "compliance": "string",
          "regulation": "string",
          "disclosure": "string",
          "notes": "string",
          "miscellaneous": "string"
        },
        "purpose": "string",
        "createdBy": "string"
      }
    ]
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

risk

GET /v1/api/risk/{inventory_id}/availability

Read Real-Time availability of one Inventory item of one Organization.

inventory_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Inventory item to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

Item Quantity

type
object
default

error response object

Response Example (200 OK)
{
  "quantity": "number"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

PUT /v1/api/risk/{inventory_id}/availability

Update Real-Time parameters of one Inventory item of one Organization. Parameters for update can include metadata and quantity availability.

Inventory items

quantity: number

quantity of Inventory item that is available

inventory_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of the Inventory item to find

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "quantity": "number"
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/risk

Update Vendor / Supplier metadata with risk reporting: ( 1 ) Financials ( 2 ) Compliance ( 3 ) Sustainability

Risk items

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "financials": {
    "financials": "string"
  },
  "compliance": {
    "financials": "string"
  },
  "sustainability": {
    "financials": "string"
  }
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/risk/{organization_id}/snapshot

Read Risk report profile of one Supplier.

organization_id
in path
string lyAlyxxgoph8Wq98NQ7r

id of a Block or Contract

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

PDF report

type
string
default

error response object

Response Example (200 OK)
"string"
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

retail

POST /v1/api/retail/reseller

Initiate reseller authentication for Inventory item. Requires details of originating manufacturer and registered Inventory item.

identifiers of Inventory requesting origin permissions from another Organization

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
{
  "manufacturer": {
    "id": "string",
    "raw": {
      "contact": {
        "name": "string",
        "phone": "string",
        "email": "string"
      },
      "address": {
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "lat": "number",
        "lng": "number",
        "formatted": "string"
      }
    }
  },
  "inventory": [
    "string"
  ]
}
200 OK

success response

default

error response object

Response Example (200 OK)
{
  "status": "integer (int32)",
  "message": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

GET /v1/api/retail/marketing

Get Retailer QR code for marketing

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

200 OK

QR code for customer experience

type
string
default

error response object

Response Example (200 OK)
"string"
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

POST /v1/api/retail/marketing

Enhanced marketing metadata for retailer. Ability to produce custom content such as menu display, videos, and other media.

list of media assets to update for customer experience parent Organization must be retailer

Authorization
in header
string Bearer d702f8db802225fe198ae90763d3082552ebbf9b5f85290e4f2b909dfe64f27ed2a416073d94398bd6af27e7fd959fef

Necessary authentication

As-User
in header
string Bearer d803f8eb803675fe198ae90763d3082529iabf9b5f85282j2f2b909dfe64f27ed2a416073k02948jd6af27e7fdhsj182

Make action "as user" (Admin or Operator of one Organization).

Request Example
[
  {
    "type": "string",
    "url": "string"
  }
]
200 OK

QR code for customer experience

type
string
default

error response object

Response Example (200 OK)
"string"
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string"
}

Schema Definitions

Token: object

token: string a292c2e821140c91105804b833446d9254948b28763eb4fe6f4d32ad935febb5112bd1474484d0fecfe862a4e4d37adc

you must store this token to make token bearer authenticated calls

expirationTime: string 2018-04-16T18:00:01.889Z

used to notify user they must log back in to the service and update their token

Example
{
  "token": "string",
  "expirationTime": "string"
}

Success: object

status: integer (int32) 200
message: string success
Example
{
  "status": "integer (int32)",
  "message": "string"
}

Error: object

code: integer (int32)
message: string
Example
{
  "code": "integer (int32)",
  "message": "string"
}

NewOrganization: object

name: string

legal name of the Organization

address: Address

complete mailing address of the Organization

contact: Contact

main point of contact of the Organization

metadata: OrgMetada

public metadata of the Organization

purpose: string manufacturer, vendor, logistics, retailer
createdBy: string

a new Organization can only be created by a SuperUser

Example
{
  "name": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "metadata": {
    "about": "string",
    "story": "string",
    "founder": "string",
    "established": "string",
    "compliance": "string",
    "regulation": "string",
    "disclosure": "string",
    "notes": "string",
    "miscellaneous": "string"
  },
  "purpose": "string",
  "createdBy": "string"
}

Organization:

id: string

hashed identifier used for extramural API calls

qr: string

QR Code representation of the Organization private key provides single point of access to all privileged assets

employees: User

list of Users with direct association to the Organization

User
destinations: ContactDestination

list of email and phone with 2-way auth status for first-priority Organization notifications

ContactDestination
templates: ContractTemplate

basic information relating to the contents that can be reused for new Contracts

ContractTemplate
publicKey: string

permits public actions to occur such as viewing whitelisted metadata

privateKey: string

required for Organization-to-Organization actions against a Contract permits two-way authentication of agreements or changes to a Contract

media: Media
Media
treatments: Treatment

list of Treatments used by this manufacturer for the production of their goods

Treatment
orderRestrictions: Term

list of terms related to the Organization

Term
partnerInventories: Inventory

3rd party Inventory items allowed to be sold by this Organization previously validated reseller Inventory from another Organization

Inventory
partnerWhitelist: Organization

other Organizations that have verified affiliation and permissions to this Organization as a reseller used when this Organization is a manufacturer of Inventory used by another Organization

Organization
partnerPendingApproval: Inventory

other Organization(s) pending approval to this object as a bona fide reseller

partnerBlacklist: Inventory

other Organization(s) that expressly declined to do business with this Organization

approvedPartnerInventory: Organization

other Organizations that have verified affiliation and permissions to this Organization as a reseller used when this Organization is reselling Inventory made by another Organization

Organization
recipientWhitelist: Contact

contact information of other Organizations that have verified affiliation and permissions to this Organization as a reseller

Contact
Example
{
  "id": "string",
  "qr": "string",
  "employees": [
    {
      "0": "string",
      "id": "string",
      "latestBlock": "string",
      "key": "string",
      "operatorPermission": "number",
      "adminPermissions": [
        "number"
      ],
      "organization": "string",
      "email": "string",
      "purpose": "string",
      "name": "string",
      "isOperator": "boolean",
      "isAdmin": "boolean",
      "createdBy": "string"
    }
  ],
  "destinations": [
    {
      "phone": "string",
      "email": "string",
      "authorized": "boolean",
      "authorizedDate": "string"
    }
  ],
  "templates": [
    {
      "name": "string",
      "internalId": "string",
      "thresholds": {
        "type": "string",
        "max": "number",
        "min": "number"
      },
      "audit": "boolean",
      "alert": "boolean",
      "recipients": [
        {
          "phone": "string",
          "email": "string",
          "authorized": "boolean",
          "authorizedDate": "string"
        }
      ],
      "destinations": [
        "string"
      ],
      "policies": [
        {
          "policy": "string",
          "name": "string",
          "contact": "object",
          "actions": [
            {
              "exception": {
                "id": "string"
              }
            }
          ]
        }
      ]
    }
  ],
  "name": "string",
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "metadata": {
    "about": "string",
    "story": "string",
    "founder": "string",
    "established": "string",
    "compliance": "string",
    "regulation": "string",
    "disclosure": "string",
    "notes": "string",
    "miscellaneous": "string"
  },
  "purpose": "string",
  "createdBy": "string"
}

NewUser: object

organization: string

hashed public identifier of the Organization this User belongs to

email: string

unique identifier used for authentication

purpose: string manufacturer, vendor, logistics, retailer
name: string

optional user or namespace full name

isOperator: boolean

this User type has limited permission within the Logistics API

isAdmin: boolean

this User type has high-impact permission within the Base, Supply, and IoT APIs this is the default User type

createdBy: string

identifier of acting User if using the "As-User" header the action is by another User if no "As-User" header and SuperUser isVulnerable then the SuperUser does sign the action

Example
{
  "organization": "string",
  "email": "string",
  "purpose": "string",
  "name": "string",
  "isOperator": "boolean",
  "isAdmin": "boolean",
  "createdBy": "string"
}

User:

id: string

hashed identifier used for extramural API calls

latestBlock: string

latest Block identifier related to User sets on logistics Contracts

key: string

base64 encoded string required when making requests for User initiated actions

Example
{
  "0": "string",
  "id": "string",
  "latestBlock": "string",
  "key": "string",
  "operatorPermission": "number",
  "adminPermissions": [
    "number"
  ],
  "organization": "string",
  "email": "string",
  "purpose": "string",
  "name": "string",
  "isOperator": "boolean",
  "isAdmin": "boolean",
  "createdBy": "string"
}

ContractTemplate: object

name: string

convenience name for template

internalId: string

secondary internal identifier for the template

thresholds: Threshold
audit: boolean

the audit flag identifies if the Contract is eligible for forensic analysis

alert: boolean

the alert flag indicates if the Contract is eligible for batch notifications

recipients: ContactDestination
ContactDestination
destinations: string[]

list of phone number and emails used to make recipients object

string
policies: Insurance

list of insurance policies related to the Contract template

Insurance
parties: string[]

hashed public identifier values of Organizations with privity to the Contract the Organizations can represent any type of logistics partner

string
createdBy: string

identifier of acting User if using the "As-User" header the action is by another User if no "As-User" header and SuperUser isVulnerable then the SuperUser does sign the action

Example
{
  "name": "string",
  "internalId": "string",
  "thresholds": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "audit": "boolean",
  "alert": "boolean",
  "recipients": [
    {
      "phone": "string",
      "email": "string",
      "authorized": "boolean",
      "authorizedDate": "string"
    }
  ],
  "destinations": [
    "string"
  ],
  "policies": [
    {
      "policy": "string",
      "name": "string",
      "contact": "object",
      "actions": [
        {
          "exception": {
            "id": "string",
            "terms": [
              {
                "files": [
                  "string"
                ],
                "recipients": [
                  {
                    "name": "string",
                    "phone": "string",
                    "email": "string"
                  }
                ],
                "message": "string",
                "term": "string"
              }
            ],
            "formattedPerformanceData": "object",
            "organizations": [
              {
                "id": "string",
                "qr": "string",
                "employees": [
                  {
                    "operatorPermission": "number",
                    "adminPermissions": [
                      "number"
                    ],
                    "organization": "string",
                    "email": "string",
                    "purpose": "string",
                    "name": "string",
                    "isOperator": "boolean",
                    "isAdmin": "boolean",
                    "createdBy": "string"
                  }
                ],
                "name": "string",
                "address": {
                  "address1": "string",
                  "address2": "string",
                  "address3": "string",
                  "lat": "number",
                  "lng": "number",
                  "formatted": "string"
                },
                "contact": {
                  "name": "string",
                  "phone": "string",
                  "email": "string"
                },
                "metadata": {
                  "about": "string",
                  "story": "string",
                  "founder": "string",
                  "established": "string",
                  "compliance": "string",
                  "regulation": "string",
                  "disclosure": "string",
                  "notes": "string",
                  "miscellaneous": "string"
                },
                "purpose": "string",
                "createdBy": "string"
              }
            ]
          }
        }
      ]
    }
  ]
}

ContractTemplates: array

Example
[
  {
    "name": "string",
    "internalId": "string",
    "thresholds": {
      "type": "string",
      "max": "number",
      "min": "number"
    },
    "audit": "boolean",
    "alert": "boolean",
    "recipients": [
      {
        "phone": "string",
        "email": "string",
        "authorized": "boolean",
        "authorizedDate": "string"
      }
    ],
    "destinations": [
      "string"
    ],
    "policies": [
      {
        "policy": "string",
        "name": "string",
        "contact": "object",
        "actions": [
          {
            "exception": {
              "id": "string",
              "terms": [
                {
                  "files": [
                    "string"
                  ],
                  "recipients": [
                    {
                      "name": "string",
                      "phone": "string",
                      "email": "string"
                    }
                  ],
                  "message": "string",
                  "term": "string"
                }
              ],
              "formattedPerformanceData": "object",
              "organizations": [
                {
                  "id": "string",
                  "qr": "string",
                  "employees": [
                    {
                      "adminPermissions": [
                        "number"
                      ],
                      "organization": "string",
                      "email": "string",
                      "purpose": "string",
                      "name": "string",
                      "isOperator": "boolean",
                      "isAdmin": "boolean",
                      "createdBy": "string"
                    }
                  ],
                  "name": "string",
                  "address": {
                    "address1": "string",
                    "address2": "string",
                    "address3": "string",
                    "lat": "number",
                    "lng": "number",
                    "formatted": "string"
                  },
                  "contact": {
                    "name": "string",
                    "phone": "string",
                    "email": "string"
                  },
                  "metadata": {
                    "about": "string",
                    "story": "string",
                    "founder": "string",
                    "established": "string",
                    "compliance": "string",
                    "regulation": "string",
                    "disclosure": "string",
                    "notes": "string",
                    "miscellaneous": "string"
                  },
                  "purpose": "string",
                  "createdBy": "string"
                }
              ]
            }
          }
        ]
      }
    ]
  }
]

ContactDestination: object

phone: string
email: string
authorized: boolean
authorizedDate: string
Example
{
  "phone": "string",
  "email": "string",
  "authorized": "boolean",
  "authorizedDate": "string"
}

AuthObject: object

email: string

registered email address of User logging in

password: string

base64 encrypted password associated with User account

Example
{
  "email": "string",
  "password": "string"
}

AdminPermissions: object

adminPermissions: AdminPermission
AdminPermission
Example
{
  "adminPermissions": [
    "number"
  ]
}

AdminPermission: number

these limits apply to Admin only these limits are additive, and admins can have multiple permissions Level 0 all permissions (default, no other permissions necessary) Level 1 permissions to create Contracts Level 2 permissions to create Contracts Templates Level 3 permissions to add Device Level 4 permissions to bind Device to Contracts Templates Level 5 permissions to change Operator permissions and access to Devices

number 0, 1, 2, 3, 4, 5
Example
"number"

OperatorPermission: object

operatorPermission: number 1, 2, 3

these limits apply to Operators only limited Operators need corresponding list of approved Devices: Level 3 permissions allows operator access to any Device and Transaction with any party Level 2 operator can access any Device and limits Transactions to preauthorized parties Level 1 limits operator Device access permissions and limits Transactions to preauthorized parties

Example
{
  "operatorPermission": "number"
}

OperatorWhitelistedDevices: array

list of approved Device identifiers

string
Example
[
  "string"
]

PermissionsObject: object

Example
{
  "admin": {
    "adminPermissions": [
      "number"
    ]
  },
  "operator": {
    "operatorPermission": "number"
  },
  "field": [
    "string"
  ]
}

Identifier: object

id: string
Example
{
  "id": "string"
}

MediaList: array

Example
[
  {
    "type": "string",
    "url": "string"
  }
]

Media: object

type: string image, video, pdf

type of public asset

url: string

URL of the public asset

Example
{
  "type": "string",
  "url": "string"
}

Contact: object

name: string
phone: string
email: string
Example
{
  "name": "string",
  "phone": "string",
  "email": "string"
}

Address: object

address1: string
address2: string
address3: string
lat: number
lng: number
formatted: string
Example
{
  "address1": "string",
  "address2": "string",
  "address3": "string",
  "lat": "number",
  "lng": "number",
  "formatted": "string"
}

OrgMetada: object

about: string
story: string
founder: string
established: string
compliance: string
regulation: string
disclosure: string
notes: string
miscellaneous: string
Example
{
  "about": "string",
  "story": "string",
  "founder": "string",
  "established": "string",
  "compliance": "string",
  "regulation": "string",
  "disclosure": "string",
  "notes": "string",
  "miscellaneous": "string"
}

OrganizationMetadata: object

contact: Contact
address: Address
metadata: OrgMetada
Example
{
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "metadata": {
    "about": "string",
    "story": "string",
    "founder": "string",
    "established": "string",
    "compliance": "string",
    "regulation": "string",
    "disclosure": "string",
    "notes": "string",
    "miscellaneous": "string"
  }
}

OrganizationAvatar: object

avatar: string

URL of public accessible asset

Example
{
  "avatar": "string"
}

OrganizationBanner: object

banner: string

URL of public accessible asset

Example
{
  "banner": "string"
}

MarketingMetadata: object

Example
{
  "avatar": {
    "avatar": "string"
  },
  "banner": {
    "banner": "string"
  },
  "media": [
    {
      "type": "string",
      "url": "string"
    }
  ]
}

NewDevice: object

generic IoT class to cover three major device types ( 1 ) IoT sensors ( 2 ) controllers to power applicances on / off ( 3 ) headless daemons for real-time remote connectivity

deviceID: string

first of three authentication identifiers of the Device identifies the Device at the individual level

topic: string

second of three authentication identifiers of the Device identifies the Device at the operations level

app: string

third of three authentication identifiers of the Device identifies the Device at the topmost function group

internalId: string

additional identifier for internal Organization functions

frequency: number

frequency of Device in seconds for checkin as defined by firmware must be a valid number between 60 and 3600 (maximum one hour periodicity)

nickname: string

Organization convenience identifier of Device

ssid: string

connection hidden network name of headless daemon

password: string

connection password hidden network of headless daemon

sensors: Sensor

access control list of sensor Devices permitted on headless daemon

Sensor
connectors: Connector

access control list of sensor Devices permitted on headless daemon

Connector
Example
{
  "deviceID": "string",
  "topic": "string",
  "app": "string",
  "internalId": "string",
  "frequency": "number",
  "nickname": "string",
  "ssid": "string",
  "password": "string",
  "sensors": [
    {
      "type": "string",
      "key": "string",
      "id": "string"
    }
  ],
  "connectors": [
    {
      "ssid": "string",
      "password": "string",
      "key": "string"
    }
  ]
}

Device:

id: string

hashed identifier used for extramural API calls

key: string

connection key to headless daemon and Devices aggregator

organization: string

public hashed identifier of Organization who owns and provisions Device authentication via MQTT

templates: ContractTemplates

basic information relating to the contents that can be reused for new Contracts a User (isOperator) can create new Contracts provisioned by these templates

ContractTemplates
contracts: string[]

list of Contracts identifiers directly associated with this Device

string
lastPublished: array

last 100 published values of device or logs of headless daemon

notifications: object

notifications configurations of Device

health: number

internal device status as defined by server -1 = no connection 0 = connected, not active 1 = connected and active

batteryStatus: number

internal device battery-life status -1 = no battery life 0 = low battery life 1 = sufficient battery life

lastConnected: string

last known connection ISO date of the device

createdBy: string

identifier of acting User if using the "As-User" header the action is by another User if no "As-User" header and SuperUser isVulnerable then the SuperUser does sign the action

Example
{
  "id": "string",
  "key": "string",
  "organization": "string",
  "templates": [
    [
      {
        "name": "string",
        "internalId": "string",
        "thresholds": {
          "type": "string",
          "max": "number",
          "min": "number"
        },
        "audit": "boolean",
        "alert": "boolean",
        "recipients": [
          {
            "phone": "string",
            "email": "string",
            "authorized": "boolean",
            "authorizedDate": "string"
          }
        ],
        "destinations": [
          "string"
        ],
        "policies": [
          {
            "policy": "string",
            "name": "string",
            "contact": "object",
            "actions": [
              {
                "exception": {
                  "id": "string",
                  "terms": [
                    {
                      "files": [
                        "string"
                      ],
                      "recipients": [
                        {
                          "name": "string",
                          "phone": "string",
                          "email": "string"
                        }
                      ],
                      "message": "string",
                      "term": "string"
                    }
                  ],
                  "formattedPerformanceData": "object",
                  "organizations": [
                    {
                      "name": "string",
                      "address": {
                        "address1": "string",
                        "address2": "string",
                        "address3": "string",
                        "lat": "number",
                        "lng": "number",
                        "formatted": "string"
                      },
                      "contact": {
                        "name": "string",
                        "phone": "string",
                        "email": "string"
                      },
                      "metadata": {
                        "about": "string",
                        "story": "string",
                        "founder": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    ]
  ],
  "deviceID": "string",
  "topic": "string",
  "app": "string",
  "internalId": "string",
  "frequency": "number",
  "nickname": "string",
  "ssid": "string",
  "password": "string",
  "sensors": [
    {
      "type": "string",
      "key": "string",
      "id": "string"
    }
  ],
  "connectors": [
    {
      "ssid": "string",
      "password": "string",
      "key": "string"
    }
  ]
}

Devices: array

Example
[
  {
    "id": "string",
    "key": "string",
    "organization": "string",
    "templates": [
      [
        {
          "name": "string",
          "internalId": "string",
          "thresholds": {
            "type": "string",
            "max": "number",
            "min": "number"
          },
          "audit": "boolean",
          "alert": "boolean",
          "recipients": [
            {
              "phone": "string",
              "email": "string",
              "authorized": "boolean",
              "authorizedDate": "string"
            }
          ],
          "destinations": [
            "string"
          ],
          "policies": [
            {
              "policy": "string",
              "name": "string",
              "contact": "object",
              "actions": [
                {
                  "exception": {
                    "id": "string",
                    "terms": [
                      {
                        "files": [
                          "string"
                        ],
                        "recipients": [
                          {
                            "name": "string",
                            "phone": "string",
                            "email": "string"
                          }
                        ],
                        "message": "string",
                        "term": "string"
                      }
                    ],
                    "formattedPerformanceData": "object",
                    "organizations": [
                      {
                        "name": "string",
                        "address": {
                          "address1": "string",
                          "address2": "string",
                          "address3": "string",
                          "lat": "number",
                          "lng": "number",
                          "formatted": "string"
                        },
                        "contact": {
                          "name": "string",
                          "phone": "string",
                          "email": "string"
                        },
                        "metadata": {
                          "about": "string"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      ]
    ],
    "deviceID": "string",
    "topic": "string",
    "app": "string",
    "internalId": "string",
    "frequency": "number",
    "nickname": "string",
    "ssid": "string",
    "password": "string",
    "sensors": [
      {
        "type": "string",
        "key": "string",
        "id": "string"
      }
    ],
    "connectors": [
      {
        "ssid": "string",
        "password": "string",
        "key": "string"
      }
    ]
  }
]

DeviceData: object

id: string

hashed public identifier of the sensor

type: string temperature, light, motion

type of sensor that acquired data

values: SensorValue

actual sensor reading values

SensorValue
Example
{
  "id": "string",
  "type": "string",
  "values": [
    {
      "value": "number"
    }
  ]
}

SensorValue: object

value: number
Example
{
  "value": "number"
}

DeviceUpdate: object

frequency: number

frequency of checkin to client and/or server (in unit seconds)

internalId: string

convenience internal identifier for the Device

groups: string[]

creates one or more parent or group relationship(s) to the Device

string
templates: ContractTemplates

provision Contract template to the Device for future Logistics Contracts creates a Device is limited to the provisioned templates in it's ability to make Contracts

transaction: Transaction
Example
{
  "frequency": "number",
  "internalId": "string",
  "groups": [
    "string"
  ],
  "templates": [
    {
      "name": "string",
      "internalId": "string",
      "thresholds": {
        "type": "string",
        "max": "number",
        "min": "number"
      },
      "audit": "boolean",
      "alert": "boolean",
      "recipients": [
        {
          "phone": "string",
          "email": "string",
          "authorized": "boolean",
          "authorizedDate": "string"
        }
      ],
      "destinations": [
        "string"
      ],
      "policies": [
        {
          "policy": "string",
          "name": "string",
          "contact": "object",
          "actions": [
            {
              "exception": {
                "id": "string",
                "terms": [
                  {
                    "files": [
                      "string"
                    ],
                    "recipients": [
                      {
                        "name": "string",
                        "phone": "string",
                        "email": "string"
                      }
                    ],
                    "message": "string",
                    "term": "string"
                  }
                ],
                "formattedPerformanceData": "object",
                "organizations": [
                  {
                    "id": "string",
                    "qr": "string",
                    "employees": [
                      {
                        "organization": "string",
                        "email": "string",
                        "purpose": "string",
                        "name": "string",
                        "isOperator": "boolean",
                        "isAdmin": "boolean",
                        "createdBy": "string"
                      }
                    ],
                    "name": "string",
                    "address": {
                      "address1": "string",
                      "address2": "string",
                      "address3": "string",
                      "lat": "number",
                      "lng": "number",
                      "formatted": "string"
                    },
                    "contact": {
                      "name": "string",
                      "phone": "string",
                      "email": "string"
                    },
                    "metadata": {
                      "about": "string",
                      "story": "string",
                      "founder": "string",
                      "established": "string",
                      "compliance": "string",
                      "regulation": "string",
                      "disclosure": "string",
                      "notes": "string",
                      "miscellaneous": "string"
                    },
                    "purpose": "string",
                    "createdBy": "string"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

Sensor: object

type: string temperature, motion, light

type of sensor (temperature = humidity + temperature)

key: string

sensor group identifier

id: string

sesnsor individual identifier

Example
{
  "type": "string",
  "key": "string",
  "id": "string"
}

BindConnector: object

internalIds: string[]
string

list of sensor Device identifiers the Devices are restricted to operate on a closed local network Devices can no longer be configured for access point (AP) config

connector: string

identifier of the connector Device to bind the list of Device Ids connector Device must be typeof connector for this operation to succeed

Example
{
  "internalIds": [
    "string"
  ],
  "connector": "string"
}

Connector: object

ssid: string

local network name

password: string

local network password

key: string

local network handshake key

Example
{
  "ssid": "string",
  "password": "string",
  "key": "string"
}

Contracts: array

Example
[
  {
    "id": "string",
    "goods": [
      {
        "name": "string",
        "sku": "string",
        "dimensions": {
          "itemLength": "number",
          "itemWidth": "number",
          "itemHeight": "number",
          "itemWeight": "number",
          "itemWeightUnits": "string",
          "shippingLength": "number",
          "shippingWidth": "number",
          "shippingHeight": "number",
          "shippingWeight": "number",
          "shippingWeightUnits": "string"
        },
        "media": [
          {
            "type": "string",
            "url": "string"
          }
        ],
        "inventory": [
          {
            "unit": "string",
            "quantity": "number",
            "manufacturer": {
              "id": "string",
              "raw": {}
            },
            "treatments": [
              {
                "id": "string",
                "metadata": {
                  "vendor": "string",
                  "name": "string",
                  "batchInfo": "string",
                  "purpose": "string",
                  "dosage": "string",
                  "additional": "string",
                  "contact": "string"
                },
                "hidden": "boolean"
              }
            ],
            "notes": "string",
            "id": "string"
          }
        ]
      }
    ],
    "inventory": [
      "string"
    ],
    "location": [
      "number"
    ],
    "origination": {
      "city": "string",
      "state": "string",
      "country": "string",
      "time": "string",
      "jurisdiction": "string",
      "statute": "string"
    },
    "name": "string",
    "internalId": "string",
    "connector": "string",
    "thresholds": {
      "type": "string",
      "max": "number",
      "min": "number"
    },
    "lightSensitive": "boolean",
    "motionSensitive": "boolean",
    "temperatureSensitive": "boolean",
    "destinationTime": "string",
    "destinationContact": "string",
    "destinationLocation": [
      "number"
    ],
    "destinationAddress": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    },
    "organization": "string",
    "recipient": "string"
  }
]

NewSupplier: object

Supplier exists when an Organization tries to create or change a Contract with an unregistered entity the Organization in process of creating a Contract may create new entities as Suppliers a Supplier object is used to consolidate data once final registration of an Organization occurs

name: string

convenience name of the Organization as Supplier

phone: string
organization: string

hashed identifier of the Organization that created this entry

self: string

hashed identifier of the reference to self as Organization

contact: Contact

contact information of Supplier

address: Address

detailed address of Supplier

Example
{
  "name": "string",
  "phone": "string",
  "organization": "string",
  "self": "string",
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  }
}

Supplier:

Example
{
  "id": "string",
  "name": "string",
  "phone": "string",
  "organization": "string",
  "self": "string",
  "contact": {
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "address": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  }
}

Suppliers: array

Example
[
  {
    "id": "string",
    "name": "string",
    "phone": "string",
    "organization": "string",
    "self": "string",
    "contact": {
      "name": "string",
      "phone": "string",
      "email": "string"
    },
    "address": {
      "address1": "string",
      "address2": "string",
      "address3": "string",
      "lat": "number",
      "lng": "number",
      "formatted": "string"
    }
  }
]

NewInventory: object

a supplier or manufacturer's inventory list the Inventory object contains Real-Time data the Inventory object is used to dispatch orders as a "Good" outlined elsewhere

category: string

group information about this Inventory item

superCategory: string

parent relationship added to this Inventory item

basicInfo: ProductData

general manufacturer details about Inventory item

productionMetadata: TreatmentDetails

Inventory production treatments details

TreatmentDetails
guidelines: Guidelines

list of manufacturer suggested recommendations and usage information for Inventory items

legal: Disclaimer
media: Media

public or private media assets related to the Inventory object

Media
scheduleB: string

schedule B number if domestically produced in USA and intended for export

quantity: number

Real-Time availability data for placing orders of this Inventory item

sku: string

scan access to this Inventory item

dimensions: Dimension

per unit dimensional data related to this Inventory item

organization: string

Organization hashed identifier that owns this Inventory item

manufacturer: Manufacturer

hashed public identifier of registered Organization

Example
{
  "category": "string",
  "superCategory": "string",
  "basicInfo": {
    "shelfLife": "string",
    "unitPrice": "string",
    "description": "string"
  },
  "productionMetadata": [
    {
      "vendor": "string",
      "name": "string",
      "batchInfo": "string",
      "purpose": "string",
      "dosage": "string",
      "additional": "string",
      "contact": "string"
    }
  ],
  "guidelines": {
    "tempMin": "number",
    "tempMax": "number",
    "lightSensitive": "boolean",
    "motionSensitive": "boolean",
    "handlingInstructions": "string",
    "normalUsage": "string",
    "productAllergies": "string"
  },
  "legal": {
    "disclaimer": "string",
    "limitations": "string",
    "notes": "string"
  },
  "media": [
    {
      "type": "string",
      "url": "string"
    }
  ],
  "scheduleB": "string",
  "quantity": "number",
  "sku": "string",
  "dimensions": {
    "itemLength": "number",
    "itemWidth": "number",
    "itemHeight": "number",
    "itemWeight": "number",
    "itemWeightUnits": "string",
    "shippingLength": "number",
    "shippingWidth": "number",
    "shippingHeight": "number",
    "shippingWeight": "number",
    "shippingWeightUnits": "string"
  },
  "organization": "string",
  "manufacturer": {
    "id": "string",
    "raw": {
      "contact": {
        "name": "string",
        "phone": "string",
        "email": "string"
      },
      "address": {
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "lat": "number",
        "lng": "number",
        "formatted": "string"
      }
    }
  }
}

Inventory:

id: string

hashed identifier used for extramural API calls

Example
{
  "id": "string",
  "category": "string",
  "superCategory": "string",
  "basicInfo": {
    "shelfLife": "string",
    "unitPrice": "string",
    "description": "string"
  },
  "productionMetadata": [
    {
      "vendor": "string",
      "name": "string",
      "batchInfo": "string",
      "purpose": "string",
      "dosage": "string",
      "additional": "string",
      "contact": "string"
    }
  ],
  "guidelines": {
    "tempMin": "number",
    "tempMax": "number",
    "lightSensitive": "boolean",
    "motionSensitive": "boolean",
    "handlingInstructions": "string",
    "normalUsage": "string",
    "productAllergies": "string"
  },
  "legal": {
    "disclaimer": "string",
    "limitations": "string",
    "notes": "string"
  },
  "media": [
    {
      "type": "string",
      "url": "string"
    }
  ],
  "scheduleB": "string",
  "quantity": "number",
  "sku": "string",
  "dimensions": {
    "itemLength": "number",
    "itemWidth": "number",
    "itemHeight": "number",
    "itemWeight": "number",
    "itemWeightUnits": "string",
    "shippingLength": "number",
    "shippingWidth": "number",
    "shippingHeight": "number",
    "shippingWeight": "number",
    "shippingWeightUnits": "string"
  },
  "organization": "string",
  "manufacturer": {
    "id": "string",
    "raw": {
      "contact": {
        "name": "string",
        "phone": "string",
        "email": "string"
      },
      "address": {
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "lat": "number",
        "lng": "number",
        "formatted": "string"
      }
    }
  }
}

Inventories: array

list of Inventory items of one Organization

Inventory
Example
[
  {
    "id": "string",
    "category": "string",
    "superCategory": "string",
    "basicInfo": {
      "shelfLife": "string",
      "unitPrice": "string",
      "description": "string"
    },
    "productionMetadata": [
      {
        "vendor": "string",
        "name": "string",
        "batchInfo": "string",
        "purpose": "string",
        "dosage": "string",
        "additional": "string",
        "contact": "string"
      }
    ],
    "guidelines": {
      "tempMin": "number",
      "tempMax": "number",
      "lightSensitive": "boolean",
      "motionSensitive": "boolean",
      "handlingInstructions": "string",
      "normalUsage": "string",
      "productAllergies": "string"
    },
    "legal": {
      "disclaimer": "string",
      "limitations": "string",
      "notes": "string"
    },
    "media": [
      {
        "type": "string",
        "url": "string"
      }
    ],
    "scheduleB": "string",
    "quantity": "number",
    "sku": "string",
    "dimensions": {
      "itemLength": "number",
      "itemWidth": "number",
      "itemHeight": "number",
      "itemWeight": "number",
      "itemWeightUnits": "string",
      "shippingLength": "number",
      "shippingWidth": "number",
      "shippingHeight": "number",
      "shippingWeight": "number",
      "shippingWeightUnits": "string"
    },
    "organization": "string",
    "manufacturer": {
      "id": "string",
      "raw": {
        "contact": {
          "name": "string",
          "phone": "string",
          "email": "string"
        },
        "address": {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "lat": "number",
          "lng": "number",
          "formatted": "string"
        }
      }
    }
  }
]

NewContract: object

Contracts can initiate a block or append to an existing block they contain the details of non-linear parameters that are the basis of automations Contracts undergo evaluation to issue Exceptions Exceptions contain Actions that represent the automations themselves

inventory: string[]

list of hashed identifiers relating to the Goods managed under this Contract

string
location: Location
origination: Essence

details provided by the Contract or User (isOperator) includes essential details of formation such as location, date, jurisdiction, and statute of limitations

name: string

convenience parameter for query or interface purposes

internalId: string

secondary convenience parameter for query or interface purposes

connector: string

identifier of connector Device for IoT contracts

thresholds: Threshold

Threshold object maintained by source of Good specified recommended handling guidelines

lightSensitive: boolean

flag for whether the logistics of Goods is light sensitive

motionSensitive: boolean

flag for whether the logistics of Goods is motion sensitive

temperatureSensitive: boolean

flag for whether the logistics of Goods is temperature sensitive

destinationTime: string

ISO date performance is expected to be due or complete

destinationContact: string

name of expected final recipient

destinationLocation: number[]

geolocation of final destination

number
destinationAddress: Address

address of final destination

organization: string

hashed identifier of the Organization creating the Contract

recipient: string

hashed identifier of the intended recipient of this Contract

Example
{
  "inventory": [
    "string"
  ],
  "location": [
    "number"
  ],
  "origination": {
    "city": "string",
    "state": "string",
    "country": "string",
    "time": "string",
    "jurisdiction": "string",
    "statute": "string"
  },
  "name": "string",
  "internalId": "string",
  "connector": "string",
  "thresholds": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "lightSensitive": "boolean",
  "motionSensitive": "boolean",
  "temperatureSensitive": "boolean",
  "destinationTime": "string",
  "destinationContact": "string",
  "destinationLocation": [
    "number"
  ],
  "destinationAddress": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "organization": "string",
  "recipient": "string"
}

Contract:

id: string
goods: Good

list of Goods managed under this Contract

Good
isValidated: boolean

signifies a valid agreement (Contract) was formed

isActive: boolean

signifies Performance exists and is ongoing

isComplete: boolean

signifies the completion of a Contract

dispatchTime: string

ISO date performance actually started

qr: string

access to the Contract evaluates permissions via authentication public may view whitelisted data User with privity may view details nested Contracts (Legs) have their own permissions scope Contract owner is privity to entire dataset

Example
{
  "id": "string",
  "goods": [
    {
      "name": "string",
      "sku": "string",
      "dimensions": {
        "itemLength": "number",
        "itemWidth": "number",
        "itemHeight": "number",
        "itemWeight": "number",
        "itemWeightUnits": "string",
        "shippingLength": "number",
        "shippingWidth": "number",
        "shippingHeight": "number",
        "shippingWeight": "number",
        "shippingWeightUnits": "string"
      },
      "media": [
        {
          "type": "string",
          "url": "string"
        }
      ],
      "inventory": [
        {
          "unit": "string",
          "quantity": "number",
          "manufacturer": {
            "id": "string",
            "raw": {
              "contact": {}
            }
          },
          "treatments": [
            {
              "id": "string",
              "metadata": {
                "vendor": "string",
                "name": "string",
                "batchInfo": "string",
                "purpose": "string",
                "dosage": "string",
                "additional": "string",
                "contact": "string"
              },
              "hidden": "boolean"
            }
          ],
          "notes": "string",
          "id": "string"
        }
      ]
    }
  ],
  "inventory": [
    "string"
  ],
  "location": [
    "number"
  ],
  "origination": {
    "city": "string",
    "state": "string",
    "country": "string",
    "time": "string",
    "jurisdiction": "string",
    "statute": "string"
  },
  "name": "string",
  "internalId": "string",
  "connector": "string",
  "thresholds": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "lightSensitive": "boolean",
  "motionSensitive": "boolean",
  "temperatureSensitive": "boolean",
  "destinationTime": "string",
  "destinationContact": "string",
  "destinationLocation": [
    "number"
  ],
  "destinationAddress": {
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "lat": "number",
    "lng": "number",
    "formatted": "string"
  },
  "organization": "string",
  "recipient": "string"
}

NewGood: object

one or more Inventory items dispatched as part of a purchase order

name: string

convenience name of this group of Inventory items

sku: string

scan access to this Inventories order set

dimensions: Dimension

shipping data related to this grouped order of Inventory items

media: Media

public or private media assets related to the Good object

Media
inventory: UnitOrder

the list of Inventory items making up this Order

UnitOrder
guidelines: Guidelines

list of manufacturer suggested recommendations and usage information for Inventory items

Guidelines
legal: Disclaimer

compiled list of legal disclaimers relating to the Inventory items in this object

Disclaimer
threshold: Threshold

master threshold object that reduced the individual thresholds of the Inventory items of this object

preferences: string low, medium, high, critical

priority scheduler of this object for the parent Organization

expiration: string

ISO date of expiration of a non-recurring Good object

Example
{
  "name": "string",
  "sku": "string",
  "dimensions": {
    "itemLength": "number",
    "itemWidth": "number",
    "itemHeight": "number",
    "itemWeight": "number",
    "itemWeightUnits": "string",
    "shippingLength": "number",
    "shippingWidth": "number",
    "shippingHeight": "number",
    "shippingWeight": "number",
    "shippingWeightUnits": "string"
  },
  "media": [
    {
      "type": "string",
      "url": "string"
    }
  ],
  "inventory": [
    {
      "unit": "string",
      "quantity": "number",
      "manufacturer": {
        "id": "string",
        "raw": {
          "contact": {
            "name": "string",
            "phone": "string",
            "email": "string"
          },
          "address": {
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "lat": "number",
            "lng": "number",
            "formatted": "string"
          }
        }
      },
      "product": {
        "shelfLife": "string",
        "unitPrice": "string",
        "description": "string"
      },
      "treatments": [
        {
          "id": "string",
          "metadata": {
            "vendor": "string",
            "name": "string",
            "batchInfo": "string",
            "purpose": "string",
            "dosage": "string",
            "additional": "string",
            "contact": "string"
          },
          "hidden": "boolean"
        }
      ],
      "notes": "string",
      "id": "string"
    }
  ],
  "guidelines": [
    {
      "tempMin": "number",
      "tempMax": "number",
      "lightSensitive": "boolean",
      "motionSensitive": "boolean",
      "handlingInstructions": "string",
      "normalUsage": "string",
      "productAllergies": "string"
    }
  ],
  "legal": [
    {
      "disclaimer": "string",
      "limitations": "string",
      "notes": "string"
    }
  ],
  "threshold": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "preferences": "string",
  "expiration": "string"
}

Good:

id: string

hashed identifier used for extramural API calls

qr: string

QR access to this object's report Organizations with privity have permitted access to internal data parent Organization has access to entire data also acts as a point of onboarding for a User & Organization during logistics

created: string

ISO date (time and day) object was created

organization: string

public hashed identifier of Organization that made this Contract

Example
{
  "id": "string",
  "qr": "string",
  "created": "string",
  "organization": "string",
  "name": "string",
  "sku": "string",
  "dimensions": {
    "itemLength": "number",
    "itemWidth": "number",
    "itemHeight": "number",
    "itemWeight": "number",
    "itemWeightUnits": "string",
    "shippingLength": "number",
    "shippingWidth": "number",
    "shippingHeight": "number",
    "shippingWeight": "number",
    "shippingWeightUnits": "string"
  },
  "media": [
    {
      "type": "string",
      "url": "string"
    }
  ],
  "inventory": [
    {
      "unit": "string",
      "quantity": "number",
      "manufacturer": {
        "id": "string",
        "raw": {
          "contact": {
            "name": "string",
            "phone": "string",
            "email": "string"
          },
          "address": {
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "lat": "number",
            "lng": "number",
            "formatted": "string"
          }
        }
      },
      "product": {
        "shelfLife": "string",
        "unitPrice": "string",
        "description": "string"
      },
      "treatments": [
        {
          "id": "string",
          "metadata": {
            "vendor": "string",
            "name": "string",
            "batchInfo": "string",
            "purpose": "string",
            "dosage": "string",
            "additional": "string",
            "contact": "string"
          },
          "hidden": "boolean"
        }
      ],
      "notes": "string",
      "id": "string"
    }
  ],
  "guidelines": [
    {
      "tempMin": "number",
      "tempMax": "number",
      "lightSensitive": "boolean",
      "motionSensitive": "boolean",
      "handlingInstructions": "string",
      "normalUsage": "string",
      "productAllergies": "string"
    }
  ],
  "legal": [
    {
      "disclaimer": "string",
      "limitations": "string",
      "notes": "string"
    }
  ],
  "threshold": {
    "type": "string",
    "max": "number",
    "min": "number"
  },
  "preferences": "string",
  "expiration": "string"
}

UnitOrder:

Inventory item is compiled with it's Treatment data and associated details for a dispatched Order.

unit: string

unit name of the current Inventory item