Zalando Shop Public API

download Zalando Shop Public API

of 20

  • date post

    21-Mar-2017
  • Category

    Documents

  • view

    47
  • download

    5

Embed Size (px)

Transcript of Zalando Shop Public API

  • SHOP PUBLIC API

    ACCESS ZALANDOS FASHION

    ASSORTMENT THE WAY YOU LIKE!

    UWE KAMINSKI (Product Manager)

    https://github.com/jukey

    https://tech.zalando.com

    2016-10-06

    https://github.com/jukeyhttps://github.com/jukeyhttps://tech.zalando.comhttps://tech.zalando.com

  • 2

    Idea

    Examples and Live-Demo

    Endpoints

    Basic Concepts

    Advanced Concepts

    AGENDA

    Idea Preparation and Presentation

  • 3

    Put images in the grey dotted box "unsupported placeholder"

    ENDPOINTS

    Put images in the grey dotted box "unsupported placeholder"

  • 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

    https://api.zalando.com/swagger/index.html#!/articleshttps://api.zalando.com/swagger/index.html#!/articles

  • 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

    https://api.zalando.com/swagger/index.html#!/brandshttps://api.zalando.com/swagger/index.html#!/categorieshttps://api.zalando.com/swagger/index.html#!/domainshttps://api.zalando.com/swagger/index.html#!/brands

  • 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

    https://api.zalando.com/swagger/index.html#!/facetshttps://api.zalando.com/swagger/index.html#!/filtershttps://api.zalando.com/swagger/index.html#!/facets

  • 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

  • 8

    RECOMMENDATIONS

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

    Recommendations Endpoint Reference

    https://api.zalando.com/swagger/index.html#!/recommendationshttps://api.zalando.com/swagger/index.html#!/recommendations

  • 9

    ENDPOINT REFERENCE

    Check the Swagger endpoint reference:

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

    https://api.zalando.com/swagger/index.html#/https://api.zalando.com/swagger/index.html#/

  • 10

    Put images in the grey dotted box "unsupported placeholder"

    BASIC CONCEPTS

  • 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

    https://github.com/zalando/shop-api-documentation/wiki/Articles#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.

    https://github.com/zalando/shop-api-documentation/wiki/Api-introduction#choosing-the-right-shop

  • 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]

    https://github.com/zalando/shop-api-documentation/wiki/Api-introduction#compression

  • 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.

    https://github.com/zalando/shop-api-documentation/wiki/Api-introduction#pagination

  • 15

    Put images in the grey dotted box "unsupported placeholder"

    ADVANCED CONCEPTS

    Put images in the grey dotted box "unsupported placeholder"

  • 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.

    https://github.com/zalando/shop-api-documentation/wiki/Api-introduction#caching

  • 17

    ADVANCED CONCEPTS: CUSTOMIZED RESPONSE

    Its 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/KN222S00B-K11@14.jpg " }, { "smallUrl" :"https://i6.ztat.net/catalog/KN/22/2S/00/BK/11/KN222S00B-K11@13.jpg " } ] }}

    https://github.com/zalando/shop-api-documentation/wiki/Api-introduction#customise-responsehttps://api.zalando.com/articles/KN222S00B-K11?fields=media.images.smallUrlhttps://api.zalando.com/articles/KN222S00B-K11?fields=media.images.smallUrlhttps://api.zalando.com/articles/KN222S00B-K11?fields=media.images.smallUrlhttps://i5.ztat.net/catalog/KN/22/2S/00/BK/11/KN222S00B-K11@14.jpghttps://i5.ztat.net/catalog/KN/22/2S/00/BK/11/KN222S00B-K11@14.jpghttps://i5.ztat.net/catalog/KN/22/2S/00/BK/11/KN222S00B-K11@14.jpghttps://i6.ztat.net/catalog/KN/22/2S/00/BK/11/KN222S00B-K11@13.jpghttps://i6.ztat.net/catalog/KN/22/2S/00/BK/11/KN222S00B-K11@13.jpghttps://i6.ztat.net/catalog/KN/22/2S/00/BK/11/KN222S00B-K11@13.jpg

  • 18

    Put images in the grey dotted box "unsupported placeholder"

    EXAMPLES AND LIVE-DEMO

    Put images in the grey dotted box "unsupported placeholder"

  • 19

    EXAMPLES AND LIVE DEMO

    See the API documentation for details regarding caching

    Live Demo Store Source Repository

    ZalMemo Source Repository

    https://github.com/zalando/shop-api-documentation/wiki/Api-introduction#cachinghttp://zalando-incubator.github.io/shop-api-demo/http://zalando-incubator.github.io/shop-api-demo/https://github.com/zalando-incubator/shop-api-demo/https://github.com/zalando-incubator/shop-api-demo/https://crackling-inferno-6105.firebaseapp.com/https://crackling-inferno-6105.firebaseapp.com/https://github.com/goekhanak/zalmemohttps://github.com/goekhanak/zalmemo

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

    Thank you!