The shop API empowers developers to build amazing new apps or websites using Zalando shop data and services.
Resources
articles
Zalando API ArticleReviewsSummaries Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
articleModelId
|
string |
To get unique reviews summary from article model Id. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Reviews-Summary
|
object |
Zalando API Article Reviews Summary Schema |
Properties
starRatingDistribution
|
||
numberOfUserReviews
|
integer |
number of user reviews of the article |
numberOfUserRecommendations
|
integer |
number of users recommended to the article |
numberOfUserPositiveRecommendations
|
integer |
number of positive recommendations to the article |
averageStarRating
|
double |
average star rating of the article |
articleSizeRatings
|
||
articleModelId
|
string |
Examples
Example application/json
[
{
"articleModelId": "K4411C00Y",
"averageStarRating": 4,
"numberOfUserReviews": 1,
"starRatingDistribution": {
"1": 0,
"2": 0,
"3": 0,
"4": 1,
"5": 0
},
"numberOfUserRecommendations": 0,
"numberOfUserPositiveRecommendations": 0
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Reviews Summaries Schema
Request
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
pageSize
|
string |
to request with required page size in a page |
page
|
string |
to request with required page number or pagination |
articleModelId
|
array |
Article model IDs. A list of model SKUs for which the article review summaries will be returned. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Reviews-Summaries
|
object |
Zalando API Paged Article Reviews Summaries Schema |
Properties
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Examples
Example application/json
[
{
"content": [
{
"articleModelId": "K4411C00Y",
"averageStarRating": 4,
"numberOfUserReviews": 1,
"starRatingDistribution": {
"1": 0,
"2": 0,
"3": 0,
"4": 1,
"5": 0
},
"numberOfUserRecommendations": 0,
"numberOfUserPositiveRecommendations": 0
}
]
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API ArticleReviews Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
reviewId
|
string |
To get unique review by review Id. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Review
|
object |
Zalando API Article Review Schema |
Properties
unhelpfulCount
|
integer |
customer review unhelpful count of the article |
title
|
string |
title in the article review |
reviewId
|
string |
unique article review id |
recommend
|
boolean |
customer recommend to the article |
rating
|
integer |
customer rating of the article |
language
|
string |
language in the article review |
helpfulCount
|
integer |
customer review helpful count of the article |
description
|
string |
description of the article review |
customerNickname
|
string |
Customer short name in the article review |
customerCountry
|
string |
customer country in the article review |
customerCity
|
string |
customer city in the article review |
created
|
dateTime |
article review created date and time |
articleSizeRatings
|
||
articleModelId
|
string | |
articleId
|
string |
Examples
Example application/json
[
{
"title": "Dream turned to reality in the blink of an eye!",
"rating": 5,
"created": "2015-07-23T17:52:14+02:00",
"language": "en",
"reviewId": "4405383-EW012B00C-C11",
"articleId": "EW012B00C-C11",
"recommend": false,
"description": "Very nice trainers, with an extremely prompt arrival...",
"customerCity": "Brixton",
"helpfulCount": 0,
"articleModelId": "EW012B00C",
"unhelpfulCount": 0,
"customerCountry": "GB",
"articleSizeRatings": {
"OVERALL": 3,
"SHOE_WIDTH": 3
}
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Reviews Schema
Request
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
pageSize
|
string |
to request with required page size in a page |
page
|
string |
to request with required page number or pagination |
sort
|
string Default value: newestAllowed values: - newest- best- worst- most_helpful |
articles are sorted on reviews provided by customers (eg: best) |
maxStarRating
|
string |
To get reviews with maximum star rating. |
minStarRating
|
string |
To get reviews with minimum star rating. |
articleModelId
|
array |
Article model IDs. A list of model SKUs for which the article reviews will be returned. Required if articleId is empty. |
articleId
|
array |
Article IDs. A list of config SKUs for which the article reviews will be returned. Required if articleModelId is empty. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Reviews
|
object |
Zalando API Paged Article Reviews Schema |
Properties
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Examples
Example application/json
[
{
"content": [
{
"title": "Dream turned to reality in the blink of an eye!",
"rating": 5,
"created": "2015-07-23T17:52:14+02:00",
"language": "en",
"reviewId": "4405383-EW012B00C-C11",
"articleId": "EW012B00C-C11",
"recommend": false,
"description": "Very nice trainers, with an extremely prompt arrival... ",
"customerCity": "Brixton",
"helpfulCount": 0,
"articleModelId": "EW012B00C",
"unhelpfulCount": 0,
"customerCountry": "GB",
"articleSizeRatings": {
"OVERALL": 3,
"SHOE_WIDTH": 3
}
}
]
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
articleId
|
string |
To get unique article for article Id media. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Media
|
object |
Zalando API Article Media Schema |
Properties
images
|
array [Article-Image] | ||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||
Examples
Example application/json
[
{
"images": [
{
"type": "NON_MODEL",
"largeUrl": "https:\/\/i2.ztat.net\/large\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"smallUrl": "https:\/\/i2.ztat.net\/catalog\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"mediumUrl": "https:\/\/i2.ztat.net\/detail\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"largeHdUrl": "https:\/\/i2.ztat.net\/large_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"smallHdUrl": "https:\/\/i2.ztat.net\/catalog_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"mediumHdUrl": "https:\/\/i2.ztat.net\/detail_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"orderNumber": 1,
"thumbnailHdUrl": "https:\/\/i2.ztat.net\/thumb_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg"
}
]
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
articleId
|
string |
To get unique article for article Id reviews summary. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Reviews-Summary
|
object |
Zalando API Article Reviews Summary Schema |
Properties
starRatingDistribution
|
||
numberOfUserReviews
|
integer |
number of user reviews of the article |
numberOfUserRecommendations
|
integer |
number of users recommended to the article |
numberOfUserPositiveRecommendations
|
integer |
number of positive recommendations to the article |
averageStarRating
|
double |
average star rating of the article |
articleSizeRatings
|
||
articleModelId
|
string |
Examples
Example application/json
[
{
"articleModelId": "EW012B00C",
"averageStarRating": 5,
"articleSizeRatings": {
"OVERALL": 3,
"SHOE_WIDTH": 3
},
"numberOfUserReviews": 1,
"starRatingDistribution": {
"1": 0,
"2": 0,
"3": 0,
"4": 0,
"5": 1
},
"numberOfUserRecommendations": 1,
"numberOfUserPositiveRecommendations": 0
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
articleId
|
string |
To get unique article for article Id reviews. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
pageSize
|
string |
to request with required page size in a page |
page
|
string |
to request with required page number or pagination |
sort
|
string Default value: newestAllowed values: - newest- best- worst- most_helpful |
articles are sorted on reviews provided by customers (eg: best) |
maxStarRating
|
string |
To get reviews with maximum star rating. |
minStarRating
|
string |
To get reviews with minimum star rating. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Reviews
|
object |
Zalando API Paged Article Reviews Schema |
Properties
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Examples
Example application/json
[
{
"page": 1,
"size": 1,
"content": [
{
"title": "Dream turned to reality in the blink of an eye!",
"rating": 5,
"created": "2015-07-23T17:52:14+02:00",
"language": "en",
"reviewId": "4405383-EW012B00C-C11",
"articleId": "EW012B00C-C11",
"recommend": false,
"description": "Very nice trainers, with an extremely prompt arrival...",
"customerCity": "Brixton",
"helpfulCount": 0,
"articleModelId": "EW012B00C",
"unhelpfulCount": 0,
"customerCountry": "GB",
"articleSizeRatings": {
"OVERALL": 3,
"SHOE_WIDTH": 3
}
}
],
"totalPages": 1,
"totalElements": 1
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
unitId
|
string |
To get unique article for article Id unit. |
articleId
|
string |
To get unique article for article Id. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article-Unit
|
object |
Zalando API Article Unit Schema |
Properties
stock
|
integer |
stock of the article |
|||||||||||||
size
|
string |
article size |
|||||||||||||
price
|
Article-Price | ||||||||||||||
Properties
|
|||||||||||||||
partnerId
|
string |
partner id (vendor id) of the article |
|||||||||||||
originalPrice
|
Article-Price | ||||||||||||||
Properties
|
|||||||||||||||
id
|
string |
article id (sku) |
|||||||||||||
available
|
boolean |
availability of the article |
|||||||||||||
Examples
Example application/json
[
{
"id": "TC021A00J-A110040000",
"size": "14",
"price": {
"value": 65,
"currency": "GBP",
"formatted": "\u00a365.00"
},
"stock": 0,
"available": false,
"originalPrice": {
"value": 130,
"currency": "GBP",
"formatted": "\u00a3130.00"
}
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
articleId
|
string |
To get unique article for article Id units. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Article-Units
|
array [Article-Unit] |
Zalando API Article Units Schema |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
Example application/json
[
{
"id": "TC021A00J-A110040000",
"size": "14",
"price": {
"value": 65,
"currency": "GBP",
"formatted": "\u00a365.00"
},
"stock": 0,
"available": false,
"originalPrice": {
"value": 130,
"currency": "GBP",
"formatted": "\u00a3130.00"
}
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Article Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
articleId
|
string |
To get unique article for article Id. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Article
|
object |
A single article |
Properties
units
|
array [Article-Unit] |
price of the article |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
array [string] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shopUrl
|
uri |
url of the article within the Zalando webshop |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
seasonYear
|
string Pattern: ^ALL$|^20[0-9]{2}$
|
collection year the article belongs to. Could be either a year or 'ALL' |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
season
|
string Allowed values: - SUMMER- WINTER- ALL |
collection season the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
article name |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
modelId
|
string |
unique article model id |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
media
|
Article-Media | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
unique article id |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
genders
|
array [string] Allowed values: - MALE- FEMALE |
gender of the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
color
|
string |
the main color of the article |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
categoryKeys
|
array [string] |
category keys of the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
brand
|
Brand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
available
|
boolean |
will be true if at least one article unit is available |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attributes
|
array [Article-Attribute] |
article attributes |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ageGroups
|
array [string] Allowed values: - BABY- CHILD- TEEN- ADULT |
age group of the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalInfos
|
array [string] |
any additional information of the article |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activationDate
|
dateTime |
timestamp the article was available in the Zalando webshop |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
Example application/json
[
{
"id": "AN621C0S5-K11",
"name": "Summer dress - blue\/white",
"brand": {
"key": "AN6",
"name": "Anna Field",
"logoUrl": "https:\/\/i6.ztat.net\/brand\/anna-field.jpg",
"shopUrl": "https:\/\/www.zalando.co.uk\/anna-field"
},
"color": "Blue",
"media": {
"images": [
{
"type": "NON_MODEL",
"largeUrl": "https:\/\/i2.ztat.net\/large\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@16.jpg",
"smallUrl": "https:\/\/i2.ztat.net\/catalog\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@16.jpg",
"mediumUrl": "https:\/\/i2.ztat.net\/detail\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@16.jpg",
"largeHdUrl": "https:\/\/i2.ztat.net\/large_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@16.jpg",
"smallHdUrl": "https:\/\/i2.ztat.net\/catalog_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@16.jpg",
"mediumHdUrl": "https:\/\/i2.ztat.net\/detail_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@16.jpg",
"orderNumber": 1,
"thumbnailHdUrl": "https:\/\/i2.ztat.net\/thumb_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@16.jpg"
},
{
"type": "STYLE",
"largeUrl": "https:\/\/i3.ztat.net\/large\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@15.jpg",
"smallUrl": "https:\/\/i3.ztat.net\/catalog\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@15.jpg",
"mediumUrl": "https:\/\/i3.ztat.net\/detail\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@15.jpg",
"largeHdUrl": "https:\/\/i3.ztat.net\/large_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@15.jpg",
"smallHdUrl": "https:\/\/i3.ztat.net\/catalog_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@15.jpg",
"mediumHdUrl": "https:\/\/i3.ztat.net\/detail_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@15.jpg",
"orderNumber": 2,
"thumbnailHdUrl": "https:\/\/i3.ztat.net\/thumb_hd\/AN\/62\/1C\/0S\/5K\/11\/AN621C0S5-K11@15.jpg"
}
]
},
"units": [
{
"id": "AN621C0S5-K110420000",
"size": "16",
"price": {
"value": 21,
"currency": "GBP",
"formatted": "\u00a321.00"
},
"stock": 3,
"available": true,
"originalPrice": {
"value": 21,
"currency": "GBP",
"formatted": "\u00a321.00"
}
}
],
"season": "SUMMER",
"genders": [
"FEMALE"
],
"modelId": "AN621C0S5",
"shopUrl": "https:\/\/www.zalando.co.uk\/anna-field-summer-dress-blue-white-an621c0s5-k11.html",
"ageGroups": [
"ADULT"
],
"available": true,
"attributes": [
{
"name": "Neckline",
"values": [
"Crew neck"
]
},
{
"name": "Fit",
"values": [
"Waisted"
]
}
],
"seasonYear": "2015",
"categoryKeys": [
"catalog",
"women",
"womens-clothing",
"womens-clothing-dresses",
"summer-dresses",
"all",
"clothing"
],
"activationDate": "2015-04-30T16:52:52+02:00",
"additionalInfos": []
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Search for articles based on various different possible filter like e.g. the brandFamily, the catagory or a
specific color. See Filters for a list of all available filter options.
The default pageSize for responses is set to 20. You can add a pageSize request parameter to adjust that.
Please keep in mind that the maximum pageSize for this resource is 200.
The endpoint also supports reducing the fields returned for each article via the fields parameter. Please
refer to fields parameter for more details.
Request
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
sort
|
string Allowed values: - popularity- activationdate- pricedesc- priceasc- sale |
sorting order (eg: popularity) |
pageSize
|
string |
to request with required page size in a page |
page
|
string |
to request with required page number or pagination |
volume
|
array |
filters by volume |
upperMaterial
|
array |
filters by different type of upper material used on garments (eg: lace) |
trouserRise
|
array |
filters by trouser rise |
technology
|
array |
filters by technology used to produce the articles |
sports
|
array |
filters by different sport activities (eg: football) |
size
|
string |
filters by size |
shopArea
|
array |
filters by classification of articles |
shoeToecap
|
array |
filters by shoe toe cap variants (eg: pointed, square) |
shoeFastener
|
array |
filters by shoe fastener types (eg: buckle, lacing) |
shirtCollar
|
array |
filters by shirt collar styles (eg: low V neck, lined collar) |
shaftWidth
|
array |
filters by shaft width (eg: s, l) |
shaftHeight
|
array |
filters by shaft height (eg: s, xs) |
season
|
array |
filters by season (Autumn/Winter or Spring/Summer) |
sale
|
array |
filters discounted articles marked as sale |
price
|
string |
filters all articles in price range (eg: 9-90) |
pattern
|
array |
filters by pattern on the garments (eg: animal print, plain) |
occasion
|
array |
filters by type of occasion (eg: party, business) |
length
|
string |
filters by garments length (eg: 3/4 length, knee-length) |
heelHeight
|
array |
filters by height of the heel size or length (eg: xs) |
heelForm
|
array |
filters by heel form (eg: flat) |
gender
|
array |
filters by gender |
fullText
|
string |
filters by text (eg: search by 'as' gives result with articles of brand Sass) |
filling
|
array |
filters by different kinds of garment filling materials (eg: satin, wolle) |
den
|
array |
filters by den |
color
|
array |
filters by color (eg: red, blue) |
category
|
array |
filters by category (eg: Socks, Rain Coats) |
brandfamily
|
array |
filters by brand family key (eg: nike) |
brand
|
array |
filters by brand key given by user (eg: SA5) |
assortmentArea
|
array |
filters by classification of articles (eg: maternity) |
ageGroup
|
array |
filters by age group (eg: kids) |
activationDate
|
array |
period or time the articles are activated for selling in the shop |
articleUnitId
|
array |
filters by article's unit id |
articleModelId
|
array |
filters by article ModelId |
articleId
|
array |
The One or more |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Articles
|
object |
A simple container object that carries paging information as well as a list of articles on the |
Properties
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Examples
Example application/json
[
{
"content": [
{
"id": "BE824G002-C11",
"name": "Long sleeved top - stormy weather",
"brand": {
"key": "BE8",
"name": "bellybutton",
"logoUrl": "https:\/\/i2.ztat.net\/brand\/belly-button-1.jpg",
"shopUrl": "https:\/\/www.zalando.co.uk\/belly-button",
"logoLargeUrl": "https:\/\/i2.ztat.net\/brandxl\/belly-button-1.jpg"
},
"color": "Grey",
"media": {
"images": [
{
"type": "NON_MODEL",
"largeUrl": "https:\/\/i2.ztat.net\/large\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"smallUrl": "https:\/\/i2.ztat.net\/catalog\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"mediumUrl": "https:\/\/i2.ztat.net\/detail\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"largeHdUrl": "https:\/\/i2.ztat.net\/large_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"smallHdUrl": "https:\/\/i2.ztat.net\/catalog_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"mediumHdUrl": "https:\/\/i2.ztat.net\/detail_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg",
"orderNumber": 1,
"thumbnailHdUrl": "https:\/\/i2.ztat.net\/thumb_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@8.jpg"
},
{
"type": "NON_MODEL",
"largeUrl": "https:\/\/i1.ztat.net\/large\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@7.jpg",
"smallUrl": "https:\/\/i1.ztat.net\/catalog\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@7.jpg",
"mediumUrl": "https:\/\/i1.ztat.net\/detail\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@7.jpg",
"largeHdUrl": "https:\/\/i1.ztat.net\/large_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@7.jpg",
"smallHdUrl": "https:\/\/i1.ztat.net\/catalog_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@7.jpg",
"mediumHdUrl": "https:\/\/i1.ztat.net\/detail_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@7.jpg",
"orderNumber": 2,
"thumbnailHdUrl": "https:\/\/i1.ztat.net\/thumb_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@7.jpg"
},
{
"type": "NON_MODEL",
"largeUrl": "https:\/\/i2.ztat.net\/large\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@6.jpg",
"smallUrl": "https:\/\/i2.ztat.net\/catalog\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@6.jpg",
"mediumUrl": "https:\/\/i2.ztat.net\/detail\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@6.jpg",
"largeHdUrl": "https:\/\/i2.ztat.net\/large_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@6.jpg",
"smallHdUrl": "https:\/\/i2.ztat.net\/catalog_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@6.jpg",
"mediumHdUrl": "https:\/\/i2.ztat.net\/detail_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@6.jpg",
"orderNumber": 3,
"thumbnailHdUrl": "https:\/\/i2.ztat.net\/thumb_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@6.jpg"
},
{
"type": "NON_MODEL",
"largeUrl": "https:\/\/i3.ztat.net\/large\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@5.jpg",
"smallUrl": "https:\/\/i3.ztat.net\/catalog\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@5.jpg",
"mediumUrl": "https:\/\/i3.ztat.net\/detail\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@5.jpg",
"largeHdUrl": "https:\/\/i3.ztat.net\/large_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@5.jpg",
"smallHdUrl": "https:\/\/i3.ztat.net\/catalog_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@5.jpg",
"mediumHdUrl": "https:\/\/i3.ztat.net\/detail_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@5.jpg",
"orderNumber": 4,
"thumbnailHdUrl": "https:\/\/i3.ztat.net\/thumb_hd\/BE\/82\/4G\/00\/2C\/11\/BE824G002-C11@5.jpg"
}
]
},
"units": [
{
"id": "BE824G002-C110068000",
"size": "4-6m",
"price": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
},
"stock": 0,
"available": false,
"originalPrice": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
}
},
{
"id": "BE824G002-C110062000",
"size": "2-4m",
"price": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
},
"stock": 0,
"available": false,
"originalPrice": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
}
},
{
"id": "BE824G002-C110074000",
"size": "6-9m",
"price": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
},
"stock": 0,
"available": false,
"originalPrice": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
}
},
{
"id": "BE824G002-C110050000",
"size": "1m",
"price": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
},
"stock": 0,
"available": false,
"originalPrice": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
}
},
{
"id": "BE824G002-C110056000",
"size": "2m",
"price": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
},
"stock": 0,
"available": false,
"originalPrice": {
"value": 11,
"currency": "GBP",
"formatted": "\u00a311.00"
}
}
],
"season": "SUMMER",
"genders": [
"MALE"
],
"modelId": "BE824G002",
"shopUrl": "https:\/\/www.zalando.co.uk\/bellybutton-long-sleeved-top-grey-be824g002-c11.html",
"ageGroups": [
"BABY"
],
"available": false,
"attributes": [
{
"name": "Total length",
"values": [
"10.0 \" (Size 50)"
]
},
{
"name": "Fabric",
"values": [
"Jersey"
]
},
{
"name": "Length",
"values": [
"Standard"
]
},
{
"name": "Pattern",
"values": [
"Print"
]
},
{
"name": "Fit",
"values": [
"normal"
]
},
{
"name": "Occasion",
"values": [
"Leisure"
]
},
{
"name": "Neckline",
"values": [
"Envelope"
]
},
{
"name": "sleeve length",
"values": [
"8.0 \" (Size 50)"
]
},
{
"name": "outer fabric material",
"values": [
"100% cotton"
]
},
{
"name": "Sleeve length",
"values": [
"Long sleeve"
]
}
],
"seasonYear": "2015",
"categoryKeys": [
"catalog",
"kids",
"childrens-clothing",
"kids-clothing-shirts-tops",
"kids-clothing-long-sleeve-tops",
"all",
"clothing"
],
"activationDate": "2015-01-12T17:12:15+01:00",
"additionalInfos": []
}
]
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
brands
Zalando API Brand Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
key
|
string |
To get unique Brand by key. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Brand
|
object |
Zalando API Brand Schema |
Properties
shopUrl
|
uri |
The url of the brand within the Zalando web shop |
|||||||||||||
name
|
string |
Name of the brand |
|||||||||||||
logoUrl
|
uri |
The url of the brand logo within the Zalando web shop |
|||||||||||||
logoLargeUrl
|
uri |
The url of the large brand logo within the Zalando web shop |
|||||||||||||
key
|
string |
The unique key for a brand |
|||||||||||||
brandFamily
|
BrandFamily | ||||||||||||||
Properties
|
|||||||||||||||
Examples
Example application/json
[
{
"key": "N12",
"name": "Nike Performance",
"logoUrl": "https:\/\/i1.ztat.net\/brand\/nike-performance.jpg",
"shopUrl": "https:\/\/www.zalando.co.uk\/nike-performance",
"brandFamily": {
"key": "NIKE",
"name": "Nike",
"shopUrl": "https:\/\/www.zalando.co.uk\/nike"
},
"logoLargeUrl": "https:\/\/i1.ztat.net\/brandxl\/nike-performance.jpg"
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Brands Schema
Request
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
pageSize
|
string |
to request with required page size in a page |
page
|
string |
to request with required page number or pagination |
brandFamilyKey
|
array |
Request Brand by brandFamilyKey |
brandFamilyName
|
array |
Request Brand by brandFamilyName |
name
|
array |
Request Brand by name |
key
|
array |
Request Brand by key |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Brands
|
object |
Zalando API Paged Brands Schema |
Properties
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Examples
Example application/json
[
{
"page": 1,
"size": 2,
"content": [
{
"key": "NV3",
"name": "Nike Vision",
"shopUrl": "https:\/\/www.zalando.co.uk\/nike-vision"
},
{
"key": "N12",
"name": "Nike Performance",
"logoUrl": "https:\/\/i1.ztat.net\/brand\/nike-performance.jpg",
"shopUrl": "https:\/\/www.zalando.co.uk\/nike-performance",
"brandFamily": {
"key": "NIKE",
"name": "Nike",
"shopUrl": "https:\/\/www.zalando.co.uk\/nike"
},
"logoLargeUrl": "https:\/\/i1.ztat.net\/brandxl\/nike-performance.jpg"
}
],
"totalPages": 3,
"totalElements": 6
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
categories
Zalando API Category Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
key
|
array |
To get unique Category by key. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Category
|
object |
Zalando API Category Schema |
Properties
type
|
string |
The type of the category. |
targetGroup
|
string Allowed values: - ALL- WOMEN- MEN- KIDS |
The target group of the articles from this category |
suggestedFilters
|
array [string] |
list of filter names that are reasonable to use within this category |
parentKey
|
string |
The key of the parent category |
outlet
|
boolean |
Containing articles are from last seasons |
name
|
string |
Name of the category |
key
|
string |
The unique key for a category |
hidden
|
boolean |
The category is hidden and not shown on the Zalando web shop |
cid
|
integer |
The numeric ID for a category. |
childKeys
|
array [string] |
The list of keys of the child categories |
Examples
Example application/json
[
{
"content": [
{
"key": "women",
"name": "Women",
"type": "default",
"hidden": false,
"outlet": false,
"childKeys": [
"womens-shoes",
"womens-clothing",
"sports-womens",
"premium-womens"
],
"parentKey": "catalog",
"targetGroup": "WOMEN"
}
]
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Categories Schema
Request
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
pageSize
|
string |
to request with required page size in a page |
page
|
string |
to request with required page number or pagination |
suggestedFilter
|
array |
Request Categories by suggested filters |
childKey
|
array |
Request Categories by child keys |
parentKey
|
array |
Request Categories by parent keys |
key
|
array |
Request Categories by keys |
targetGroup
|
string |
Request Categories by target group |
hidden
|
string |
Request Categories by hidden |
outlet
|
string |
Request Categories by outlet |
type
|
string |
Request Categories by type |
name
|
array |
Request Categories by names |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Categories
|
object |
Zalando API Paged Categories Schema |
Properties
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Examples
Example application/json
[
{
"page": 1,
"size": 2,
"content": [
{
"key": "catalog",
"name": "Catalog",
"type": "default",
"hidden": false,
"outlet": false,
"childKeys": [
"all",
"women",
"men",
"kids",
"home"
],
"targetGroup": "ALL",
"suggestedFilters": [
"category",
"brand",
"color",
"price",
"activationDate"
]
},
{
"key": "women",
"name": "Women",
"type": "default",
"hidden": false,
"outlet": false,
"childKeys": [
"womens-shoes",
"womens-clothing",
"sports-womens",
"premium-womens"
],
"parentKey": "catalog",
"targetGroup": "WOMEN",
"suggestedFilters": [
"brandfamily",
"sale",
"upperMaterial",
"season"
]
}
],
"totalPages": 1132,
"totalElements": 2263
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
domains
Zalando API Domains Schema
Responses
Body
| Name | Data Type | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [Domain] |
Zalando API Domains Schema |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
facets
Zalando API Facets Schema
Request
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
volume
|
array |
filters by volume |
upperMaterial
|
array |
filters by different type of upper material used on garments (eg: lace) |
trouserRise
|
array |
filters by trouser rise |
technology
|
array |
filters by technology used to produce the articles |
sports
|
array |
filters by different sport activities (eg: football) |
size
|
string |
filters by size |
shopArea
|
array |
filters by classification of articles |
shoeToecap
|
array |
filters by shoe toe cap variants (eg: pointed, square) |
shoeFastener
|
array |
filters by shoe fastener types (eg: buckle, lacing) |
shirtCollar
|
array |
filters by shirt collar styles (eg: low V neck, lined collar) |
shaftWidth
|
array |
filters by shaft width (eg: s, l) |
shaftHeight
|
array |
filters by shaft height (eg: s, xs) |
season
|
array |
filters by season (Autumn/Winter or Spring/Summer) |
sale
|
array |
filters discounted articles marked as sale |
price
|
string |
filters all articles in price range (eg: 9-90) |
pattern
|
array |
filters by pattern on the garments (eg: animal print, plain) |
occasion
|
array |
filters by type of occasion (eg: party, business) |
length
|
string |
filters by garments length (eg: 3/4 length, knee-length) |
heelHeight
|
array |
filters by height of the heel size or length (eg: xs) |
heelForm
|
array |
filters by heel form (eg: flat) |
gender
|
array |
filters by gender |
filling
|
array |
filters by different kinds of garment filling materials (eg: satin, wolle) |
den
|
array |
filters by den |
color
|
array |
filters by color (eg: red, blue) |
category
|
array |
filters by category (eg: Socks, Rain Coats) |
brandfamily
|
array |
filters by brand family key (eg: nike) |
brand
|
array |
filters by brand key given by user (eg: SA5) |
assortmentArea
|
array |
filters by classification of articles (eg: maternity) |
articleModelId
|
array |
filters by article ModelId |
activationDate
|
array |
period or time the articles are activated for selling in the shop |
articleId
|
array |
The One or more |
ageGroup
|
array |
filters by age group (eg: kids) |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Facets
|
array [Facet] |
Zalando API Facets Schema |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
Examples
Example application/json
[
{
"facets": [
{
"key": "childrens-sports-shoes",
"count": 2080,
"displayName": "Sports Shoes"
},
{
"key": "childrens-outdoor-shoes",
"count": 273,
"displayName": "Outdoor Shoes"
},
{
"key": "kids-shoes-sandals-flip-flops",
"count": 1365,
"displayName": "Sandals & Flip Flops"
}
],
"filter": "category"
},
{
"facets": [
{
"key": "female",
"count": 190247,
"displayName": "female"
},
{
"key": "male",
"count": 117211,
"displayName": "male"
}
],
"filter": "gender"
},
{
"facets": [
{
"key": "allSeason",
"count": 17844,
"displayName": "allSeason"
},
{
"key": "summer",
"count": 155667,
"displayName": "summer"
},
{
"key": "winter",
"count": 116763,
"displayName": "winter"
}
],
"filter": "season"
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
filters
Zalando API Filters Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
filterName
|
string |
To get Filter by filterName. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
Filter
|
object |
Zalando API Filter Schema |
Properties
values
|
array [Filter-Value] |
only if type is 'enum' this list contains all possible filter values |
||||||||||
Properties
|
||||||||||||
type
|
string Allowed values: - SKU- KEY- ENUM- STRING- RANGE |
filter enum types |
||||||||||
name
|
string |
The unique name for a filter |
||||||||||
multiValue
|
boolean |
can this filter be used multiple times with different values in one search request |
||||||||||
Examples
Example application/json
[
{
"name": "ageGroup",
"type": "ENUM",
"values": [
{
"key": "babies",
"displayName": "babies"
},
{
"key": "kids",
"displayName": "kids"
},
{
"key": "teen",
"displayName": "teen"
},
{
"key": "adult",
"displayName": "adult"
}
],
"multiValue": true
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Filters Schema
Request
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
|
array [Filter] | ||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
Examples
Example application/json
[
{
"name": "ageGroup",
"type": "ENUM",
"values": [
{
"key": "babies",
"displayName": "babies"
},
{
"key": "kids",
"displayName": "kids"
},
{
"key": "teen",
"displayName": "teen"
},
{
"key": "adult",
"displayName": "adult"
}
],
"multiValue": true
},
{
"name": "brand",
"type": "KEY",
"values": [],
"multiValue": true
}
]recommendations
Zalando API Recommendations Schema
Request
Path
| Name | Data Type | Description |
|---|---|---|
articleIds
|
array |
To get Recommendations by articleIds. |
Query
| Name | Data Type | Description |
|---|---|---|
fields
|
array |
Comma separated list of fields that should be returned. Fields of subobjects are specified with dots as separator. Fields of objects within lists are specified in the same way. Example: id,name,brand.key,brand.name, units.id,units.size,units.price.formatted |
maxResults
|
string |
To get maximum results of Recommendations by articleId. |
Header
| Name | Data Type | Description |
|---|---|---|
Accept-Language
|
string Allowed values: - da-DK- de-AT- de-CH- de-DE- en-GB- es-ES- fi-FI- fr-BE- fr-CH- fr-FR- it-IT- nl-BE- nl-NL- no-NO- pl-PL- sv-SE |
Specify which Shop to use. A standard The shop choosen will e.g. define the currency used for prices as well as the language for product names and descriptions. Furthermore it will impact which articles are available as they might differ between countries. |
Responses
Body
| Name | Data Type | Description | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Recommendations
|
array [Recommendations-Article] |
Zalando API Recommendations Schema |
|||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
Examples
Example application/json
[
{
"id": "TC021A00J-A11",
"name": "MADDY - Jumpsuit - waterlilly\/noir",
"media": {
"images": [
{
"type": "UNSPECIFIED",
"largeUrl": "https:\/\/i5.ztat.net\/large\/TC\/02\/1A\/00\/JA\/11\/TC021A00J-A11@12.jpg",
"smallUrl": "https:\/\/i5.ztat.net\/catalog\/TC\/02\/1A\/00\/JA\/11\/TC021A00J-A11@12.jpg",
"mediumUrl": "https:\/\/i5.ztat.net\/detail\/TC\/02\/1A\/00\/JA\/11\/TC021A00J-A11@12.jpg",
"largeHdUrl": "https:\/\/i5.ztat.net\/large_hd\/TC\/02\/1A\/00\/JA\/11\/TC021A00J-A11@12.jpg",
"smallHdUrl": "https:\/\/i5.ztat.net\/catalog_hd\/TC\/02\/1A\/00\/JA\/11\/TC021A00J-A11@12.jpg",
"mediumHdUrl": "https:\/\/i5.ztat.net\/detail_hd\/TC\/02\/1A\/00\/JA\/11\/TC021A00J-A11@12.jpg",
"orderNumber": 1,
"thumbnailHdUrl": "https:\/\/i5.ztat.net\/thumb_hd\/TC\/02\/1A\/00\/JA\/11\/TC021A00J-A11@12.jpg"
}
]
},
"modelId": "TC021A00J",
"shopUrl": "https:\/\/www.zalando.co.uk\/2-love-tony-cohen-maddy-jumpsuit-white-tc021a00j-a11.html"
}
]Body
| Name | Data Type | Description |
|---|---|---|
ErrorMessage
|
object |
Properties
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Models
A single article
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
units
|
array [Article-Unit] |
price of the article |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags
|
array [string] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shopUrl
|
uri |
url of the article within the Zalando webshop |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
seasonYear
|
string Pattern: ^ALL$|^20[0-9]{2}$
|
collection year the article belongs to. Could be either a year or 'ALL' |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
season
|
string Allowed values: - SUMMER- WINTER- ALL |
collection season the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
article name |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
modelId
|
string |
unique article model id |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
media
|
Article-Media | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
unique article id |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
genders
|
array [string] Allowed values: - MALE- FEMALE |
gender of the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
color
|
string |
the main color of the article |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
categoryKeys
|
array [string] |
category keys of the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
brand
|
Brand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
available
|
boolean |
will be true if at least one article unit is available |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
attributes
|
array [Article-Attribute] |
article attributes |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ageGroups
|
array [string] Allowed values: - BABY- CHILD- TEEN- ADULT |
age group of the article belongs to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalInfos
|
array [string] |
any additional information of the article |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activationDate
|
dateTime |
timestamp the article was available in the Zalando webshop |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Zalando API Article Attribute Schema
Properties
| Name | Data Type | Description |
|---|---|---|
values
|
array [string] |
value of the article attribute |
name
|
string |
name of the article attribute |
Zalando API Article Image Schema
Properties
| Name | Data Type | Description |
|---|---|---|
type
|
string |
model or non model type article images |
thumbnailHdUrl
|
uri |
thumbnail HD url of the article images |
smallUrl
|
uri |
small image of the article |
smallHdUrl
|
uri |
small HD image of the article |
orderNumber
|
integer |
sequence of the article images |
mediumUrl
|
uri |
medium image of the article |
mediumHdUrl
|
uri |
medium HD image of the article |
largeUrl
|
uri |
large image of the article |
largeHdUrl
|
uri |
large HD image of the article |
Zalando API Article Media Schema
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
images
|
array [Article-Image] | ||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||
Zalando API Article Price Schema
Properties
| Name | Data Type | Description |
|---|---|---|
value
|
double | |
formatted
|
string | |
currency
|
string |
Zalando API Article Review Schema
Properties
| Name | Data Type | Description |
|---|---|---|
unhelpfulCount
|
integer |
customer review unhelpful count of the article |
title
|
string |
title in the article review |
reviewId
|
string |
unique article review id |
recommend
|
boolean |
customer recommend to the article |
rating
|
integer |
customer rating of the article |
language
|
string |
language in the article review |
helpfulCount
|
integer |
customer review helpful count of the article |
description
|
string |
description of the article review |
customerNickname
|
string |
Customer short name in the article review |
customerCountry
|
string |
customer country in the article review |
customerCity
|
string |
customer city in the article review |
created
|
dateTime |
article review created date and time |
articleSizeRatings
|
||
articleModelId
|
string | |
articleId
|
string |
Zalando API Paged Article Reviews Schema
Properties
| Name | Data Type | Description |
|---|---|---|
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Zalando API Paged Article Reviews Summaries Schema
Properties
| Name | Data Type | Description |
|---|---|---|
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Zalando API Article Reviews Summary Schema
Properties
| Name | Data Type | Description |
|---|---|---|
starRatingDistribution
|
||
numberOfUserReviews
|
integer |
number of user reviews of the article |
numberOfUserRecommendations
|
integer |
number of users recommended to the article |
numberOfUserPositiveRecommendations
|
integer |
number of positive recommendations to the article |
averageStarRating
|
double |
average star rating of the article |
articleSizeRatings
|
||
articleModelId
|
string |
Zalando API Article Unit Schema
Properties
| Name | Data Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
stock
|
integer |
stock of the article |
|||||||||||||
size
|
string |
article size |
|||||||||||||
price
|
Article-Price | ||||||||||||||
Properties
|
|||||||||||||||
partnerId
|
string |
partner id (vendor id) of the article |
|||||||||||||
originalPrice
|
Article-Price | ||||||||||||||
Properties
|
|||||||||||||||
id
|
string |
article id (sku) |
|||||||||||||
available
|
boolean |
availability of the article |
|||||||||||||
Zalando API Article Units Schema
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Article-Units
|
array [Article-Unit] |
Zalando API Article Units Schema |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A simple container object that carries paging information as well as a list of articles on the content property.
Properties
| Name | Data Type | Description |
|---|---|---|
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Zalando API Brand Schema
Properties
| Name | Data Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
shopUrl
|
uri |
The url of the brand within the Zalando web shop |
|||||||||||||
name
|
string |
Name of the brand |
|||||||||||||
logoUrl
|
uri |
The url of the brand logo within the Zalando web shop |
|||||||||||||
logoLargeUrl
|
uri |
The url of the large brand logo within the Zalando web shop |
|||||||||||||
key
|
string |
The unique key for a brand |
|||||||||||||
brandFamily
|
BrandFamily | ||||||||||||||
Properties
|
|||||||||||||||
Zalando API BrandFamily Schema
Properties
| Name | Data Type | Description |
|---|---|---|
shopUrl
|
uri |
The url of the brandFamily within the Zalando web shop |
name
|
string |
Name of the brandFamily |
key
|
string |
The unique key for a brandFamily |
Zalando API Paged Brands Schema
Properties
| Name | Data Type | Description |
|---|---|---|
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Zalando API Paged Categories Schema
Properties
| Name | Data Type | Description |
|---|---|---|
content
|
array [] Minimum: 0 |
page content |
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
Extends
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Zalando API Category Schema
Properties
| Name | Data Type | Description |
|---|---|---|
type
|
string |
The type of the category. |
targetGroup
|
string Allowed values: - ALL- WOMEN- MEN- KIDS |
The target group of the articles from this category |
suggestedFilters
|
array [string] |
list of filter names that are reasonable to use within this category |
parentKey
|
string |
The key of the parent category |
outlet
|
boolean |
Containing articles are from last seasons |
name
|
string |
Name of the category |
key
|
string |
The unique key for a category |
hidden
|
boolean |
The category is hidden and not shown on the Zalando web shop |
cid
|
integer |
The numeric ID for a category. |
childKeys
|
array [string] |
The list of keys of the child categories |
Zalando API Domain Schema
Properties
| Name | Data Type | Description |
|---|---|---|
taxRate
|
double Minimum: 0 (exclusive) Maximum: 1 (exclusive) |
domain tax rate |
shopUrl
|
string |
domain specific url |
rootCategoryKey
|
string |
domain root category |
languageCode
|
string |
domain language |
currencyCode
|
string |
domain currency code |
countryCode
|
string |
domain country code |
Properties
| Name | Data Type | Description |
|---|---|---|
value
|
string | |
name
|
string | |
key
|
string | |
invalidValues
|
array [string] | |
invalidName
|
boolean |
Properties
| Name | Data Type | Description | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status
|
integer | ||||||||||||||||||||
message
|
string | ||||||||||||||||||||
errors
|
array [ErrorDetail] | ||||||||||||||||||||
Properties
|
|||||||||||||||||||||
Zalando API Facet Schema
Properties
| Name | Data Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
filter
|
string | ||||||||||||||
facets
|
array [Facet-Value] |
list of the calculated article counts for each filter value |
|||||||||||||
Properties
|
|||||||||||||||
Zalando API FacetValue Schema
Properties
| Name | Data Type | Description |
|---|---|---|
key
|
string | |
displayName
|
string | |
count
|
integer |
number of articles matching this filter value |
Zalando API Facets Schema
| Name | Data Type | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Facets
|
array [Facet] |
Zalando API Facets Schema |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
Zalando API Filter Schema
Properties
| Name | Data Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
values
|
array [Filter-Value] |
only if type is 'enum' this list contains all possible filter values |
||||||||||
Properties
|
||||||||||||
type
|
string Allowed values: - SKU- KEY- ENUM- STRING- RANGE |
filter enum types |
||||||||||
name
|
string |
The unique name for a filter |
||||||||||
multiValue
|
boolean |
can this filter be used multiple times with different values in one search request |
||||||||||
Zalando API FilterValue Schema
Properties
| Name | Data Type | Description |
|---|---|---|
key
|
string |
The key for a filterValue. Only unique within one filter |
displayName
|
string |
translated display name |
| Name | Data Type | Description | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
|
array [Filter] | ||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
wrapper object for paged responses
Properties
| Name | Data Type | Description |
|---|---|---|
totalPages
|
integer |
total number of pages in the response |
totalElements
|
integer |
total elements in the response |
size
|
integer |
total number of elements in a page |
page
|
integer |
page number |
content
|
array [] Minimum: 0 |
page content |
Zalando API Recommendations Schema
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Recommendations
|
array [Recommendations-Article] |
Zalando API Recommendations Schema |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Zalando API Recommendation Article Schema
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
shopUrl
|
string | ||||||||||||||||||||||||||||||||||||||||||
name
|
string | ||||||||||||||||||||||||||||||||||||||||||
modelId
|
string | ||||||||||||||||||||||||||||||||||||||||||
media
|
Article-Media | ||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||
id
|
string | ||||||||||||||||||||||||||||||||||||||||||
Authentication
Metadata (Technical Details)
| Origin - Format | swagger |
| Origin - Url | https://api.zalando.com/schema/swagger.json |
| Origin - Version | 2.0 |
| Provider Name | zalando.com |
| API Version | v1.0 |