Zalando Shop Public API

20
SHOP PUBLIC API ACCESS ZALANDO’S FASHION ASSORTMENT THE WAY YOU LIKE! UWE KAMINSKI (Product Manager) https://github.com/jukey https://tech.zalando.com 2016-10-06

Transcript of Zalando Shop Public API

Page 1: Zalando Shop Public API

SHOP PUBLIC API

ACCESS ZALANDO’S FASHION

ASSORTMENT THE WAY YOU LIKE!

UWE KAMINSKI (Product Manager)

https://github.com/jukey

https://tech.zalando.com

2016-10-06

Page 2: Zalando Shop Public API

2

Idea

Examples and Live-Demo

Endpoints

Basic Concepts

Advanced Concepts

AGENDA

Idea Preparation and Presentation

Page 3: Zalando Shop Public API

3

Put images in the grey dotted box "unsupported placeholder"

ENDPOINTS

Put images in the grey dotted box "unsupported placeholder"

Page 4: Zalando Shop Public API

4

ARTICLES

The articles endpoint provides you either with

- a list of articles that could be filtered or- a specific article and related information

like reviews or media (pictures)

Article Endpoint Reference

Page 5: Zalando Shop Public API

5

BRANDS / CATEGORIES / DOMAINS

The brands endpoint provides you with list of brands or specific brand names and logos.

Using the categories endpoint allow to get a list of categories or a single category with parent and child categories.

The domains endpoint returns a list of domain specific information like tax rate or Zalando URL.

Brands / Categories / Domains Endpoint Reference

Page 6: Zalando Shop Public API

6

FACETS / FILTERS

The filters endpoint provides you either with

- a list of articles that could be filtered or- a specific article and related information

like reviews or media

The facets endpoint is used for non hierarchical classification. It allows users to explore the collection of articles by applying multiple filters.

Facets / Filters Endpoint Reference

Page 7: Zalando Shop Public API

7

Please write the title in all capital letters

Use bullet points to summarize information rather than writing long paragraphs in the text box

FACETS

CLASSIFICATION

FILTERS

Please write the title in all capital letters

Use bullet points to summarize information rather than writing long paragraphs in the text box

Shoes

Men

Women

Indoor

Indoor

Outdoor

Outdoor

oversize

normal size

oversize

normal size

oversize

normal size

oversize

normal size

Target Group

Usage

Indoor

Outdoor

Men

Women

Sizeoversize

normal size

Page 8: Zalando Shop Public API

8

RECOMMENDATIONS

The recommendations endpoint returns a list of articles recommended based on one or more given articles.

Recommendations Endpoint Reference

Page 9: Zalando Shop Public API

9

ENDPOINT REFERENCE

Check the Swagger endpoint reference:

https://api.zalando.com/swagger/index.htm

Page 10: Zalando Shop Public API

10

Put images in the grey dotted box "unsupported placeholder"

BASIC CONCEPTS

Page 11: Zalando Shop Public API

11

BASIC CONCEPTS: ARTICLES / MODELS / UNITS

See the API documentation for details regarding article.id, article.unit.id and article.modelId

There are three different basic types of article related data:

• article.id: A specific article that might be available in different familiy/color and sizes.

• article.modelID: A specific article in a specific color

• article.unit.id: A specific article in a specific color and size

Page 12: Zalando Shop Public API

12

BASIC CONCEPTS: SELECTING THE RIGHT STORE

See the API documentation for details regarding how to select another store

By default requests are send to the UK version of the assortment. That means all descriptions, filters, category names are in English.

Use the ‘Accept-Language’ request header in order to switch to another store (e.g.: de-DE for Germany)

Get a list of all domains available using the domains endpoint.

Page 13: Zalando Shop Public API

13

BASIC CONCEPTS: COMPRESSION

See the API documentation for details regarding compression

Request compressed responses using the ‘Accept-Encoding: gzip’ header.

The response in this case contains the following headers:

Content-Encoding: gzipContent-Type: application/json;charset=UTF-8[compressed binary data]

Page 14: Zalando Shop Public API

14

BASIC CONCEPTS: PAGINATION

See the API documentation for details regarding pagination

Use page and pageSize as parameters to specify what page of a result set and how many item objects should be shown.

By default the pageSize is 20.

Page 15: Zalando Shop Public API

15

Put images in the grey dotted box "unsupported placeholder"

ADVANCED CONCEPTS

Put images in the grey dotted box "unsupported placeholder"

Page 16: Zalando Shop Public API

16

ADVANCED CONCEPTS: CACHING

See the API documentation for details regarding caching

All Responses containing a ETag headers that could be used to identify a specific version of a resource.

Use the ‘If-None-Match’ header in requests in order to get a 340 Not Modified status and an empty body.

Page 17: Zalando Shop Public API

17

ADVANCED CONCEPTS: CUSTOMIZED RESPONSE

It’s possible to reduce the amount of data within a response by using the fields parameter and providing a list of field names.

See the API documentation for details regarding customized responses

Example:

curl 'https://api.zalando.com/articles/KN222S00B-K11?fields=media.images.smallUrl '{ "media" : { "images" : [ { "smallUrl" :"https://i5.ztat.net/catalog/KN/22/2S/00/BK/11/[email protected] " }, { "smallUrl" :"https://i6.ztat.net/catalog/KN/22/2S/00/BK/11/[email protected] " } ] }}

Page 18: Zalando Shop Public API

18

Put images in the grey dotted box "unsupported placeholder"

EXAMPLES AND LIVE-DEMO

Put images in the grey dotted box "unsupported placeholder"

Page 20: Zalando Shop Public API

Put images in the grey dotted box "unsupported placeholder" - behind the orange box and quote in capital letters

Thank you!