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

CommerceConnectorVariantFeed

Builds an CommerceConnector-compatible CSV feed.

Authorizations:
query Parameters
variantUrl
string <uri> (variantUrlSchema)

Base url which should be used for variant URL generation.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :variantId: => will be replaced with the short uuid of the variant
  • :variantSlug: => will be replaced with the slug of the variant

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adcell

Builds an adcell-compatible CSV feed.

Authorizations:
query Parameters
productUrl
string <uri> (productUrlSchema)

Base url which should be used for generating product URLs.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :productSlug: => will be replaced with a slug of the product name
  • :productId: => will be replaced with the short uuid of the product
  • :productSku: => will be replaced with the SKU of the product
  • :variantSku: => will be replaced with the SKU of the main variant from the product
  • :mainVariantId: => will be replaced with the short uuid of the main variant from the product
  • :mainVariantSlug: => will be replaced with the slug of the main variant from the product

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses

Response samples

Content type
application/json
[
  • { }
]

EmarsysProductFeed

Builds an Emarsys-compatible CSV feed.

Authorizations:
query Parameters
productUrl
string <uri> (productUrlSchema)

Base url which should be used for generating product URLs.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :productSlug: => will be replaced with a slug of the product name
  • :productId: => will be replaced with the short uuid of the product
  • :productSku: => will be replaced with the SKU of the product
  • :variantSku: => will be replaced with the SKU of the main variant from the product
  • :mainVariantId: => will be replaced with the short uuid of the main variant from the product
  • :mainVariantSlug: => will be replaced with the slug of the main variant from the product

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GoogleProductFeed

Builds a Google Product Feed xml.

Authorizations:
query Parameters
productUrl
string <uri> (productUrlSchema)

Base url which should be used for generating product URLs.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :productSlug: => will be replaced with a slug of the product name
  • :productId: => will be replaced with the short uuid of the product
  • :productSku: => will be replaced with the SKU of the product
  • :variantSku: => will be replaced with the SKU of the main variant from the product
  • :mainVariantId: => will be replaced with the short uuid of the main variant from the product
  • :mainVariantSlug: => will be replaced with the slug of the main variant from the product

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses

GuenstigerDeFeed

Build a tsv for guenstiger.de feed.

Authorizations:
path Parameters
channelId
required
string

Channel to use for the feed for product visibilty, prices, etc.

query Parameters
productUrl
string <uri> (productUrlSchema)

Base url which should be used for generating product URLs.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :productSlug: => will be replaced with a slug of the product name
  • :productId: => will be replaced with the short uuid of the product
  • :productSku: => will be replaced with the SKU of the product
  • :variantSku: => will be replaced with the SKU of the main variant from the product
  • :mainVariantId: => will be replaced with the short uuid of the main variant from the product
  • :mainVariantSlug: => will be replaced with the slug of the main variant from the product

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Response samples

Content type
application/json
[
  • {
    }
]

Idealo

Builds an idealo-compatible CSV feed.

Authorizations:
path Parameters
assortmentId
required
string

Only products of this assortments will rendered.

query Parameters
productUrl
string <uri> (productUrlSchema)

Base url which should be used for generating product URLs.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :productSlug: => will be replaced with a slug of the product name
  • :productId: => will be replaced with the short uuid of the product
  • :productSku: => will be replaced with the SKU of the product
  • :variantSku: => will be replaced with the SKU of the main variant from the product
  • :mainVariantId: => will be replaced with the short uuid of the main variant from the product
  • :mainVariantSlug: => will be replaced with the slug of the main variant from the product

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sitemap

Builds a index sitemap which links to all other existing sitemaps.

Authorizations:
query Parameters
brandUrl
string <uri> (brandUrlSchema)

Base url which should be used for location information. Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :brandId: => will be replaced with the short uuid of the brand
  • :brandSlug: => will be replaced with the slug of the brand

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

productUrl
string <uri> (productUrlSchema)

Base url which should be used for generating product URLs.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :productSlug: => will be replaced with a slug of the product name
  • :productId: => will be replaced with the short uuid of the product
  • :productSku: => will be replaced with the SKU of the product
  • :variantSku: => will be replaced with the SKU of the main variant from the product
  • :mainVariantId: => will be replaced with the short uuid of the main variant from the product
  • :mainVariantSlug: => will be replaced with the slug of the main variant from the product

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

taxonomyUrl
string <uri> (taxonomyUrlSchema)

Base url which should be used for location information. Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :taxonomyId: => will be replaced with the short uuid of the taxonomy
  • :taxonomySlug: => will be replaced with the slug of the taxonomy

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses

Builds a sitemap for brands.

Authorizations:
query Parameters
brandUrl
string <uri> (brandUrlSchema)

Base url which should be used for location information. Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :brandId: => will be replaced with the short uuid of the brand
  • :brandSlug: => will be replaced with the slug of the brand

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses

Builds a sitemap for taxonomys.

Authorizations:
query Parameters
taxonomyUrl
string <uri> (taxonomyUrlSchema)

Base url which should be used for location information. Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :taxonomyId: => will be replaced with the short uuid of the taxonomy
  • :taxonomySlug: => will be replaced with the slug of the taxonomy

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses

Builds a sitemap for products.

Authorizations:
query Parameters
productUrl
string <uri> (productUrlSchema)

Base url which should be used for generating product URLs.

Can contain the following placeholders:

  • :channelBaseUrl: => will be replaced with base URL of the channel
  • :productSlug: => will be replaced with a slug of the product name
  • :productId: => will be replaced with the short uuid of the product
  • :productSku: => will be replaced with the SKU of the product
  • :variantSku: => will be replaced with the SKU of the main variant from the product
  • :mainVariantId: => will be replaced with the short uuid of the main variant from the product
  • :mainVariantSlug: => will be replaced with the slug of the main variant from the product

For example:

NOTE: if you do NOT provide this parameter, the backend will attempt to generate a frontend URL based on the current channel and some defaults. It is highly endorsed to provide this parameter at all times.

Responses