Fragment Catalog
listing
Listing team reusable fragments
Listing fragments API documentation
API documentation for Listing Fragments
OAS 3.1.0
v1
Compliance Report
Validation of OpenAPI specifications against CWF fragment requirements.
4 Errors
133 Warnings
3 Info
Show:
Listing fragments API documentation
{
"namespace": "listing",
"description": "Listing team reusable fragments",
"specifications": [
{
"id": "v1",
"type": "openapi_v3",
"openapi": {
"openapi": "3.1.0",
"info": {
"title": "Listing fragments API documentation",
"description": "API documentation for Listing Fragments",
"version": "v1"
},
"servers": [],
"paths": {
"/{market}/{language}/listing/fragments/smart-compare/": {
"get": {
"operationId": "smart-compare",
"description": "Smart comparison with AI",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/head/": {
"get": {
"operationId": "head",
"description": "Head fragment for listing fragments. This contains JS and CSS resources for the fragments",
"responses": {
"200": {
"description": "Always returns 200, even if no fragments are found",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "fragments",
"schema": {
"$ref": "#/components/schemas/headFragmentsQuery"
},
"required": true
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-id-carousel/": {
"get": {
"operationId": "product-id-carousel",
"description": "The product id carousel is used when you want to specify a static manual list of product ids. It's recommend to not go over 16 products in 1 carousel.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "products",
"schema": {
"type": "string",
"example": "10576898,00257298,90510262,80132799,50454908,80214549"
},
"required": true,
"description": "Comma-separated list of product IDs"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"example": "test-variant",
"type": "string"
},
"description": "Force specific A/B test variant"
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"example": "mobile",
"type": "string"
},
"description": "Device type (mobile, tablet, desktop)"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-group-carousel/{group}/": {
"get": {
"operationId": "product-group-carousel",
"description": "Product group carousel fragment",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "group",
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/carousel/{type}/": {
"get": {
"operationId": "carousel",
"description": "The primary area carousel is used when you want render a list of products based on a query to SIK.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "q",
"schema": {
"type": "string",
"example": "billy"
},
"required": true,
"description": "type = search -> query, type = category -> categoryId, type = special -> new-products, family-offers, lower-price, last-chance, lowest-price, limited-time-offers, best-sellers, limited-edition, index"
},
{
"in": "query",
"name": "filters",
"schema": {
"example": "color:blue",
"type": "string"
},
"description": "Filter parameter"
},
{
"in": "query",
"name": "sort",
"schema": {
"default": "RELEVANCE",
"example": "RELEVANCE",
"type": "string",
"enum": [
"RATING",
"RELEVANCE",
"LENGTH",
"NEWEST",
"PRICE_LOW_TO_HIGH",
"WIDTH",
"MOST_POPULAR",
"NAME_ASCENDING",
"HEIGHT",
"DEPTH",
"PRICE_HIGH_TO_LOW",
"DISCOUNT_PERCENTAGE_HIGH_TO_LOW"
]
},
"description": "Sort parameter"
},
{
"in": "query",
"name": "page",
"schema": {
"example": 1,
"default": 1,
"type": "number",
"exclusiveMinimum": 0
},
"required": true,
"description": "Page parameter"
},
{
"in": "query",
"name": "allowAutocorrect",
"schema": {
"default": false,
"type": "boolean"
}
},
{
"in": "query",
"name": "maxAmountOfProducts",
"schema": {
"example": 16,
"default": 16,
"type": "number",
"exclusiveMinimum": 0
},
"required": true,
"description": "Max amount of products"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"default": null,
"example": "test-variant",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": "Force AB test"
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"example": "mobile",
"type": "string"
},
"description": "Device type"
},
{
"in": "path",
"name": "type",
"schema": {
"type": "string",
"enum": [
"search",
"cat",
"special"
]
},
"required": true
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/grid/{type}/": {
"get": {
"operationId": "grid",
"description": "Renders a grid of products based on a query to SIK",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "type",
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-information-card/": {
"get": {
"operationId": "product-information-card",
"description": "Product Information Card fragment, will render product information based on input product ID",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "productId",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"example": "test-variant",
"type": "string"
},
"description": "Force specific A/B test variant"
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"example": "mobile",
"type": "string"
},
"description": "Device type (mobile, tablet, desktop)"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-grid/{type}/": {
"get": {
"operationId": "product-rec-grid",
"description": "Product recommendation grid fragment",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "type",
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/abtest/": {
"get": {
"operationId": "ab-test-fragment",
"description": "A/B test fragment",
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/exp/rewards-promotion/": {
"get": {
"operationId": "rewards-promotion",
"description": "Rewards promotion fragment (experimental)",
"deprecated": true,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "value",
"schema": {
"type": "number",
"example": 349
},
"required": true,
"description": "Rewards value to display"
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "market",
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "language",
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/exp/buyer-protections/": {
"get": {
"operationId": "buyer-protections",
"description": "Buyer protections fragment (experimental)",
"deprecated": true,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "productId",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "market",
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "language",
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/exp/offer-countdown/": {
"get": {
"operationId": "offer-countdown",
"description": "Offer countdown fragment (experimental)",
"deprecated": true,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "productId",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "market",
"required": true
},
{
"schema": {
"type": "string"
},
"in": "path",
"name": "language",
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/similar-products/": {
"get": {
"operationId": "similar-products",
"description": "Similar products based on a given base product.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "baseProduct",
"schema": {
"type": "string",
"example": "12345"
},
"required": true,
"description": "ikea product id"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/frequently-bought-together/": {
"get": {
"operationId": "frequently-bought-together",
"description": "Products frequently purchased together with the base product.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "baseProduct",
"schema": {
"type": "string",
"example": "12345"
},
"required": true,
"description": "ikea product id"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/recommended-for-you/": {
"get": {
"operationId": "recommended-for-you",
"description": "Personalized product recommendations for the user.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "baseProduct",
"schema": {
"type": "string"
},
"description": "ikea product id"
},
{
"in": "query",
"name": "episodId",
"schema": {
"type": "string"
},
"description": "Episode ID"
},
{
"in": "query",
"name": "userJwt",
"schema": {
"type": "string"
},
"description": "User JWT Token"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/accessories/": {
"get": {
"operationId": "accessories",
"description": "Accessories related to the specified product.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "baseProduct",
"schema": {
"type": "string",
"example": "12345"
},
"required": true,
"description": "ikea product id"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/more-from/": {
"get": {
"operationId": "more-from",
"description": "More items from the same range, series or collection.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "baseProduct",
"schema": {
"type": "string",
"example": "12345"
},
"required": true,
"description": "ikea product id"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/replacement-recommendations/": {
"get": {
"operationId": "replacement-recommendations",
"description": "Suggestions for replacing or upgrading a product.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "baseProduct",
"schema": {
"type": "string",
"example": "12345"
},
"required": true,
"description": "ikea product id"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/home-page-new/": {
"get": {
"operationId": "home-page-new",
"description": "New arrivals for home page exposure.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/easy-picks/": {
"get": {
"operationId": "easy-picks",
"description": "Curated easy picks based on general popularity.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "userJWT",
"schema": {
"type": "string"
},
"description": "User JWT token"
},
{
"in": "query",
"name": "episodId",
"schema": {
"type": "string"
},
"description": "Episode ID"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/popular/": {
"get": {
"operationId": "popular",
"description": "Popular items within a category context.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "categoryIds",
"schema": {
"example": "cat1,cat2",
"type": "string"
},
"description": "Comma separated category IDs"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/breathtaking-items/": {
"get": {
"operationId": "breathtaking-items",
"description": "High-impact “breathtaking” items.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "categoryIds",
"schema": {
"example": "cat1,cat2",
"type": "string"
},
"description": "Comma separated category IDs"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/new-lower-price/": {
"get": {
"operationId": "new-lower-price",
"description": "Items recently reduced in price.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "categoryIds",
"schema": {
"example": "cat1,cat2",
"type": "string"
},
"description": "Comma separated category IDs"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/family-price/": {
"get": {
"operationId": "family-price",
"description": "Family-price items within the category context.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "categoryIds",
"schema": {
"example": "cat1,cat2",
"type": "string"
},
"description": "Comma separated category IDs"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/add-to-cart/": {
"get": {
"operationId": "add-to-cart",
"description": "Complementary products to add together with the base product.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "baseProduct",
"schema": {
"type": "string",
"example": "12345"
},
"required": true,
"description": "ikea product id"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
},
"/{market}/{language}/listing/fragments/product-rec-carousel/recently-viewed/": {
"get": {
"operationId": "recently-viewed",
"description": "Products the user recently viewed.",
"tags": [
"composer",
"reusable"
],
"deprecated": false,
"responses": {
"200": {
"description": "Successful call to fragment",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "minProducts",
"schema": {
"example": 3,
"default": "4",
"type": "string"
},
"description": "minProducts will make the recommendation return an empty list if the number of viewed items do not exceed the minimum amount."
},
{
"in": "query",
"name": "maxProducts",
"schema": {
"example": 24,
"default": "24",
"type": "string"
},
"description": "maxProducts will shorten the list of viewed items if the amount of recently viewed items exceed this limits"
},
{
"in": "query",
"name": "sikForceAb",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "deviceType",
"schema": {
"default": "mobile",
"type": "string"
}
},
{
"in": "query",
"name": "episodId",
"schema": {
"type": "string"
},
"description": "Episode ID"
},
{
"in": "query",
"name": "userJwt",
"schema": {
"type": "string"
},
"description": "User JWT token"
},
{
"in": "path",
"name": "market",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
},
{
"in": "path",
"name": "language",
"schema": {
"$ref": "#/components/schemas/schema"
},
"required": true
}
]
}
}
},
"components": {
"schemas": {
"headFragmentsQuery": {
"type": "string",
"description": "Comma separated list of fragment names",
"param": {
"in": "query",
"name": "headFragmentsQuery",
"ref": "headFragmentsQuery"
},
"enum": [
"carousel",
"grid",
"product-id-carousel",
"product-group-carousel",
"product-rec-carousel",
"product-information-card",
"product-rec-grid",
"rewards-promotion",
"buyer-protections",
"offer-countdown",
"ab-test-fragment",
"smart-compare"
]
}
}
}
}
}
]
}