• The Sears Open API Platform provides access to all of the Sears Holdings' storefronts. This includes the Sears, Kmart and MyGofer platforms. By utilizing one of the seven different Application Programming Interfaces (APIs), programmers can get information on the product catalog, full product information including pricing, availability, specifications, descriptions, image URLs. Each API supports the xml / json response format.

    Below you can find all the currently available APIs and the corresponding documentation to learn more about them.

    And here is a quick guide to get you started with using our APIs: Getting Started with Sears API using Java or PHP.

  • The Product Search API allows developers to search and browse sears.com and kmart.com catalogs.

    • Keyword Search - Search products based on keywords
    • Category Search - Search category related information
    • Nth Level Category Search - Search products based on nth category level
    • Authentication Model: Developer Key
    • Rate Limiting: TBA
    • Known Issues: Please visit forum to see the list of known issues
    • Previous Versions: v1.0
    • Terms of Use: The use of these API are governed by Terms of Use.

     

    Click here to view the specs for Product Search API.

     

  • The Product Details API allows developers to retrieve product information from the sears.com and kmart.com catalogs.

    • Bundles, Collections & Outfits - Search product details based on grouping
    • Soft Line Products - Search product details based on soft line
    • Hard Line Products - Search product details based on hard line
    • Authentication Model: Developer Key
    • Rate Limiting: TBA
    • Known Issues: Please visit forum to see the list of known issues
    • Previous Versions: v1.0
    • Terms of Use: The use of these API are governed by Terms of Use.

     

    Click here to view the specs for Product Details API.

     

  • The Parts Catalog API supports a variety of ways to search the parts and models catalog made available by SearsPartsDirect.com. (Please note that the default API Key you obtain after registering on this portal *does not* directly provide access to this API. In order to gain access to this API, please send a note to apisupport@searshc.com explaining your interest.)

    • Authentication Model: Developer Key
    • Rate Limiting: TBA
    • Known Issues: Please visit forum to see the list of known issues
    • Terms of Use: The use of these API are governed by Terms of Use.

     

    Click on the links above to view the specs for the Parts Catalog API.

  • The Top Sellers API allows developers to retrieve product information on the top sellers at Sears and Kmart stores.

    • By Units Sold - Fetches top sellers based on units sold
    • Authentication Model: Developer Key
    • Rate Limiting: TBA
    • Known Issues: Please visit forum to see the list of known issues
    • Previous Versions: v1.0
    • Terms of Use: The use of these API are governed by Terms of Use.

     

    Click here to view the specs for Top Sellers API.

     

  • Deals APIs consists of following four APIs

    • Get Daily Specials API - Get Daily Specials API allows external applications to retrieve all the daily WOW deals for a specific store
    • Get Daily All API - Get Daily All API allows external applications to retrieve all Other Daily Specials for a specific store
    • Get Weekly Deals Categories API - Get Weekly Deals Categories API allows external applications to retrieve all available categories for the Get Weekly Deals API for a given store.
    • Get Weekly Deals API - Get Weekly Deals API allows external applications to retrieve all available weekly deals for a given category for a specific store
    • Authentication Model: Developer Key
    • Rate Limiting: TBA
    • Known Issues: Please visit forum to see the list of known issues
    • Terms of Use: The use of these API are governed by Terms of Use.

     

    Click on the links above to view the specs for the Deals API.

     

  • This API is COMING SOON. 

    Local Ads APIs consists of following three APIs.

    • Get Departments API - Get Departments API allows external applications to retrieve all the departments associated with a specific store
    • Get Departments Tree API - Get Departments Tree API is used in conjunction with the Get Departments API to get the 2nd and 3rd level department list. 
    • Get Offers API - This API will retrieve various offers/listings available for Sears and Kmart stores based on the parameters passed in the request
    • Authentication Model: Developer Key
    • Rate Limiting: TBA
    • Terms of Use: The use of these API are governed by Terms of Use.

     

  • The Store Information API is the new version of the deprecated Store Locator API (v1). This API allows developers to fetch store information for Sears and Kmart stores near the address given as input.

    • By Zipcode - Store information for a given zipcode
    • By City and State - Store information for a given city and state
    • By Geographic co-ordinates - Store information for a given latitude and longitude
    • By Store Number - Store information for a given store number
      • Authentication Model: Developer Key
      • Rate Limiting: TBA
      • Known Issues: Please visit forum to see the list of known issues
      • Terms of Use: The use of these API are governed by Terms of Use.

       

      Click here to view the specs for Store Information API.

       

    • The Local Inventory API allows developers to get the nearest stores and count of items available for store pickup for a given zipcode.

      • From Product Search Page - Search stores from product search page 
      • From Product Details Page - Search stores from product details page
      • Authentication Model: Developer Key
      • Rate Limiting: TBA
      • Known Issues: Please visit forum to see the list of known issues
      • Terms of Use: The use of these API are governed by Terms of Use.

       

      Click here to view the specs for Local Ads APIs.

       

    • This API is deprecated. The Sales and Deals API allows developers to retrieve sales and deals data from sears.com, kmart.com and mygofer.com catalogs.

      • By Store Name - Search sales and deals based on store
      • Authentication Model: Developer Key
      • Rate Limiting: TBA
      • Known Issues: Please visit forum to see the list of known issues
      • Terms of Use: The use of these API are governed by Terms of Use.

       

    • This API is deprecated. The Deal Of The Day API will allow developers to get deal of the day product information from mygofer.com.

      • By Store - This API allows the user to get Deal Of the Day supporting response in two formats: ProductDetails and DealofTheDay.
      • Authentication Model: Developer Key
      • Rate Limiting: TBA
      • Known Issues: Please visit forum to see the list of known issues
      • Terms of Use: The use of these API are governed by Terms of Use.

       

    • This API will soon be deprecated. v2.1 of this feature is now available as Store Information API. 

      Store Locator API allows developers to utilize a store location application to find the Sears stores and Kmart stores near the address given as input. Also supports xml / json response format. Available data through the API is further explained in the following Store Locator methods.

      • Store Search - Search store locator by store.
      • Authentication Model: Developer Key
      • Rate Limiting: TBA
      • Known Issues: Please visit forum to see the list of known issues
      • Terms of Use: The use of these API are governed by Terms of Use.

       

    • The Local Inventory API allows developers to search the inventory of stores near a given zip code and part number. Using this zip code and a defined distance radius, the API will return the stores within the radius and the inventory levels of the specified item.

       

      API Information

      API Local Inventory
      Base URL http://api.developer.sears.com/v1/ProcessPickupData?partNumber={partNumber}&zipCode={zipCode}&pageonLoad={pageonLoad}?store={store}&spuRefactorEnabled={spuRefactorEnabled}&maxDistance={maxDistance}&catalogId={catalogId}
      Version v1.0
      HTTP method GET
      Format xml
      Stores Sears , Kmart
      Authentication Required
      Rate Limit None

       

      Samples

      Use Cases Description Sample url Sample format
      From Product Search To fetch stores and item count based on zipcode from product search page http://api.developer.sears.com/v1/ProcessPickupData? partNumber=XXXXX&zipCode=XXXX&pageonLoad=productSearch& maxDistance=XX&store=XXXX &prefferedStoreUnitId=XXXX&catentryId=XXXXstoreStartIdx=XX&apikey=XXXXXXXX Click here
      From Product Details To fetch stores and item count based on zipcode from search page  http://api.developer.sears.com/v1/ProcessPickupData?partNumber=XXXXX&zipCode=XXXX&pageonLoad=productDetails& maxDistance=XX&store=XXXX&prefferedStoreUnitId=XXXX&storeStartIdx=XX&apikey=XXXXXXXX Click here

       

      Test this Now! 

      Using API console you can fire API urls and view response Click here 

       

      Request parameters

      Parameter Required Description Values
      partNumber Yes part number of the pickup item ex. 04668802000P
      zipCode Yes zip code of the area to be searched ex. 60169
      pageonLoad Yes page from which call to the API is made productSearch, productDetails
      store Yes store name Sears, Kmart
      spuRefactorEnabled Yes value will be flag for store pickup (spu) flow true, false
      catentryId Yes (when pageonLoad= productSeach) The catentryId of the pickup item to be added to the cart. This can be obtained from Product Search api 91366167
      maxDistance Yes Radius in which stores will be searched. This will be in miles.  ex: 50
      quantity Yes quantity of the item that needs to be added to the cart search
      catalogId Yes catalog id of the store Sears - 12605; Kmart - 10104
      prefferedStoreUnitId (note spelling of “preffered”) No Unit number for the store which to be selected as preferred store  ex: 1400
      storeStartIdx No To search for more stores this value needs to be passed. This is obtained from store listed in the Local Inventory Response ex: 10

       

      Response details

      Response Node Description Values
      IsPreferredStore If the store is preferred store or not true
      StoreName Store Unit Name OAKBROOK-A
      StoreAddress Store Unit Address 2 OAKBROOK CTR
      StoreCity Store Unit City OAK BROOK
      StoreState State in which the Store is present IL
      StoreZipCode Zipcode of the Store 60523
      LatLongInfo Longitude and Latitude info of the store 41.849934|-87.95662
      RegionalPriceIndicator If the item selected is regional price eligible or not 0 - Regional Pricing OFF ; 1 - Regional Pricing ON
      InStockForPickup Item instock and Available for pickup true
      SPUMessage Store Pickup Message FREE Store Pickup
      SPUAvailabilityMsg SPU availability message Available in 4-6 days
      AllItemsAvailableFlag Whether all items are available in the store or not. This node is true only if you have 1 or more items in cart already true or false
      NumberOfItemsInCart Current number of items in the cart. This node is greater than 0 only if you have 1 or more items in cart already 0
      StoreIndex Index of the store 0
      NewItemInfo Information about the item [StoreReservation|StoreUnitNumber|StoreReservationDays|PartNumber] ex: SRES|0001300|4-6|04629502000
      PickupInfo Pickup information of the item  
      CatEntryId CatEntry Id of the item 42347259
      RspuStoreUnitNumber Store Unit number 0001300
      Distance Distance from the user selected zip code 17
      StoreDetails Root node for the Contact details and timings of the store  
      ThresholdValue Threshold value 1 by default
      RTINumber RTI Number 0
      StorePhone Phone Number of the store 630-575-1800
      StoreHours Store timings in CST Hours: (all times CST)
      Monday Day of the week and timings 10:00am to 9:00pm
      Tuesday Day of the week and timings 10:00am to 9:00pm
      Wednesday Day of the week and timings 10:00am to 9:00pm
      Thursday Day of the week and timings 10:00am to 9:00pm
      Friday Day of the week and timings 10:00am to 9:00pm
      Saturday Day of the week and timings 10:00am to 9:00pm
      Sunday Day of the week and timings 10:00am to 9:00pm

       

    • Below are few examples of responses for Store Information API

      JSON response with customData=StoreInfo

      Sample URL: http://api.developer.sears.com/v2.2/stores/storeInfo/Sears/xml/zip/60602...

      
          "showstoreinfo": {
              "getstoreinfo": {
                  "StoreCount": 3,
                  "Stores": {
                      "storelocation": [
                          {
                              "storeinfo": {
                                  "storeType": "Sears_Stores",
                                  "storeNumber": "0001570",
                                  "storeName": "WOODFIELD MALL",
                                  "closeDate": "9999-12-31",
                                  "startDate": "1971-08-05"
                              }
                          },
                          {
                              "storeinfo": {
                                  "storeType": "Sears_Auto_Centers",
                                  "storeNumber": "0006091",
                                  "storeName": "SEARS AUTO CENTER",
                                  "closeDate": "9999-12-31",
                                  "startDate": "1971-08-05"
                              }
                          },
                          {
                              "storeinfo": {
                                  "storeType": "Service_Centers_Repair_Drop_off_Locations",
                                  "storeNumber": "0007910",
                                  "storeName": "SCHAUMBURG - OTC BRANCH",
                                  "closeDate": "9999-12-31",
                                  "startDate": "2010-09-30"
                              }
                          }
                      ]
                  }
              },
              "ApiTracking": "Server: DEV-SERVER-303-1|Tracking ID: {1375202228879}|API Client Session Key: 1145338126393083621|Time : Tue Jul 30 11:37:08 CDT 2013|UID : 1145338126393083621|From Cache : Y",
              "status": {
                  "ResponseCode": "0",
                  "RespMessage": "Successful"
              }
          }
       

       

      JSON response with customData=StoreInfo|Location

      Sample URL: http://api.developer.sears.com/v2.2/stores/storeInfo/Sears/xml/zip/60173...|Location

      
          "showstoreinfo": {
              "getstoreinfo": {
                  "StoreCount": 3,
                  "Stores": {
                      "storelocation": [
                          {
                              "location": {
                                  "address": {
                                      "state": "IL",
                                      "country": "US",
                                      "city": "SCHAUMBURG",
                                      "county": "",
                                      "streetaddress": "2 WOODFIELD MALL",
                                      "zipcode": "601735086"
                                  },
                                  "distance": "2.4920231355309355",
                                  "latitude": "42.049421",
                                  "longitude": "-88.037658"
                              },
                              "storeinfo": {
                                  "storeType": "Sears_Stores",
                                  "storeNumber": "0001570",
                                  "storeName": "WOODFIELD MALL",
                                  "closeDate": "9999-12-31",
                                  "startDate": "1971-08-05"
                              }
                          },
                          {
                              "location": {
                                  "address": {
                                      "state": "IL",
                                      "country": "US",
                                      "city": "SCHAUMBURG",
                                      "county": "",
                                      "streetaddress": "890 PERIMETER DR",
                                      "zipcode": "601735048"
                                  },
                                  "distance": "2.3175691029059116",
                                  "latitude": "42.045346",
                                  "longitude": "-88.032013"
                              },
                              "storeinfo": {
                                  "storeType": "Sears_Auto_Centers",
                                  "storeNumber": "0006091",
                                  "storeName": "SEARS AUTO CENTER",
                                  "closeDate": "9999-12-31",
                                  "startDate": "1971-08-05"
                              }
                          },
                          {
                              "location": {
                                  "address": {
                                      "state": "IL",
                                      "country": "US",
                                      "city": "SCHAUMBURG",
                                      "county": "",
                                      "streetaddress": "890 PERIMETER DR",
                                      "zipcode": "60173"
                                  },
                                  "distance": "2.5169990798956605",
                                  "latitude": "42.049",
                                  "longitude": "-88.038"
                              },
                              "storeinfo": {
                                  "storeType": "Service_Centers_Repair_Drop_off_Locations",
                                  "storeNumber": "0007910",
                                  "storeName": "SCHAUMBURG - OTC BRANCH",
                                  "closeDate": "9999-12-31",
                                  "startDate": "2010-09-30"
                              }
                          }
                      ]
                  }
              },
              "ApiTracking": "Server: DEV-SERVER-303-1|Tracking ID: {1375202312546}|API Client Session Key: 2528252187263132076|Time : Tue Jul 30 11:38:32 CDT 2013|UID : 2528252187263132076|From Cache : N",
              "status": {
                  "ResponseCode": "0",
                  "RespMessage": "Successful"
              }
          }
      

       

      Complete Store Information JSON response (with no customData parameters)

      Sample URL: http://api.developer.sears.com/v2.2/stores/storeInfo/Sears/xml/zip/60173...

      
          "showstoreinfo": {
              "getstoreinfo": {
                  "StoreCount": 3,
                  "Stores": {
                      "storelocation": [
                          {
                              "storeservices": {
                                  "storeservice": [
                                      {
                                          "serviceicon": "icon_giftreg.gif",
                                          "servicerank": "1",
                                          "servicename": "GIFT REGISTRY"
                                      },
                                      {
                                          "serviceicon": "icon_spu.gif",
                                          "servicerank": "6",
                                          "servicename": "STORE PICK UP"
                                      },
                                      {
                                          "serviceicon": "icon_dental.gif",
                                          "servicerank": "9",
                                          "servicename": "DENTAL"
                                      },
                                      {
                                          "serviceicon": "icon_hearingaid.gif",
                                          "servicerank": "10",
                                          "servicename": "HEARING AIDS"
                                      },
                                      {
                                          "serviceicon": "icon_optical.gif",
                                          "servicerank": "11",
                                          "servicename": "OPTICAL"
                                      },
                                      {
                                          "serviceicon": "icon_tax.gif",
                                          "servicerank": "12",
                                          "servicename": "TAX SERVICES"
                                      },
                                      {
                                          "serviceicon": "icon_hairsalon.gif",
                                          "servicerank": "13",
                                          "servicename": "Hair Salon"
                                      },
                                      {
                                          "serviceicon": "icon_LE.gif",
                                          "servicerank": "16",
                                          "servicename": "LE Shops"
                                      },
                                      {
                                          "serviceicon": "icon_respay.gif",
                                          "servicerank": "19",
                                          "servicename": "RESERVE AND PAY"
                                      },
                                      {
                                          "serviceicon": "icon_refrigeration.gif",
                                          "servicerank": "21",
                                          "servicename": "REFRIGERATION"
                                      },
                                      {
                                          "serviceicon": "icon_freezer.gif",
                                          "servicerank": "22",
                                          "servicename": "FREEZER"
                                      },
                                      {
                                          "serviceicon": "icon_wifi.gif",
                                          "servicerank": "31",
                                          "servicename": "Free WiFi"
                                      }
                                  ]
                              },
                              "location": {
                                  "address": {
                                      "state": "IL",
                                      "country": "US",
                                      "city": "SCHAUMBURG",
                                      "county": "",
                                      "streetaddress": "2 WOODFIELD MALL",
                                      "zipcode": "601735086"
                                  },
                                  "distance": "2.4920231355309355",
                                  "latitude": "42.049421",
                                  "longitude": "-88.037658"
                              },
                              "contactdetails": {
                                  "storephones": {
                                      "pharmphone": "#",
                                      "storephone": "8473302356"
                                  },
                                  "storeworkingHours": {
                                      "sunopentime": "39600",
                                      "monclosetime": "75600",
                                      "friopentime": "32400",
                                      "thuopentime": "32400",
                                      "tueclosetime": "75600",
                                      "weekdayopentime": "36000",
                                      "tueopentime": "36000",
                                      "satopentime": "32400",
                                      "weekdayclosetime": "75600",
                                      "wedopentime": "32400",
                                      "friclosetime": "75600",
                                      "satclosetime": "75600",
                                      "thuclosetime": "75600",
                                      "sunclosetime": "64800",
                                      "monopentime": "36000",
                                      "wedclosetime": "75600"
                                  }
                              },
                              "storeinfo": {
                                  "storeType": "Sears_Stores",
                                  "storeNumber": "0001570",
                                  "storeName": "WOODFIELD MALL",
                                  "closeDate": "9999-12-31",
                                  "startDate": "1971-08-05"
                              }
                          },
                          {
                              "storeservices": {
                                  "storeservice": [
                                      {
                                          "serviceicon": "icon_spu.gif",
                                          "servicerank": "6",
                                          "servicename": "STORE PICK UP"
                                      },
                                      {
                                          "serviceicon": "icon_westernunion.gif",
                                          "servicerank": "34",
                                          "servicename": "Western Union"
                                      }
                                  ]
                              },
                              "location": {
                                  "address": {
                                      "state": "IL",
                                      "country": "US",
                                      "city": "SCHAUMBURG",
                                      "county": "",
                                      "streetaddress": "890 PERIMETER DR",
                                      "zipcode": "601735048"
                                  },
                                  "distance": "2.3175691029059116",
                                  "latitude": "42.045346",
                                  "longitude": "-88.032013"
                              },
                              "contactdetails": {
                                  "storephones": {
                                      "pharmphone": "#",
                                      "storephone": "8473302128"
                                  },
                                  "storeworkingHours": {
                                      "sunopentime": "10",
                                      "monclosetime": "68400",
                                      "friopentime": "10",
                                      "thuopentime": "28800",
                                      "tueclosetime": "68400",
                                      "weekdayopentime": "0",
                                      "tueopentime": "10",
                                      "satopentime": "10",
                                      "weekdayclosetime": "0",
                                      "wedopentime": "28800",
                                      "friclosetime": "68400",
                                      "satclosetime": "68400",
                                      "thuclosetime": "68400",
                                      "sunclosetime": "61200",
                                      "monopentime": "10",
                                      "wedclosetime": "68400"
                                  }
                              },
                              "storeinfo": {
                                  "storeType": "Sears_Auto_Centers",
                                  "storeNumber": "0006091",
                                  "storeName": "SEARS AUTO CENTER",
                                  "closeDate": "9999-12-31",
                                  "startDate": "1971-08-05"
                              }
                          },
                          {
                              "storeservices": {
                                  "storeservice": [
                                      {
                                          "serviceicon": "icon_spu.gif",
                                          "servicerank": "6",
                                          "servicename": "STORE PICK UP"
                                      },
                                      {
                                          "serviceicon": "icon_repair.gif",
                                          "servicerank": "7",
                                          "servicename": "Drop-off Location"
                                      }
                                  ]
                              },
                              "location": {
                                  "address": {
                                      "state": "IL",
                                      "country": "US",
                                      "city": "SCHAUMBURG",
                                      "county": "",
                                      "streetaddress": "890 PERIMETER DR",
                                      "zipcode": "60173"
                                  },
                                  "distance": "2.5169990798956605",
                                  "latitude": "42.049",
                                  "longitude": "-88.038"
                              },
                              "contactdetails": {
                                  "storephones": {
                                      "pharmphone": null,
                                      "storephone": "8473302005"
                                  },
                                  "storeworkingHours": {
                                      "sunopentime": "39600",
                                      "monclosetime": "61200",
                                      "friopentime": "36000",
                                      "thuopentime": "36000",
                                      "tueclosetime": "61200",
                                      "weekdayopentime": "0",
                                      "tueopentime": "36000",
                                      "satopentime": "36000",
                                      "weekdayclosetime": "0",
                                      "wedopentime": "36000",
                                      "friclosetime": "61200",
                                      "satclosetime": "54000",
                                      "thuclosetime": "61200",
                                      "sunclosetime": "54000",
                                      "monopentime": "36000",
                                      "wedclosetime": "61200"
                                  }
                              },
                              "storeinfo": {
                                  "storeType": "Service_Centers_Repair_Drop_off_Locations",
                                  "storeNumber": "0007910",
                                  "storeName": "SCHAUMBURG - OTC BRANCH",
                                  "closeDate": "9999-12-31",
                                  "startDate": "2010-09-30"
                              }
                          }
                      ]
                  }
              },
              "ApiTracking": "Server: DEV-SERVER-303-1|Tracking ID: {1375202381769}|API Client Session Key: 3420829381212872717|Time : Tue Jul 30 11:39:41 CDT 2013|UID : 3420829381212872717|From Cache : N",
              "status": {
                  "ResponseCode": "0",
                  "RespMessage": "Successful"
              }
          }
      	
    • This API is used to retrieve store information , such as basic details of a store, working hours and services offered. This API will allow developers to get information on Sears / Kmart stores available for a city and state, ZIP code, or latitude and longitude given as input.

       

      API Information

      API Store Information
      Base URL http://api.developer.sears.com/v2.1/stores/storeInfo/{storeName}/{content}/
      URL (City/State search) city/{cityName}/state/{stateName}?
      URL (Zip Code Search) zip/{ZipCode}
      URL (Latitude/Longitude Search) longitude/{longitude}/latitude/{latitude}/
      URL (Store Number Search) unitnumber/{unitnumber}
      Version v2.1
      HTTP method GET
      Format json / xml
      Stores Sears , Kmart
      Authentication  Required, by API Key
      Rate Limit None

      Samples

      Use Cases Sample url Sample format
      Fetch Sears stores for given zipcode http://api.developer.sears.com/v2.1/stores/storeInfo/Sears/json /zip/60602?apikey=xxxxxxxx Click Here
      Fetch Sears stores for given city and state http://api.developer.sears.com/v2.1/stores/storeInfo/Sears /json/city/Chicago/state/IL?apikey=xxxxxxxxx Click Here
      Fetch Sears stores for given longitude and latitude http://api.developer.sears.com/v2.1/stores/storeInfo/Sears/json /longitude/-122.345379/latitude/47.744337?apikey=xxxxxxxx Click Here
      Fetch Sears stores for given store number http://api.developer.sears.com/v2.1/stores/storeInfo/Sears/json /unitnumber/3124?apikey=xxxxxxxx Click Here

       Request parameters

      Parameter Required Description Values
      storeName Yes path variable - store name Sears , Kmart
      content Yes xml, json
      cityName   Yes (for City/State search only) Joliet, Hoffman Estates 
      stateName Yes (for City/State search only) path variable - state input by user IL 
      zipCode Yes (for zip code search only) path variable – Zip Code input by user 60523
      longitude Yes (for Latitude/Longitude Search only) path variable - geographic co-ordinates 41.849934
      latitude Yes (for Latitude/Longitude Search only) path variable - geographic co-ordinates -87.95662
      unitnumber Yes (For Store Number Search only) path variable – unique store number 0002732, 0001300
      apikey Yes unique key provided after registering on  Sears Developer Network http://developer.sears.com/user/register  
      store Yes path variable - store name Sears , Kmart
      Accept Yes HTTP header parameter application/xml, application/json (default)
      weeklyAd No If true it will return stores for which weekly ad is available true , false 
      searchType No if specified filters out results by storey type
      Sears_Stores, Call_Centre, The_Great_Indoors, Hardware_Stores, Hardware_Stores, Sears_Appliance_Outlet_Stores, Sears_Auto_Centers, Hometown_Dealers, Kmart, Sears_Essentials, MDO, Warehouse, Service_Centers_Repair_Drop_off_Locations, Service_Service_Center, Premium_Appliances_Showrooms
      sortFlag No if specified sorts results by distance. Default : false true,false
      mileRadius No used to provide the range in terms of distance. Results will consist of stores in that particular distance radius. Default is 30. 10
      customData No used to filter results to return only specific information from the API. If multiple values are passed, separate using a ‘|’ delimiter and information under these groups will be returned  http://api.developer.sears.com/v2.1/stores/storeInfo/Sears/xml/zip/60602?apikey=xxxxxxxx&customData=StoreInfo
      http://api.developer.sears.com/v2.1/stores/storeInfo/Sears/xml/zip/60602?apikey=xxxxxxxx&customData=StoreInfo|ContactDetails

      Response details

      Response Node Description Values
      StoreType type of store Sears_Stores, Sears_Auto_Centers
      StoreNumber unique store number 0002732, 0001300
      StoreName store name  OAKBROOK-A, SEARS AUTO CENTER
      CloseDate date this store closed 9999-12-31
      StartDate Date this store opened 1962-03-06
      ServiceName Services offered by this store STORE PICK UP , Drop-off Location
      ServiceRank Unique identifier for a service 6 (STORE PICK UP) , 7 (Drop-off Location)
      ServiceIcon image file associated with service icon_spu.gif , icon_repair.gif
      StorePhone Store phone number 6305751800
      PharmPhone Pharmacy phone number # (if no data present)
      WeekDayOpenTime Store open timings on weekday  
      WeekDayOpenTime Store close timings on weekday  
      Latitude geographic co-ordinates 41.849934
      Longitude geographic co-ordinates -87.95662
      Distance distance of store from specified zipCode 0
      Zipcode zipCode details 60523
      Country Country details US
      County County details  
      City City details OAK BROOK
      StreetAddress Street details 2 OAKBROOK CTR
      State State details IL
    • The Product Details API allows you to search by part number (found with the Product Search API) in the Sears and Kmart catalog. The API then returns detailed information in a number of different areas, including:

      • ID: Manufacturer part numbers and other identifying information
      • Description: Brand, general description, image and video URLs, variants, names and more
      • Availability: Whether the product/variant is in stock and more
      • Fulfillment: Whether the product can be picked up at a store, reserved at a store, shipped to a store, is available for next-day delivery, and more
      • Pricing: Detailed pricing information

      Older version (2.1) of the Product Details API which is available HERE, is deprecated!

       

      API Information

      API Product Details
      Base URL - Product Details using PartNumber http://api.developer.sears.com/v3/productDetail/getProduct/
      URL - Product Details using PartNumber {storeName}/{content}/{partNumber}?
      Base URL - Product Details using UID http://api.developer.sears.com/v3/productDetail/getOfferByUid/
      URL - Product Details using UID {storeName}/{content}/{uId}?
      Version v3
      HTTP method GET
      Format json / xml / jsonp
      Stores Sears, Kmart, MyGofer
      Authentication Required, via API Key
      Rate Limit None

       

      Samples

      Use Cases Description Sample url Sample format
      Product Details - getProduct using Partnumber To fetch product details from Sears store http://api.developer.sears.com/v3/productDetail/getProduct/Sears /xml/{partNumber}?apikey=XXXXXXXX Click here
      Product Details - getOfferByUid using uId GetOfferByUid is only used for softline items. Uid obtained from Product Details using partnumber response is used to fetch details about variation. http://api.developer.sears.com/v3/productDetail/getOfferByUid/Sears /xml/{uId}?apikey=XXXXXXXXX Click here

       

      Test this Now! 

      Using API console you can fire API urls and view response Click here 

       

      Request parameters

      <Parameter Required Description Values
      storeName Yes path variable - store name Sears , Kmart
      Content Yes path variable - content type xml, json
      partNumber Yes path variable – product identification number. Available from Product Search API response. 04668802000P
      uId Yes path variable – vairant unique identification number. Available from Product Details(getProduct by Part Number)  API response. d55b58dc-b28e-4d2b-8d01-945e60b09b2a
      Accept Yes HTTP header parameter application/xml, application/json (default)
      apikey Yes unique key provided after registering on Sears Developer Network http://developer.sears.com/user/register  
      showRR No This parameter need to be passed as “y” to get ratings and review count y or n
      showSpec No Indicates whether or not the specifications (attributes) section should be included in the response false (default), true

       

      Response details

      Response Node Description Values
      SSIN Ssin number 06784232000P
      MarkForDelete Value indicating if the item is MFD No
      PartNumber Unique identifier of a product SPM5779984601
      MfgPartNumber Manufacturing part number of a product 5169B003-kit-61527
      ItemPNO Unique identifier of a product 027W004765283001
      StoreId Store Id 10153
      CatEntryId It is used to uniquely identify a product in commerce table. This is used while adding an item to the cart 40103976
      CatalogId The catalog id. It’s always constant 12605 - Sears; 10104 - Kmart
      LangId Language identifier for English -  -1
      IsZipCodeRequired If zipCode is required or not false
      BrandName Product brand name Canon
      DescriptionName Product description name 18.2 cu. ft. Top-Freezer Refrigerator - White
      Images All image URLs are placed inside this node  
      MainImageUrl The main image URL of the product http://c.shld.net/rpx/i/s/i/spin/image/spin_prod_746352912 (this url format can vary )
      ImageUrls The additional image URL of the product http://c.shld.net/rpx/i/s/i/spin/image/spin_prod_181760701 (this url format can vary )
      ProductVideoURL The URL for accessing ProductVideo if eligible  
      VariantInfo All variant information is clubbed under this node  
      pId The product id used to uniquely identify a product in commerce table. This is used while adding an item to the cart.  
      isPreSelectQty Denotes that the variants would be pre-selected or not false, true
      isSPU Denotes if product is eligible for store pickup false, true
      IsMbrPrice Denotes if member price is available for this variant N , Y
      numOfAtts Number of attributes (Size,Color) available 2
      attName Attribute name Color , Size
      isDEME Denotes if product is eligible for email me false
      hasVariant Denotes if variant is available for product true, false
      name Variant product description name Men's Polo Shirt - Striped
      Model The product manufacture model number 11-6730-2N
      varName The product variant name Men's
      stk Denotes if variant product is in stock True , false
      ksn Value of Key Stock Number -  to identify different versions of same product 5961738
      price selling price of product 21.99
      pI The position Index to display the rank of the variant 0
      aVal he variant attribute value Short
      colorSwatchList All swatch image related information is provided under this node  
      SkuList All sku related information  of a product is found here  
      productVariant Denotes if the product is a VARIATION or NON-VARIATION product  
      RelatedUrl Details on the related URL of a product. Example: A jeans could have a link to display the 'Size Guide'  
      FitmentRequired Denotes if it is an automotive product true, false
      Swatches All swatch related information is provided under this node  
      Specifications All specifications related to this product is provided here if showSpec=true is send in request  
      Specification Child node of Specifications  
      Label Specification label Color and Styling:
      Attribute Specification value Color Family:White
      JewelryDisclosure Disclosure provided for jewelery Ex.Diamond weights may not be exact, but are never more than .05 carats below the stated weight
      HazardInfo Information on hazards related to product Ex. in xml format : <HazardInfo> <ChokingHazard> <WarningMessage>Choke Hazard - Contains Small Parts</WarningMessage> </ChokingHazard> <SafetyWarningInfo> <sampleMessage> </SafetyWarningInfo> </HazardInfo>
      Prop65Flag If product is has Prop65 warning Yes
      ReviewRating NumReview and rating details are provided under this node  
      Rating Product rating 2
      NumReview Number of reviews for this  product 10
      ProductOptions All options or plans available for this product is provided under this node  
      MaintenanceAgreement Denotes if product has maintenance agreement Yes , blank if not available
      ProductProtectionPlan Denotes if product has a protection plan Yes, blank if not available
      InstallationKit Denotes if product comes with installation kit Yes, blank if not available
      Connection Denotes if product requires a connection (ex.gas hookups) Yes, blank if not available
      Accessory Denotes if product has accessory Yes, blank if not available
      SmartPlan Denotes if product has a smart plan Yes, blank if not available
      GiftWrap Denotes if product is eligible for gift wrap Yes, blank if not available
      ViewOnly Denotes this product can be only viewed  i.e. cannot be added to the cart if value is true True, blank if not available
      CheckOutEnable Denotes if product is enabled for checkout False,True
      ExpressCheckOutEligible Denotes if product is eligible for express checkout Y<
      MobileExpressCheckOutEligible Denotes if product is eligible for express checkout on mobile Y
      Availability All information regarding product availability is provided under this node  
      InStock Denotes whether product is in-stock or not 0 - Not available; 1- available
      WebStatus Denotes whether product is currently available or not 0 - Not available; 1- available
      NDDAvailablity Denotes if Next Day Delivery eligible or not  
      Storepickupeligible Denotes whether product is eligible for store pickup or not 0 - Not eligible; 1- eligible
      SRESEligible Denotes whether product is eligible for store reservation or not 0 - Not eligible; 1- eligible
      StsType Denotes if product is ship to store item SRES
      FreeShippingEligible Denotes if item is eligible for free shipping True, blank if not available
      IsKMartSPU Denote if product is eligible for pickup in Kmart store True, blank if not available
      PreSellInd Denotes if product is a pre sell item Yes, blank if not available
      Fulfillment All fulfillment options available for this product is provided under this node  
      HaulAway Denotes if product is eligible for haul away Yes
      ArrivalMethods All possible fulfillment of product is provided under this node  
      ArrivalMethod Available fulfillment for this product Ship, pickup, delivery, VD (vendor direct)
      LMPStoreDetails Local marketplace(LMP) enabled store details are available under this node  
      StoreUnitNumber Store number  
      OnHandQuantity Available quantity on hand in LMP stores  
      SPU Denotes if product is eligible for store pickup True, blank if not available
      Mailable Denotes if product is mailable True, blank if not available
      SRES Denotes if product is eligible for store reservation True, blank if not available
      PickUpOption Denotes if product is eligible for pickup 0,1
      DistributionCenter Denotes type of distribution center Take Width (TW) / Vendor Direct (VD) / DDC
      SellerInfo All seller information is provided under this node  
      VendorId Denotes product vendor id MKT (market place product), 000020420
      SoldBy Denotes by whom product is sold by Sears,Kmart
      SellerCount Number of other sellers selling same product 1
      SellerId unique seller id of merchant  
      otherFBMMerchants Other fulfillments available by Merchants are available under this node  
      Merchant All merchant details are provided under this node  
      MapIndicator Map price details are provided under this node  
      MapPriceDescription Represents the Map description
      • 1,4 - Add to Cart to see sale price
      • 2,5 - Go to Checkout to see sale price
      • 3,6 - See price
      • 7- No message
      • 8- Continue to Checkout to See price
      MapPriceValidDate Represents valid through date  
      MappedPriceIndicator represents the Map rule # 1,2
      OnlineOnlyPrice A flag to denote if the product is eligible for online price 0 - Not eligible; 1 – eligible
      RegionalPriceIndicator Denotes if item is eligible for regional pricing 1 – eligible
      SalePrice Denotes sale price of product 736.90
      RegularPrice Denotes regular price of product 736.90
      Offers All available offers / promotions are provided in this node  
      SpecialOffer Indicates if product has special offer or not True, blank if not available
      ZeroFinance Indicates if product is eligible for zero percent finance Yes, blank if not available
      MarkForDelete Indicating if product is MFD No
      StoreId Sears or Kmart Store Id 10153
      IsZipCodeRequired If zipcode is required or not false
      ShowAKHIMessage Show Alaska Hawai message true
      AutomotiveDivision Indicates if it a automotive division or not false
      AttrVal Object which has attribute name and value of a product Medium, Wide
      Uid    
      Id Unique identifier for attributes 03d008a0-d260-47b3-82a7-750a62b5a1fc
      UIDDefiningAttribute    
      Name Attribute name Width
      Value Attribute value Medium
      ShortDescription Short description of the product Men's Work Boots DuraShocks Take the Sting Out of Scaffolding.....
      LongDescription Long description of the product Wolverine Men's Work Boots feature tough braided laces that keep these boots on.....
      ProductURL Product URL /wolverine-men-s-durashocks-6inch-soft-toe-work-boot
      VendorDunsNo Vendor duns number 376582
      FreeShippingThreshold Threshold after which the product will be eligible for free shipping 59
      LayawayEligible Indicates if the product is eligble for layaway false
      IsMarketPlaceitem Indicates if the product is a marketplace item false
      ClickToTalk Indicates if the product is eligible for click to talk false
      spinId Gives the metadata  identifier of the  master hierarchy starting from the highest level to the lowest level to which the product belongs to 1350152512
      upc UPC code of the product 792462174039
      FollowItFlag Follow it flag true
      FulfilledBy Parent store name Sears
      ItemType Item type SHC
      StatusData Details in this node indicates the health of response returned  
      ResponseCode Denotes success/failure condition of response rendered 0 - Success; 1 - Failure
      RespMessage Message to display the details of response The action is successful, This product is no longer available

       

    • <?xml version="1.0" encoding="UTF-8"?>
      <RefactorSPUPickupData>
         <sPUStoresCount>76</sPUStoresCount>
         <highestStoreIndex>6</highestStoreIndex>
         <partnumber>04160651003</partnumber>
         <sPUStores>
            <SPUStore>
               <StoreNumber>0001570</StoreNumber>
               <IsPreferredStore>false</IsPreferredStore>
               <AutoStoreIndicator>false</AutoStoreIndicator>
               <StoreName>WOODFIELD MALL</StoreName>
               <StoreAddress>2  WOODFIELD MALL</StoreAddress>
               <StoreCity>SCHAUMBURG</StoreCity>
               <StoreState>ILLINOIS</StoreState>
               <StoreCountry>US</StoreCountry>
               <StoreZipCode>60173</StoreZipCode>
               <FFMType>SPU</FFMType>
               <QtyAvailable>1</QtyAvailable>
               <Distance>5</Distance>
               <NewItemInfo>SPU|0001570||04160651003</NewItemInfo>
               <SPUAvailabilityMsg>In Stock Today</SPUAvailabilityMsg>
               <Days />
               <StoreDetails>
                  <StorePhone>8473302356</StorePhone>
                  <StoreHours>CDT</StoreHours>
                  <Monday>10:00am to 9:00pm</Monday>
                  <Tuesday>10:00am to 9:00pm</Tuesday>
                  <Wednesday>10:00am to 9:00pm</Wednesday>
                  <Thursday>10:00am to 9:00pm</Thursday>
                  <Friday>10:00am to 9:00pm</Friday>
                  <Saturday>10:00am to 9:00pm</Saturday>
                  <Sunday>11:00am to 9:00pm</Sunday>
                  <WeekDayTime>10:00am to 9:00pm</WeekDayTime>
               </StoreDetails>
            </SPUStore>
            <SPUStore>
               <StoreNumber>3914</StoreNumber>
               <IsPreferredStore>false</IsPreferredStore>
               <AutoStoreIndicator>false</AutoStoreIndicator>
               <StoreName>Kmart</StoreName>
               <StoreAddress>156 South Gary Ave</StoreAddress>
               <StoreCity>Bloomingdale</StoreCity>
               <StoreState>ILLINOIS</StoreState>
               <StoreCountry>US</StoreCountry>
               <StoreZipCode>60108</StoreZipCode>
               <FFMType>DRES</FFMType>
               <QtyAvailable>15</QtyAvailable>
               <Distance>7</Distance>
               <NewItemInfo>DRES|3914|2-3|04160651003</NewItemInfo>
               <SPUAvailabilityMsg>Arrives by Mar 20</SPUAvailabilityMsg>
               <Days>2-3</Days>
               <StoreDetails>
                  <StorePhone>6303070260</StorePhone>
                  <StoreHours>CDT</StoreHours>
                  <Monday>8:00am to 9:00pm</Monday>
                  <Tuesday>8:00am to 9:00pm</Tuesday>
                  <Wednesday>8:00am to 9:00pm</Wednesday>
                  <Thursday>8:00am to 9:00pm</Thursday>
                  <Friday>8:00am to 9:00pm</Friday>
                  <Saturday>8:00am to 9:00pm</Saturday>
                  <Sunday>8:00am to 9:00pm</Sunday>
                  <WeekDayTime>8:00am to 9:00pm</WeekDayTime>
               </StoreDetails>
            </SPUStore>
            ...
            ...
            ...
            </SPUStore>
         </sPUStores>
         <status>
            <StatusCode>0</StatusCode>
            <StatusMessage>The action is successful</StatusMessage>
         </status>
         <ApiTracking>Server: null|Tracking ID: {1426716339154}|API Client Session Key: NA|Time : Wed Mar 18 17:05:39 CDT 2015|UID : 8028306855871700933|From Cache : N</ApiTracking>
      </RefactorSPUPickupData>