Introduction

Create, update, and read operations for SKECHERS.com catalog, including styles, colors, and categories.

Error Codes

The Skechers Web Service uses conventional HTTP response codes to indicate the success or failure of an API request. When a request is valid, but does not complete successfully (e.g. user not found), a response is given containing a specific error code and error message about the point of failure.

Response Parameters

  • errorCode: string

    An error code that can be referenced in the table to the right. Refer to this error code when identifying errors.
  • errorMessage: string

    A human-readable message providing more details about this error.

Codes

07000 Catalog not found
07002 Catalog update fail
07003 ColorMap not found
07004 ColorMap update failed
07016 Catalog Attribute update failed

Add Styles

Add styles to category.

Request Parameters

POST /api/catalog/addStyles

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"categoryuri":"/collections","stylecodes":["12340"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/addStyles
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"categoryuri":"/collections","stylecodes":["12340"]}}

Example Response

null

Live Response


                        

Export Styles

Export Styles. IMPORTANT: Must set processEmail = true in application.conf in order to receieve email.

Request Parameters

  • request: string

    Destination Email
POST /api/catalog/exportStyles

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":"juna@skechers.com"} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/exportStyles
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":"juna@skechers.com"}

Example Response

null

Live Response


                        

Get Available Sizes

Get available sizes by sku numbers

Request Parameters

  • skus: list of strings

    list of sku numbers to get all available sizes for the corresponding skus
POST /api/catalog/getAvailableSizes

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"skus":["683973000019","887047694979"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/getAvailableSizes
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"skus":["683973000019","887047694979"]}}

Example Response

{}

Live Response


                        

GetOMSProductInfo

Get available product Info for OMS, which will only return active and complete product(s) with active and in-stock size(s). When a request contains a color code(for order update), response won't include style name and color.

Request Parameters

  • locale: string

    locale
  • styleCode: string

    Style code
  • colorCode: string
    optional

    color code for the product
POST /api/catalog/getOMSProductInfo

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","styleCode":"4442","colorCode":"bol"}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/getOMSProductInfo
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","styleCode":"4442","colorCode":"bol"}}

Example Response

{}

Live Response


                        

Remove Styles

Remove styles from category.

Request Parameters

POST /api/catalog/removeStyles

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"categoryuri":"/collections","stylecodes":["12340"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/removeStyles
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"categoryuri":"/collections","stylecodes":["12340"]}}

Example Response

null

Live Response


                        

Search Inventory

Searches the web inventory.

Request Parameters

  • style: string
    optional

    Style code of the product being searched.
  • color: string
    optional

    Color code of the product being searched.
  • upc: string
    optional

    Universal product codeof the product being searched.
  • size: string
    optional

    Size of the product being searched.
  • ipaddress: string
    optional

    IP address of the device for which the inventory search is being performed.

Response Parameters

  • message: string

    Returns success if a product is found, invalid request if there are not enough search parameters that are provided, no result when the provided parameters did not match any inventory records, and null if there are multiple products that fit the general description of the search parameters that are provided.
  • skus: Array of SKU objects

    Each SKU object fits the general description of the performed search query. Each sku object has a upc code and size.
POST /api/retail/checkout/search

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"size":"5.0","style":"48863","ipaddress":"172:1:2:3","color":"NAT","upc":"192283020858"}} ' http://retailapi-skechers-com.dev.skechers.com/api/retail/checkout/search
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"size":"5.0","style":"48863","ipaddress":"172:1:2:3","color":"NAT","upc":"192283020858"}}

Example Response

{"result":{"message":"SUCCESS","skus":[]}}

Live Response


                        

Update Attributes

Update Attributes.

Request Parameters

  • attributes: list of strings

    list of attributes to be updated. It would replace existing list of attributes.
POST /api/catalog/updateAttributes

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"attributes":["Vegetarian","Memory Foam"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/updateAttributes
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"attributes":["Vegetarian","Memory Foam"]}}

Example Response

null

Live Response


                        

Update ColorMap

Update ColorMap.

Request Parameters

  • colorcode: string

    ie. WSPK
  • color: string

    Primary color; Used for color refinement ie. WHITE
  • secondarycolor: String
    optional

    Secondary color; Used for color refinement ie. SILVER
  • colordesc: String
    optional

    Used to display on screen ie. 'WHITE / SILVER / PINK'
POST /api/catalog/updateColorMap

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"colorcode":"TEST","color":"WHITE"}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/updateColorMap
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"colorcode":"TEST","color":"WHITE"}}

Example Response

null

Live Response


                        

Update Style

Update Style and the products

Request Parameters

  • stylecode: string

    stylecode
  • active: boolean

    true if active else inactive
  • name: string

    style name
  • gender: string

    M for Man, W for Woman, B for boy, G for girl, U for Unisex
  • overview: string

    overview
  • details: string
    optional

    details
  • construction: string
    optional

    construction
  • videourl: string
    optional

    video url such as youtube of the style
  • categories: list of strings

    categories
  • metatext: list of strings

    metatext to be used for searching
  • attributes: list of strings
    optional

    attributes
  • products: string
    optional

    products
