Lyska Cloud API (dev)

Download OpenAPI specification:Download

This is an awesome API!

Authentication

apiKey

Security Scheme Type API Key
Header parameter name: X-API-KEY

jwt

Value: Bearer [token]

Security Scheme Type API Key
Header parameter name: Authorization

Administrator

GET::/admin/v1/administrators/current-user

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ],
  • "isAllowedToUseAgentLogin": true
}

GET::/admin/v1/administrators

Authorizations:
query Parameters
search
any
page
integer
offset
integer
limit
integer

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "administrators": [
    ]
}

POST::/admin/v1/administrators

Authorizations:
Request Body schema: application/json
email
required
string <email>
roles
required
Array of any non-empty non-empty [ items ]
Items Enum: "ROLE_ADMIN" "ROLE_ADMIN_USER" "ROLE_SUPER_ADMIN" "ROLE_AGENT_LOGIN"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ],
  • "isAllowedToUseAgentLogin": true
}

DELETE::/admin/v1/administrators

Authorizations:
Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

GET::/admin/v1/administrators/{email}

Authorizations:
path Parameters
email
required
string <email>

Responses

Response samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ],
  • "isAllowedToUseAgentLogin": true
}

Returns a collection of restricted channels.

Authorizations:
path Parameters
email
required
string <email>

Responses

Response samples

Content type
application/json
{
  • "channels": [
    ]
}

Sets a restriction for given admin and channels. Will replace the restriction when any other exists.

By setting this restriction the admin is only allowed to operate on channels (including the customers) which are included in this list. For example setting a configuration for a payment or shipping method.

Authorizations:
path Parameters
email
required
string <email>
Request Body schema: application/json
channels
required
Array of strings <uuid> non-empty

Responses

Request samples

Content type
application/json
{
  • "channels": [
    ]
}

Deletes all channel restrictions for given admin.

Authorizations:
path Parameters
email
required
string <email>

Responses

Triggers a password reset notification for the given administrator.

Authorizations:
path Parameters
email
required
string <email>

Responses

POST::/admin/v1/administrators/set-password

Authorizations:
Request Body schema: application/json
password
required
string

The new password

token
required
string

The validation token

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "token": "string"
}

Agent Login

Allows admin users to request a token for the user with the given email.

Authorizations:
path Parameters
email
required
string <email>

Email to identify the user that should be used for the login.

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Customer Config

Adds a PaymentConfig to a Customer.

Authorizations:
path Parameters
customerId
required
string
paymentConfigId
required
string

Responses

Response samples

Content type
application/json
{
  • "shippingConfigIds": [
    ],
  • "paymentConfigIds": [
    ],
  • "defaultChannelPricesAllowed": true
}

Removes a PaymentConfig from a Customer.

Authorizations:
path Parameters
customerId
required
string
paymentConfigId
required
string

Responses

Response samples

Content type
application/json
{
  • "shippingConfigIds": [
    ],
  • "paymentConfigIds": [
    ],
  • "defaultChannelPricesAllowed": true
}

Retrieves a collection of Channel and Customer PaymentConfig resources.

Authorizations:
path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "paymentConfigs": [
    ]
}

Customer

Retrieves a collection of Customer resources.

Authorizations:
query Parameters
page
integer
filter[id]
Array of strings <uuid>
filter[email]
Array of strings <string>
filter[channel]
Array of strings <uuid>
filter
any
search
string >= 3 characters
order[postalCode]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"
order[billingPostalCode]
string
Enum: "asc" "desc"
order
any
offset
integer
limit
integer

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "customers": [