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

Customer Config

Adds a PaymentConfig to a Customer.

Authorizations:
path Parameters
customerId
required
string
paymentConfigId
required
string

Responses

Removes a PaymentConfig from a Customer.

Authorizations:
path Parameters
customerId
required
string
paymentConfigId
required
string

Responses

Retrieves a collection of Channel and Customer PaymentConfig resources.

Authorizations:
path Parameters
customerId
required
string

Responses

Customer

Retrieves a collection of Customer resources.

Authorizations:
query Parameters
page
integer
Default: "1"

If page and offset parameters are provided, the offset will be preferred.

filter[id]
Array of strings <uuid>
filter[email]
Array of strings <string>
filter[channel]
Array of strings <uuid>
search
string >= 3 characters
order[postalCode]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"
order[billingPostalCode]
string
Enum: "asc" "desc"
offset
integer
Default: "0"

If page and offset parameters are provided, the offset will be preferred.

limit
integer
Default: "20"

Max items per page.

Responses

Retrieves a Customer resource in detail.

Authorizations:
path Parameters
id
required
string

Customer ID

Responses

Activates a Customer.

If the customer is waiting for an approval his registration will be approved and he receives a notification.

Authorizations:
path Parameters
id
required
string

Customer ID

Responses

Deactivates a Customer.

If the customer is waiting for an approval his registration will be rejected and he receives a notification.

Authorizations:
path Parameters
id
required
string

Customer ID

Responses

Re-sends an invitation notification to a Customer.

Authorizations:
path Parameters
id
required
string

Responses

Discount

Sets a Discount for a Customer.

Authorizations:
Request Body schema: application/json
id
required
string
customerId
required
string
discount
object (Percentage)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "discount": { }
}

Removes a Discount from a Customer.

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

Responses

Request samples

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

Order

Retrieves a collection of Order resources.

Authorizations:
query Parameters
page
integer
Default: "1"

If page and offset parameters are provided, the offset will be preferred.

filter[id]
Array of strings <string>
filter[purchaseOrderNumber]
Array of strings <string>
filter[status]
Array of strings <string>
filter[paymentStatus]
Array of strings <string>
filter[channel]
Array of strings <string>
filter[email]
Array of strings <string>
filter[name]
Array of strings <string>
filter[customerId]
Array of strings <uuid>
filter[number]
Array of strings <string>
filter[userId]
Array of strings <string>
filter[userEmail]
Array of strings <string>