API: Image

All API calls require the key parameter. That is not shown in the below examples.

Overview

Did you know Zappos doesn't use stock imagery for our products? That's right, we have an entire team that takes our own pictures of every style we have in inventory. This team is busy!

You can use these images to provide multiple views and image sizes of our products. Please note, that if you use our images, they should not be used in a manner that solely drives traffic to other sites. (e.g. don't use our high res images and make them click over to another website where you might be getting affiliate commissions through). This is bad karma, mojo and we'll likely revoke your API privileges and make you sit in a corner.

Basic Image Lookup

Returns a list of images for the given product id broken up by style id.

/Image?productId=<PRODUCT_ID>

{
   "statusCode": "200",
   "productId": "102179",
   "images": {
      "6889": [
        {
            "styleId": "6889",
            "productId": "102179",
            "type": "THUMBNAIL",
            "recipeName": "THUMBNAIL",
            "format": ".jpg",
            "filename": "http://www.zappos.com/images/102/102179/6900-6889-t.jpg"
        },
        {
            "styleId": "6889",
            "productId": "102179",
            "type": "PAIR",
            "recipeName": "DETAILED",
            "format": ".jpg",
            "filename": "http://www.zappos.com/images/102/102179/6900-6889-d.jpg"
        },
        ... 
    ],
    "6888": [
        {
            "styleId": "6888",
            "productId": "102179",
            "type": "THUMBNAIL",
            "recipeName": "THUMBNAIL",
            "format": ".jpg",
            "filename": "http://www.zappos.com/images/102/102179/3034-6888-t.jpg"
        },
        {
            "styleId": "6888",
            "productId": "102179",
            "type": "PAIR",
            "recipeName": "DETAILED",
            "format": ".jpg",
            "filename": "http://www.zappos.com/images/102/102179/3034-6888-d.jpg"
        },
        ... 
    ],
    ... 
   }
}

/Image?styleId=["<STYLE_ID>"]

You can also return all the images for a specific style. NOTE: The Image call can only take 1 product id as input but can take multiple style ids.

Includes

Bold fields are returned by default (and only if their parent fields are included). To include any other fields, you will need to include them in the includes parameter: e.g. /Image?productId=123&includes=["width"]

  • Images
    • styleId
    • productId
    • type
    • recipeName
    • format
    • filename
    • colorId
    • width
    • height
    • uploadDate
    • isHighResolution
    • tiles

Image Types

/Image?____&type=["TYPE_NAME"]

  • The type parameter limits your result to only the image types specified
  • An image Type is a particular angle shot of an item. e.g. PAIR, LEFT, RIGHT, TOP, etc.
  • Examples:
    • /Image?styleId=["123456"]&type=["THUMBNAIL"]
    • /Image?productId=["123456"]&type=["THUMBNAIL","TOP"]

Image Recipes

  • A recipe is a sizing transformation for an image. For example, we may have the LEFT type of an item, but want a smaller version for a preview. We would request type=LEFT and recipe=TINY. If we wanted a zoom-in feature, we could request LEFT and recipe=2x
  • Note, not all image types have all recipes
  • Examples:
    • /Image?styleId=["123456"]&recipe=["RECIPE_NAME"]
    • /Image?productId=["123456"]&recipe=["RECIPE_NAME"]

Get all recipes

/Image/list/recipes

{
  "statusCode": "200",
  "recipes":
  [
     {  
        "name": "TINY",
          "recipe": "---- Limit:
                   format: jpg
                   hires: true
                   - Resize:
                   geometry: 50x50
                   - Background:
                   color: white
                   ",
           "xTiles": "",
           "yTiles": ""
   },
   ...
  ]
 }   

4 comments

outsole images

Submitted by Michael on Tue, 10/02/2012 - 08:01.

outsole images by manufacturer

list image types?

Submitted by mARK on Thu, 05/24/2012 - 14:40.

There is a call to list all the image recipes, but nothing is said about listing all the image types. I have not had success guessing. Is there such a call, and if not why not?

It looks as though the type names might be a subset of the recipe names. Are the sets different?

why do i get detailed thumbnails?

Submitted by mARK on Thu, 05/24/2012 - 14:31.

I requested type=DETAILED images for a product. I got results with that type, two for each style: one "recipeName":"OUTFIT" and one "recipeName":"OUTFIT_THUMB". Why am I getting thumbnails when I didn't say type=THUMBNAIL, and what is the significance of OUTFIT? Do all products have outfit images?

what types and recipes exist? and what are they?

Submitted by mARK on Thu, 05/24/2012 - 14:26.

It would be a big help to know what image types and recipes are available, what their characteristics and intended uses are, whether all of them apply to all products, and what to do if a particular product does not have a particular type/recipe image.

Drupal theme by Kiwi Themes.