POST /api/catalog/updateStyle

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"stylecode":"10001","name":"S LIGHTS - STARLIGHT","products":[{"colorcode":"BKS","active":true}],"metatexts":["test"],"categories":["/test"],"overview":"test","gender":"G","active":true}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/updateStyle
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"stylecode":"10001","name":"S LIGHTS - STARLIGHT","products":[{"colorcode":"BKS","active":true}],"metatexts":["test"],"categories":["/test"],"overview":"test","gender":"G","active":true}}

Example Response

null

Live Response


                        

Verify UPC

This service will verify whether the list of UPC is in-stock and valid. If the UPC comes back with result with a boolean, then it's valid and the boolean represents in-stock status.

Request Parameters

  • request: list of strings

    List of UPC code to be verified
POST /api/catalog/verifyUPC

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":["683973000019","887047694979","886005987146"]} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/verifyUPC
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":["683973000019","887047694979","886005987146"]}

Example Response

{"result":{"887047694979":false,"886005987146":true}}

Live Response


                        

addAttributeToStyles

Add attribute to Styles

Request Parameters

POST /api/catalog/addAttributeToStyles

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"attribute":"","stylecodes":[]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/addAttributeToStyles
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"attribute":"","stylecodes":[]}}

Example Response

{}

Live Response


                        

addCategory

Add a Category

Request Parameters

POST /api/catalog/addCategory

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"coolbrand"}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/addCategory
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"coolbrand"}}

Example Response

{}

Live Response


                        

batchActivateStyles

Update styles' active field

Request Parameters

POST /api/catalog/batchActivateStyles

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","active":"true","stylecodes":["4442"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/batchActivateStyles
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","active":"true","stylecodes":["4442"]}}

Example Response

{}

Live Response


                        

createStyleLog

Create StyleLog

Request Parameters

POST /api/catalog/createStyleLog

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","stylecode":"4442","userid":"test","logs":["test log message"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/createStyleLog
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","stylecode":"4442","userid":"test","logs":["test log message"]}}

Example Response

{}

Live Response


                        

deleteCategory

Delete a Category

Request Parameters

POST /api/catalog/deleteCategory

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"uri":"/collections/coolbrands"}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/deleteCategory
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"uri":"/collections/coolbrands"}}

Example Response

{}

Live Response


                        

deleteColorMap

Delete a ColorMap

Request Parameters

POST /api/catalog/deleteColorMap

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"colorcode":""}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/deleteColorMap
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"colorcode":""}}

Example Response

{}

Live Response


                        

dequeueCatalogUpdate

Dequeue CatalogUpdate

Request Parameters

POST /api/catalog/dequeueCatalogUpdate

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","stylecodes":["4442"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/dequeueCatalogUpdate
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","stylecodes":["4442"]}}

Example Response

{}

Live Response


                        

getAvailableColorsMaria

Get Available Colors for a Style

Request Parameters

  • style: string

    style code
POST /api/catalog/getAvailableColorsMaria

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"style":"4442"}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/getAvailableColorsMaria
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"style":"4442"}}

Example Response

{}

Live Response


                        

getAvailableSizesMaria

Get Available Sizes for a Product from Maria

Request Parameters

  • style: string

    style code
  • color: string

    color code
  • isComplete: Boolean
    optional

    if the product is active and in stock
POST /api/catalog/getAvailableSizesMaria

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"style":"4442","color":"BOL","isComplete":true}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/getAvailableSizesMaria
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"style":"4442","color":"BOL","isComplete":true}}

Example Response

{}

Live Response


                        

getStructuredCategoryList

Get a structured category list

Request Parameters

POST /api/catalog/getStructuredCategoryList

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"uris":["/collections/canvas","/styles/boots/ankle-boots","/styles/boots/motorcycle-boots"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/getStructuredCategoryList
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"uris":["/collections/canvas","/styles/boots/ankle-boots","/styles/boots/motorcycle-boots"]}}

Example Response

{}

Live Response


                        

queueCatalogUpdate

Queue CatalogUpdate

Request Parameters

POST /api/catalog/queueCatalogUpdate

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","stylecodes":["4442"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/queueCatalogUpdate
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US","stylecodes":["4442"]}}

Example Response

{}

Live Response


                        

updateCatalog

Update whole catalog by locale regardless of lastupdate timestamp

Request Parameters

POST /api/catalog/update

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US"}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/update
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en-US"}}

Example Response

{}

Live Response


                        

updateCategory

Update a Category

Request Parameters

POST /api/catalog/updateCategory

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"uri":"/collections/coolbrand","name":"coolbrands"}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/updateCategory
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"uri":"/collections/coolbrand","name":"coolbrands"}}

Example Response

{}

Live Response


                        

updateColorMapping

Update ColorMapping

Request Parameters

POST /api/catalog/updateColorMapping

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"fr-CA","colors":{},"colordesc":{}}} ' http://retailapi-skechers-com.dev.skechers.com/api/catalog/updateColorMapping
{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"fr-CA","colors":{},"colordesc":{}}}

Example Response

{}

Live Response