Global API

Organizations

The soft-check probe and registration itself

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

Method	Path	Operation
GET	`/api/organizations/soft-check`	Soft check
POST	`/api/organizations`	Register organization

Soft check

GET/api/organizations/soft-check

Pre-registration probe: does a global user with this email already exist?

Access. This operation needs no authentication.

Parameters

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

Response

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

Request

curl -X GET "https://global.miridia.io/api/organizations/soft-check"

Response

{
  "data": true,
  "statusCode": 0,
  "messages": [
    "string"
  ]
}

Register organization

POST/api/organizations

Access. This operation needs no authentication.

Request body

Send JSON with the shape RegisterOrganizationRequest. Do not rename or restructure fields without updating that form.

Field	Type	Required
`business`	`RegisterOrganizationBusinessRequest`	Yes
`user`	`RegisterOrganizationUserRequest`	Yes
`fulfillmentTypes`	`string[]`	No
`addOns`	`string[]`	No

Response

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

Request

curl -X POST "https://global.miridia.io/api/organizations" \
  -H "Content-Type: application/json" \
  -d '{
  "business": {
    "registeredName": "string",
    "displayName": "string",
    "phoneNumber": "string",
    "website": "string",
    "email": "name@example.com",
    "registrationNumber": "string",
    "requiresOrderIntegration": true,
    "requiresOrderFulfillment": true,
    "requiresAccountingIntegration": true,
    "requiresDispatchBuilder": true,
    "multipleBranches": true,
    "address": {
      "placeId": "string",
      "name": "string",
      "website": "string",
      "fullAddress": "string",
      "street": "string",
      "suburb": "string",
      "city": "string",
      "country": "string",
      "postcode": "string",
      "unit": "string",
      "number": "string",
      "province": "string",
      "latitude": 0,
      "longitude": 0
    }
  },
  "user": {
    "firstName": "string",
    "lastName": "string",
    "email": "name@example.com",
    "phoneNumber": "string",
    "password": "string",
    "confirmPassword": "string",
    "acceptedTerms": true
  },
  "fulfillmentTypes": [
    "string"
  ],
  "addOns": [
    "string"
  ]
}'

Response

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registeredName": "string",
    "registrationNumber": "string",
    "displayName": "string",
    "phoneNumber": "string",
    "website": "string",
    "email": "string",
    "requiresOrderIntegration": true,
    "requiresOrderFulfillment": true,
    "requiresAccountingIntegration": true,
    "requiresDispatchBuilder": true,
    "billingAddress": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "placeId": "string",
      "name": "string",
      "website": "string",
      "fullAddress": "string",
      "street": "string",
      "suburb": "string",
      "city": "string",
      "country": "string",
      "postcode": "string",
      "unit": "string",
      "number": "string",
      "province": "string",
      "latitude": 0,
      "longitude": 0
    },
    "currentUser": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string"
    }
  },
  "statusCode": 0,
  "messages": [
    "string"
  ]
}

Models

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

RegisterOrganizationAddressRequest

Field	Type	Description
`placeId`	`string`
`name`	`string`
`website`	`string`
`fullAddress`	`string`
`street`	`string`
`suburb`	`string`
`city`	`string`
`country`	`string`
`postcode`	`string`
`unit`	`string`
`number`	`string`
`province`	`string`
`latitude`	`number (double)`
`longitude`	`number (double)`

RegisterOrganizationAddressResponse

Field	Type	Description
`id`	`string (uuid)`
`placeId`	`string`
`name`	`string`
`website`	`string`
`fullAddress`	`string`
`street`	`string`
`suburb`	`string`
`city`	`string`
`country`	`string`
`postcode`	`string`
`unit`	`string`
`number`	`string`
`province`	`string`
`latitude`	`number (double)`
`longitude`	`number (double)`

RegisterOrganizationBusinessRequest

Field	Type	Description
`registeredName`	`string`	Limits: maximum 100 characters.
`displayName`	`string`	Limits: maximum 50 characters.
`phoneNumber`	`string`
`website`	`string`	Limits: maximum 100 characters.
`email`	`string (email)`
`registrationNumber`	`string`	Limits: maximum 30 characters.
`requiresOrderIntegration`	`boolean`
`requiresOrderFulfillment`	`boolean`
`requiresAccountingIntegration`	`boolean`
`requiresDispatchBuilder`	`boolean`
`multipleBranches`	`boolean`
`address`	`RegisterOrganizationAddressRequest`

RegisterOrganizationBusinessResponse

Field	Type	Description
`id`	`string (uuid)`
`registeredName`	`string`
`registrationNumber`	`string`
`displayName`	`string`
`phoneNumber`	`string`
`website`	`string`
`email`	`string`
`requiresOrderIntegration`	`boolean`
`requiresOrderFulfillment`	`boolean`
`requiresAccountingIntegration`	`boolean`
`requiresDispatchBuilder`	`boolean`
`billingAddress`	`RegisterOrganizationAddressResponse`
`currentUser`	`RegisterOrganizationUserSummary`

RegisterOrganizationUserRequest

Field	Type	Description
`firstName`	`string`
`lastName`	`string`
`email`	`string (email)`
`phoneNumber`	`string`
`password`	`string`
`confirmPassword`	`string`
`acceptedTerms`	`boolean`

RegisterOrganizationUserSummary

Field	Type	Description
`id`	`string (uuid)`
`displayName`	`string`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`

Authentication

The global-side auth routes

Users