Administration

Configurations

The configurations operations of the Core API.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/settings/business`	Get all business configurations
PATCH	`/api/settings/business`	Save business app configuration
GET	`/api/customer/configurations`	Get all business customer app configurations
POST	`/api/customer/{customerId}/configuration`	Save business customer app configuration
GET	`/api/settings/{module}`	Get business configurations by module

Get all business configurations

GET/api/settings/business

Access. Send a bearer token or an API key. The caller needs the Settings view permission.

Parameters

Name	In	Type	Required	Description
`keys`	query	`string`	No

Response

200. Returns a PagedResult envelope. Each item in data is AppConfigurationResponse.

Request

curl -X GET "https://api.miridia.io/api/settings/business" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "count": 0,
  "totalCount": 0,
  "page": 0,
  "finalPage": 0,
  "pageSize": 0,
  "hasMore": true,
  "statusCode": "OK",
  "data": [
    {
      "key": "string",
      "value": "string",
      "displayName": "string"
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Save business app configuration

PATCH/api/settings/business

Access. Send a bearer token or an API key. The caller needs the Settings modify permission.

Request body

Send JSON of type map<string, string>.

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X PATCH "https://api.miridia.io/api/settings/business" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "string"
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get all business customer app configurations

GET/api/customer/configurations

Access. Send a bearer token or an API key. The caller needs the Settings view permission.

Parameters

Name	In	Type	Required	Description
`customerId`	query	`string (uuid)`	No

Response

200. Returns a JSON array. Each item is BusinessCustomerAppConfigurationResponse.

Request

curl -X GET "https://api.miridia.io/api/customer/configurations" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

[
  {
    "key": "string",
    "value": "string",
    "displayName": "string",
    "active": true
  }
]

Save business customer app configuration

POST/api/customer/{customerId}/configuration

Access. Send a bearer token or an API key. The caller needs the Settings modify permission.

Parameters

Name	In	Type	Required	Description
`customerId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape SaveCustomerAppConfigurationCommand.

Field	Type	Required
`customerId`	`string (uuid)`	No
`key`	`string`	No
`value`	`string`	No

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X POST "https://api.miridia.io/api/customer/{customerId}/configuration" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": "string",
  "value": "string"
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get business configurations by module

GET/api/settings/{module}

Access. Send a bearer token or an API key. The caller needs the Settings view permission.

Parameters

Name	In	Type	Required	Description
`module`	path	`enum PermissionModule`	Yes	One of: `Orders`, `Shipments`, `Customers`, `Products`, `Vehicles`, `Integrations`, `TeamAndRoles`, `Billing`, `Workflows`, `Settings`, `Insights`, `Suppliers`, `PurchaseOrders`, `WorkOrders`, `TransferOrders`, `Schedule`.

Response

200. Returns a JSON array. Each item is BusinessAppConfigurationResponse.

Request

curl -X GET "https://api.miridia.io/api/settings/{module}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

[
  {
    "key": "string",
    "value": "string",
    "displayName": "string",
    "active": true,
    "editable": true
  }
]

Models

The operations on this page use these object types. Select a type to see its fields.

AppConfigurationResponse

Field	Type	Description
`key`	`string`
`value`	`string`
`displayName`	`string`

BusinessAppConfigurationResponse

Field	Type	Description
`key`	`string`
`value`	`string`
`displayName`	`string`
`active`	`boolean`
`editable`	`boolean`

BusinessCustomerAppConfigurationResponse

Field	Type	Description
`key`	`string`
`value`	`string`
`displayName`	`string`
`active`	`boolean`

Businesses

The businesses operations of the Core API.

Roles

Manages the business roles and their permission matrices.