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

Recommendations

GET::/shop/v1/recommendations Deprecated

Authorizations:
query Parameters
limit
integer
variantIds
Array of strings <uuid>

List of variant uuids to filter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET::/shop/v1/recommendations/v2

Authorizations:
query Parameters
limit
integer
variantIds
Array of strings <uuid>

List of variant uuids to filter.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GET::/shop/v1/recommendations/{recommendationTypeParameter}

Authorizations:
path Parameters
recommendationTypeParameter
required
string (recommendationTypeParameterSchema) non-empty
Enum: "last_viewed_variants" "last_searched_terms" "most_bought_variant" "product_list" "recent_orders"

Type of the recommendation.

query Parameters
limit
integer
variantIds
Array of strings <uuid>

List of variant uuids to filter.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "recommendations": [
    ]
}

Customer

Creates new JWT Token for the selected Channel.

Authorizations:
path Parameters
channelId
required
string

Uuid of the channel which should be used.

Responses

Response samples

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

Registers a new Customer.

Authorizations:
Request Body schema: application/json
type
required
string
Enum: "personal" "company"
number
string or null

Number will be generated if not provided

company
string or null

Field will be required when type=company.

email
string
password
string
channel
string
clientFields
object (RegisterClientFieldCollection)
firstName
required
string
lastName
required
string
gender
required
string
object or null

Responses

Request samples

Content type
application/json
{
  • "type": "personal",
  • "number": "xyz-1000",
  • "company": "Lyska",
  • "email": "erika.musterfrau@lyska.io",
  • "password": "p4$$w0rd",
  • "channel": "cfb89b73-670e-46de-acee-77d31cc5e6ea",
  • "clientFields": { },
  • "firstName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "extendedInformation": {
    }
}

Updates a Customer.

Authorizations:
Request Body schema: application/json
clientFields
object (CustomerClientFieldCollection)
companyName
string or null

Mandatory (not blank) if customerType is set to company.

type
required
string
Enum: "personal" "company"
channel
string or null

Responses

Request samples

Content type
application/json
{
  • "clientFields": { },
  • "companyName": "Lyska",
  • "type": "personal",
  • "channel": "string"
}

Completes registration and activates new User.

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

Responses

Request samples

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

Refreshes secret and sends new email.

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

Responses

Request samples

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

Retrieves a collection of BillingInformation resources for the current Customer.

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "addresses": [
    ]
}

Creates a new BillingInformation resource.

Authorizations:
Request Body schema: application/json
id
string non-empty
street
required
string non-empty
postalCode
required
string non-empty
city
required
string non-empty
region
string or null non-empty
country
required
string non-empty
postOfficeBoxNumber
string or null non-empty
clientFields
object (BillingInformationClientFieldCollection)
label
required
string non-empty
company
string or null non-empty
email
string or null non-empty
phone
string or null non-empty
notes
string or null non-empty
vatId
string or null non-empty
firstName
string or null non-empty
lastName
string or null non-empty
gender
string or null non-empty

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "street": "string",
  • "postalCode": "string",
  • "city": "string",
  • "region": "string",
  • "country": "string",
  • "postOfficeBoxNumber": "string",
  • "clientFields": { },
  • "label": "string",
  • "company": "string",
  • "email": "string",
  • "phone": "string",
  • "notes": "string",
  • "vatId": "string",
  • "firstName": "Jack",
  • "lastName": "Bauer",
  • "gender": "diverse"
}

Response samples

Content type
application/json