Logistics

Fulfilment

The fulfilment 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/fulfillments/fulfillment-sub-types`	Get fulfillment sub types
GET	`/api/fulfillments/fulfillment-types`	Get fulfillment types
GET	`/api/fulfillments/fulfillment-requirements`	Get fulfillment requirement types
GET	`/api/fulfillments/fulfillment-service-delivery-types`	Get fulfillment service delivery types
DELETE	`/api/fulfillments/service-level-templates/{serviceLevelTemplateId}`	Delete service level template
GET	`/api/fulfillments/service-level-templates`	Get service level templates
POST	`/api/fulfillments/service-level-templates`	Add service level template

Get fulfillment sub types

GET/api/fulfillments/fulfillment-sub-types

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

Response

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

Request

curl -X GET "https://api.miridia.io/api/fulfillments/fulfillment-sub-types" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

[
  {
    "id": 0,
    "fulfillmentTypeId": 0,
    "value": "string"
  }
]

Get fulfillment types

GET/api/fulfillments/fulfillment-types

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

Response

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

Request

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

Response

[
  {
    "id": 0,
    "value": "string"
  }
]

Get fulfillment requirement types

GET/api/fulfillments/fulfillment-requirements

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

Response

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

Request

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

Response

[
  {
    "id": 0,
    "value": "string"
  }
]

Get fulfillment service delivery types

GET/api/fulfillments/fulfillment-service-delivery-types

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

Response

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

Request

curl -X GET "https://api.miridia.io/api/fulfillments/fulfillment-service-delivery-types" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

[
  {
    "id": 0,
    "value": "string",
    "description": "string"
  }
]

Delete service level template

DELETE/api/fulfillments/service-level-templates/{serviceLevelTemplateId}

Access. Send a bearer token or an API key. The caller needs the Orders delete permission.

Parameters

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

Response

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

Request

curl -X DELETE "https://api.miridia.io/api/fulfillments/service-level-templates/{serviceLevelTemplateId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

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 service level templates

GET/api/fulfillments/service-level-templates

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

Response

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

Request

curl -X GET "https://api.miridia.io/api/fulfillments/service-level-templates" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "price": 0,
    "serviceLevel": "string",
    "timeWindow": "string",
    "description": "string"
  }
]

Add service level template

POST/api/fulfillments/service-level-templates

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

Request body

Send JSON with the shape ServiceLevelTemplate.

Field	Type	Required	Description
`id`	`string (uuid)`	No
`title`	`string`	Yes
`price`	`number (double)`	No	Limits: minimum 0.
`serviceLevel`	`string`	Yes
`timeWindow`	`string`	Yes
`description`	`string`	Yes

Response

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

Request

curl -X POST "https://api.miridia.io/api/fulfillments/service-level-templates" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "price": 0,
  "serviceLevel": "string",
  "timeWindow": "string",
  "description": "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
}

Models

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

FulfillmentRequirementTypeResponse

Field	Type	Description
`id`	`integer (int32)`
`value`	`string`

FulfillmentServiceLevelResponse

Field	Type	Description
`id`	`integer (int32)`
`value`	`string`
`description`	`string`

FulfillmentSubTypeResponse

Field	Type	Description
`id`	`integer (int32)`
`fulfillmentTypeId`	`integer (int32)`
`value`	`string`

FulfillmentTypeResponse

Field	Type	Description
`id`	`integer (int32)`
`value`	`string`

ServiceLevelTemplate

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`price`	`number (double)`	Limits: minimum 0.
`serviceLevel`	`string`
`timeWindow`	`string`
`description`	`string`

Dimension presets

The dimension presets operations of the Core API.

Schedules

The schedules operations of the Core API.