Business Unit Management api (v1)

Download OpenAPI specification:Download

API to manage Business Units.

Authentication

Bearer

JWT Authorization header using the Bearer scheme.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Groups

Groups follow the following template; https://server/api/v1/tenants/{tenantId}/groups

GroupsGet

Authorizations:
path Parameters
tenantId
required
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GroupCreate

Authorizations:
path Parameters
tenantId
required
any
Request Body schema: application/json
Name
string

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "Name": "string",
  • "FullPath": "string",
  • "Id": "string"
}

SubGroupsGet

Authorizations:
path Parameters
tenantId
required
any
id
required
any

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "FullPath": "string",
  • "Id": "string"
}

SubGroupUpdate

Authorizations:
path Parameters
tenantId
required
any
id
required
any
Request Body schema: application/json
Name
string

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "Name": "string",
  • "FullPath": "string",
  • "Id": "string"
}

SubGroupDelete

Authorizations:
path Parameters
tenantId
required
any
id
required
any

Responses

SubGroupsGet

Authorizations:
path Parameters
tenantId
required
any
id
required
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SubGroupCreate

Authorizations:
path Parameters
tenantId
required
any
id
required
any
Request Body schema: application/json
Name
string

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "Name": "string",
  • "FullPath": "string",
  • "Id": "string"
}

GetStores

Authorizations:
path Parameters
tenantId
required
any
id
required
any

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AddStore

Authorizations:
path Parameters
tenantId
required
any
id
required
any
Request Body schema: application/json
string (String)

Responses

Request samples

Content type
application/json
"string"

RemoveStore

Authorizations:
path Parameters
tenantId
required
any
id
required
any
storeId
required
any

Responses

BusinessUnits

Get all business units for a tenant

Authorizations:
path Parameters
tenantId
required
string Nullable

Responses

Response samples

Content type
No sample

Creates a business unit on a tenant

Authorizations:
path Parameters
tenantId
required
string Nullable
Request Body schema:
externalId
string Nullable

The external Id of this business unit

name
string Nullable

Name of unit

gln
string Nullable

Global location number

status
string Nullable

Status

object (Date)
object (Date)

Responses

Request samples

Content type
{ }

Response samples

Content type
No sample

Gets a specific business unit based on tenant and id.

Authorizations:
path Parameters
tenantId
required
string Nullable
id
required
string Nullable

Responses

Response samples

Content type
No sample

Updates a business unit on a tenant

Authorizations:
path Parameters
tenantId
required
string Nullable

The tenant id

id
required
string Nullable

The business unit document id

Request Body schema:
externalId
string Nullable

The external Id of this business unit

name
string Nullable

Name of unit

gln
string Nullable

Global location number

status
string Nullable

Status

object (Date)
object (Date)

Responses

Request samples

Content type
{ }

Response samples

Content type
No sample

Delete a business unit. Should only be used by testing

Authorizations:
path Parameters
tenantId
required
string Nullable
id
required
string Nullable

Responses

Get top level group type for a tenant

Authorizations:
path Parameters
tenantId
required
string Nullable
query Parameters
typeId
string Nullable

Responses

Response samples

Content type
No sample

Link types with groups

Authorizations:
path Parameters
tenantId
required
string Nullable
Request Body schema:
groupId
string Nullable
typeId
string Nullable

Responses

Request samples

Content type
{ }

Response samples

Content type
No sample

GroupTypes

Get all types

Authorizations:

Responses

Response samples

Content type
No sample

Link a type with a group

Authorizations:
Request Body schema:
id
string Nullable

The type identifier

name
string Nullable

Name of type

Responses

Request samples

Content type
{ }

Response samples

Content type
No sample

Get a single group type

Authorizations:
path Parameters
id
required
string Nullable

Responses

Response samples

Content type
No sample