00001	Request Timeout.
00002	Invalid form data.
00004	Third party API is down.

Add Messages to a Message component to all locales

add messages to a MessageComponent with a specific name

Request Parameters

kvp: map
name: string

POST /api/cms/addMessageToAllLocales

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"/test","kvp":{"test1":"test1","test2":"test2"}}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/addMessageToAllLocales

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"/test","kvp":{"test1":"test1","test2":"test2"}}}

Example Response

{"result":{}}

Live Response

Create a content document

persistent a content document to couch via file upload.

Request Parameters

prefixfile: string

media file base name , like delivery_man
filename: string
optional

generic content document file name.
locale: string

locale ID, such as en_us, en_uk, de_de
title: string
optional

content document title.
linkurl: string
optional

linkurl associated with the file.
linktype: string
optional

link type.
title: string
optional

content document title.
alttext: string
optional

alt text.
imagemap: string
optional

imagemap.
height: int
optional

image file height.
width: int
optional

image file width.
startdate: long

start date in long integer format by js conversion.
enddate: long

end date in long integer format by js conversion.

POST /api/cms/createContentDoc

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"imagemap":"test image map","linktype":"Info","alttext":"SKECHERS Delivery Guy","height":483,"locale":"en_US","linkurl":"/info/slip-and-fall-warranty","prefixfile":"delivery-man","filename":"TEST_1234.jpg","title":"SKECHERS Delivery Guy","enddate":2951917525475,"width":269,"startdate":1374044400000}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/createContentDoc

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"imagemap":"test image map","linktype":"Info","alttext":"SKECHERS Delivery Guy","height":483,"locale":"en_US","linkurl":"/info/slip-and-fall-warranty","prefixfile":"delivery-man","filename":"TEST_1234.jpg","title":"SKECHERS Delivery Guy","enddate":2951917525475,"width":269,"startdate":1374044400000}}

Example Response

{"result":"successful"}

Live Response

Create a keyword group

Use this to create a keyword group

Request Parameters

locale: string
keywordtype: string
input: list[string]
output: list[string]

POST /api/cms/createKeywordGroup

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","keywordtype":"search_redirects","input":["silver","grey","sparking"],"output":["silver"]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/createKeywordGroup

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","keywordtype":"search_redirects","input":["silver","grey","sparking"],"output":["silver"]}}

Example Response

{"result":{}}

Live Response

Create a new Group

Request Parameters

locale: string
admin: boolean

POST /api/group/createGroup

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"test company","garpacid":"12345","url":"/testCompany","shippingmethods":{},"description":"empty","locale":"en_US_direct","code":"adf93d","discountcode":"30%off","status":"active"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/group/createGroup

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"test company","garpacid":"12345","url":"/testCompany","shippingmethods":{},"description":"empty","locale":"en_US_direct","code":"adf93d","discountcode":"30%off","status":"active"}}

Example Response

{"result":{}}

Live Response

Create/Update a Page

Use this to create/update a page

Request Parameters

url: string
locale: string
pagetitle: string
metatext: string
optional
topnav: boolean

indicates whether the page contains a top navigation
sitemap: boolean

indicates whether the page will be included in the siteamp
lastmodifiedname: string
lastmodifiedtime: long
startdate: long
enddate: long
rows: list

POST /api/cms/updatePage

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"sitemap":true,"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"id":"page:en_uk:/fortest","status":"active","enddate":1411494671167,"rows":[{"rowtype":"full","slots":[{"bgcolor":"black","droplets":[{"dtype":"html","styles":[],"link":"http://www.skechers.com/en-us","title":"View All","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"header","lastmodifiedtime":123456,"bgimage":"none"}]}],"startdate":1411424671167}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updatePage

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"sitemap":true,"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"id":"page:en_uk:/fortest","status":"active","enddate":1411494671167,"rows":[{"rowtype":"full","slots":[{"bgcolor":"black","droplets":[{"dtype":"html","styles":[],"link":"http://www.skechers.com/en-us","title":"View All","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"header","lastmodifiedtime":123456,"bgimage":"none"}]}],"startdate":1411424671167}}

Example Response

{"result":{}}

Live Response

Create/Update a Page Draft

Use this to create/update a page draft

Request Parameters

url: string
locale: string
template: string
pagetitle: string
metatext: string
optional
topnav: boolean

indicates whether the page contains a top navigation
dynamic: boolean
lastmodifiedname: string
lastmodifiedtime: long
droplets: list

POST /api/cms/updatePageDraft

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"id":"pagedraft:en_uk:/fortest","status":"active","template":"templateA","rows":[{"rowtype":"full","slots":[{"bgcolor":"black","droplets":[{"dtype":"html","styles":[],"enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"header","lastmodifiedtime":123456,"bgimage":"none"}]}]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updatePageDraft

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"id":"pagedraft:en_uk:/fortest","status":"active","template":"templateA","rows":[{"rowtype":"full","slots":[{"bgcolor":"black","droplets":[{"dtype":"html","styles":[],"enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"header","lastmodifiedtime":123456,"bgimage":"none"}]}]}}

Example Response

{"result":{}}

Live Response

Create/Update a global Slot

Use this to update a global slot

Request Parameters

id: string
key: string
refid: string
optional
lastmodifiedname: string
lastmodifiedtime: long
droplets: list

POST /api/cms/updateSlot

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"bgcolor":"black","droplets":[{"dtype":"html","link":"http://www.skechers.com/en-us","title":"View All","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"en_CA:testfooter","lastmodifiedtime":123456,"id":"slot:en_CA:testfooter","bgimage":"none"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateSlot

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"bgcolor":"black","droplets":[{"dtype":"html","link":"http://www.skechers.com/en-us","title":"View All","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"en_CA:testfooter","lastmodifiedtime":123456,"id":"slot:en_CA:testfooter","bgimage":"none"}}

Example Response

{"result":{}}

Live Response

Create/Update a keyword group

Use this to create/update a keyword group

Request Parameters

id: string
locale: string
keywordtype: string
input: list[string]
output: list[string]

POST /api/cms/updateKeywordGroup

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","keywordtype":"search_redirects","input":["silver","grey","sparking"],"output":["silver"]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateKeywordGroup

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","keywordtype":"search_redirects","input":["silver","grey","sparking"],"output":["silver"]}}

Example Response

{"result":{}}

Live Response

Delete a ContentDocument

Use this to delete a contentDocument

Request Parameters

locale: string
filename: string

POST /api/cms/deleteContentDoc

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","filename":"yellowduck_cbabe62db51b.png"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/deleteContentDoc

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","filename":"yellowduck_cbabe62db51b.png"}}

Example Response

{"result":{}}

Live Response

Delete a Group

Use this to delete a specific group

Request Parameters

locale: string

POST /api/group/deleteGroup

Example Request

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

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"url":"/testCompany"}}

Example Response

{"result":{}}

Live Response

Delete a global Slot

Use this to delete a global slot

Request Parameters

locale: string
optional
key: string

POST /api/cms/deleteSlot

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","key":"en_US:footer"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/deleteSlot

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","key":"en_US:footer"}}

Example Response

{"result":{}}

Live Response

Delete a keyword group

Use this to delete a KeywordGroup

Request Parameters

locale: string
id: string

POST /api/cms/deleteKeywordGroup

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","id":"test_search_keywordgroup123"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/deleteKeywordGroup

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","id":"test_search_keywordgroup123"}}

Example Response

{"result":{}}

Live Response

Delete a page

Use this to delete a page

Request Parameters

locale: string
url: string

POST /api/cms/deletePage

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","url":"/info/help"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/deletePage

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","url":"/info/help"}}

Example Response

{"result":{}}

Live Response

Delete a page draft

Use this to delete a page draft

Request Parameters

locale: string
url: string

POST /api/cms/deletePageDraft

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","url":"/info/help"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/deletePageDraft

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","url":"/info/help"}}

Example Response

{"result":{}}

Live Response

Get All Redirects

Use this to get all Redirects by a locale

Request Parameters

locale: string

POST /api/cms/getRedirects

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/cms/getRedirects

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get All Thesaurus

Use this to get all Thesaurus by a locale

Request Parameters

locale: string

POST /api/cms/getThesaurus

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/cms/getThesaurus

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get Apostrophe

Use this to get a Apostrophe by locale

Request Parameters

locale: string
searchword: string

POST /api/cms/getApostrophe

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","searchword":""}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getApostrophe

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","searchword":""}}

Example Response

{"result":{}}

Live Response

Get CMS Revisions

Use this to get Revisions for page, pagedraft, slot, messages, emailContent

Request Parameters

id: string

POST /api/cms/getCMSRevisions

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"id":"page:en_us:"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getCMSRevisions

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"id":"page:en_us:"}}

Example Response

{"result":{}}

Live Response

Get EmailContent

Use this to get an EmailContent with a specific name

Request Parameters

locale: string
name: string

POST /api/cms/getEmailContent

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","name":"orderConfirmation"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getEmailContent

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","name":"orderConfirmation"}}

Example Response

{"result":{}}

Live Response

Get EmailContents

Use this to get a list of EmailContents for a specific locale

Request Parameters

locale: string

POST /api/cms/getEmailContents

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/cms/getEmailContents

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get Group

Use this to get a specific group with a specific locale

Request Parameters

locale: string
url: string

POST /api/group/getGroup

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US_direct","url":"/testCompany"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/group/getGroup

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US_direct","url":"/testCompany"}}

Example Response

{"result":{}}

Live Response

Get Group By GarpacId

Use this to get a specific group by garpac id

Request Parameters

locale: string
garpacId: string

POST /api/group/getGroupByGarpacId

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US_direct","garpacId":"10469"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/group/getGroupByGarpacId

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US_direct","garpacId":"10469"}}

Example Response

{"result":{}}

Live Response

Get Group by code

Use this to get a specific group by group code

Request Parameters

locale: string
code: string

POST /api/group/getGroupByCode

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US_direct","code":"J8fImA"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/group/getGroupByCode

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US_direct","code":"J8fImA"}}

Example Response

{"result":{}}

Live Response

Get Groups

Use this to get all the groups for a specific locale

Request Parameters

locale: string

POST /api/group/getGroups

Example Request

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

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US_direct"}}

Example Response

{"result":{}}

Live Response

Get MessageComponent

Use this to get a MessageComponent with a specific name

Request Parameters

locale: string
name: string

POST /api/cms/getMessageComponent

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","name":"/style/default"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getMessageComponent

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","name":"/style/default"}}

Example Response

{"result":{}}

Live Response

Get MessageComponents

Use this to get a list of MessageComponents for a specific locale

Request Parameters

locale: string

POST /api/cms/getMessageComponents

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/cms/getMessageComponents

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get PageDrafts

Use this to get a list of pages drafts belong to a specific locale

Request Parameters

locale: string
url: string
optional
lastmodifiedname: string
optional

POST /api/cms/getPageDrafts

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/cms/getPageDrafts

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get Pages

Use this to get a list of pages belong to a specific locale

Request Parameters

locale: string
url: string
optional
lastmodifiedname: string
optional

POST /api/cms/getPages

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/cms/getPages

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get Pages By Media File

Use this to get a list of pages with specific locale and media file name

Request Parameters

locale: string
filename: string
optional

POST /api/cms/getPagesByFileName

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","filename":"delivery-man_1beef7999160.jpg"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getPagesByFileName

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","filename":"delivery-man_1beef7999160.jpg"}}

Example Response

{"result":{}}

Live Response

Get Site maintenance Setting

Request Parameters

locale: string
admin: boolean

POST /api/cms/getSiteMaintenanceSetting

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","admin":"false"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getSiteMaintenanceSetting

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","admin":"false"}}

Example Response

{"result":{}}

Live Response

Get SiteMap

Use this to get the sitemap

Request Parameters

locale: string

POST /api/cms/getSiteMapForUpdate

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/cms/getSiteMapForUpdate

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get Slots

Use this to get a list of Slots

Request Parameters

locale: string
optional
key: string
optional

POST /api/cms/getSlots

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","key":"en_US:footer"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getSlots

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","key":"en_US:footer"}}

Example Response

{"result":{}}

Live Response

Get a PageDraft

Use this to get a PageDraft using its locale and url

Request Parameters

locale: string
url: string

POST /api/cms/getPageDraft

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","url":"/"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getPageDraft

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","url":"/"}}

Example Response

{"result":{}}

Live Response

Get a Redirect

Use this to get a Redirect by a search keyword

Request Parameters

locale: string
searchword: string

POST /api/cms/getRedirects

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/cms/getRedirects

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get a Slot

Use this to get a Slot using its key

Request Parameters

locale: string
key: string

POST /api/cms/getSlot

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","key":"en_US:footer"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getSlot

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","key":"en_US:footer"}}

Example Response

{"result":{}}

Live Response

Get a Thesaurus

Use this to get a Thesaurus by a search keyword

Request Parameters

locale: string
searchword: string

POST /api/cms/getThesaurus

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/cms/getThesaurus

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US"}}

Example Response

{"result":{}}

Live Response

Get all Stopwords

Use this to get a Stopwords by a search keyword

Request Parameters

locale: string
searchword: string

POST /api/cms/getStopwords

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","searchword":""}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/getStopwords

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_US","searchword":""}}

Example Response

{"result":{}}

Live Response

Get all contents by locale

retrieves a list of the contentDocuments by locale

Request Parameters

locale: string

locale ID, such as en_us, en_uk, de_de
filename: string
optional

generic content document file name.

POST /api/cms/getContentDocs

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/cms/getContentDocs

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"locale":"en_us"}}

Example Response

{"result":[{"height":160,"locale":"en_US","filename":"13610_BKHP_7f9219ea2c75.jpg","enddate":2961533076321,"width":180,"startdate":1383696276321},{"linktype":"Info","alttext":"SKECHERS Delivery Guy","height":483,"locale":"en_US","linkurl":"/info/slip-and-fall-warranty","filename":"delivery-man_1beef7999160.jpg","title":"SKECHERS Delivery Guy","enddate":2951917525475,"width":269,"startdate":1374044400000}]}

Live Response

Get shipping address

Get shipping address using garpac id and employee id

Request Parameters

employeeid: string
optional
garpacid: string

POST /api/group/getEmployeeShippingAddress

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"employeeid":"56789","garpacid":"123"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/group/getEmployeeShippingAddress

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"employeeid":"56789","garpacid":"123"}}

Example Response

{"result":{}}

Live Response

Preview a Page

Use this to write the Page object to the preview cache

Request Parameters

url: string
locale: string
pagetitle: string
metatext: string
optional
topnav: boolean

indicates whether the page contains a top navigation
lastmodifiedname: string
lastmodifiedtime: long
startdate: long
enddate: long
droplets: list

POST /api/cms/preview

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"status":"active","enddate":1411494671167,"rows":[{"rowtype":"full","slots":[{"key":"header","lastmodifiedname":"frontend@skx.com","lastmodifiedtime":123456,"droplets":[{"dtype":"html","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}]}]}],"startdate":1411424671167}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/preview

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"status":"active","enddate":1411494671167,"rows":[{"rowtype":"full","slots":[{"key":"header","lastmodifiedname":"frontend@skx.com","lastmodifiedtime":123456,"droplets":[{"dtype":"html","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}]}]}],"startdate":1411424671167}}

Example Response

{"result":{}}

Live Response

Preview an Email

Use this to preview an EmailContent with a specific name

Request Parameters

name: string
emailTo: string
subject: string
html: string
optional
text: string
optional

POST /api/cms/previewEmail

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"Order Confirmation","subject":"Order Confirmation","text":"Order id:{{orderid}}","previewDataNames":["CC"],"emailTo":"test@yahoo.com","from":"order@skechers.com","html":"Order id:{{orderid}}"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/previewEmail

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"Order Confirmation","subject":"Order Confirmation","text":"Order id:{{orderid}}","previewDataNames":["CC"],"emailTo":"test@yahoo.com","from":"order@skechers.com","html":"Order id:{{orderid}}"}}

Example Response

{"result":{}}

Live Response

Reassign Global Slot

Request Parameters

pages: List[string]
optional
drafts: List[string]
optional

POST /api/cms/updateGlobalSlot

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"pages":["page:en_us:/jmc-test"],"key":"slot:en_US:AUH","newkey":"slot:en_US:Footer"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateGlobalSlot

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"pages":["page:en_us:/jmc-test"],"key":"slot:en_US:AUH","newkey":"slot:en_US:Footer"}}

Example Response

{"result":{}}

Live Response

Remove Messages of a Message component from all locales

Remove messages of MessageComponent with a specific name from specific locales, if you don't specify the locales(empty list), then the change will apply to all locales. if the name of the messageComponent is not specified, then the message(s) will be removed from all messageComponents.

Request Parameters

name: string
optional
keys: List[String]

keys of the messages
locs: List[String]

locales

POST /api/cms/removeMessageFromAllLocales

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"/test","keys":["test1","test2"],"locs":["en_US"]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/removeMessageFromAllLocales

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"/test","keys":["test1","test2"],"locs":["en_US"]}}

Example Response

{"result":{}}

Live Response

Udpate Message Component

update Message Component with a specific name

Request Parameters

locale: String
kvp: map
name: string

POST /api/cms/updateMessageComponent

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"/test","locale":"en_US","kvp":{"test1":"test1","test2":"test2"}}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateMessageComponent

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"/test","locale":"en_US","kvp":{"test1":"test1","test2":"test2"}}}

Example Response

{"result":{}}

Live Response

Update EmailContent

Use this to update an EmailContent

Request Parameters

id: string
locale: string
name: string
from: string
subject: string
html: string
text: string
previewdata: string

POST /api/cms/updateEmailContent

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"checkout","subject":"order confirmation","description":"","text":"{{name}}, {{feature.description}}!","previewdata":"","locale":"en_US","id":"checkout","from":"order@skechers.com","html":"{{name}}, {{feature.description}}!"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateEmailContent

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"checkout","subject":"order confirmation","description":"","text":"{{name}}, {{feature.description}}!","previewdata":"","locale":"en_US","id":"checkout","from":"order@skechers.com","html":"{{name}}, {{feature.description}}!"}}

Example Response

{"result":{}}

Live Response

Update Group

Request Parameters

locale: string
admin: boolean

POST /api/group/updateGroup

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"test company","garpacid":"12345","url":"/testCompany","shippingmethods":{},"description":"description","locale":"en_US_direct","code":"adf93d","id":"group:en_us_direct:/testCompany","discountcode":"30%off","status":"active"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/group/updateGroup

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"name":"test company","garpacid":"12345","url":"/testCompany","shippingmethods":{},"description":"description","locale":"en_US_direct","code":"adf93d","id":"group:en_us_direct:/testCompany","discountcode":"30%off","status":"active"}}

Example Response

{"result":{}}

Live Response

Update Site maintenance Setting

Request Parameters

locale: string
maintenanceMsg: string
maintenanceUrl: string
start: string
optional
end: string
optional

POST /api/cms/updateSiteMaintenanceSetting

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"maintenanceUrl":"http://localhost:9000","locale":"en_US","maintenanceMsg":"123","end":0,"start":0}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateSiteMaintenanceSetting

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"maintenanceUrl":"http://localhost:9000","locale":"en_US","maintenanceMsg":"123","end":0,"start":0}}

Example Response

{"result":{}}

Live Response

Update Site maintenance doc

Request Parameters

status: Int

0 -> Not in Maintenance, 1 -> Site shows Maintenance Message, 2 -> Pages Gets Redirected to Maintenance Static Page, 3 -> Site is readonly
start: long

Start time of site maintenance in milliseconds
end: long

End time of site maintenance in milliseconds

POST /api/cms/updateSiteMaintenanceDoc

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"status":0,"start":0,"end":0}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateSiteMaintenanceDoc

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"status":0,"start":0,"end":0}}

Example Response

{"result":{}}

Live Response

Update SiteMap

Use this to update sitemap

Request Parameters

locale: string
values: list of string

POST /api/cms/updateSiteMap

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"values":["/help","/info/return"],"locale":"en_US"},"exampleResponse":{"result":{}}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateSiteMap

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"values":["/help","/info/return"],"locale":"en_US"},"exampleResponse":{"result":{}}}

Example Response

null

Live Response

Update a content document

update a content document its attributes

Request Parameters

locale: string

locale ID, such as en_us, en_uk, de_de
filename: string
optional

generic content document file name.
title: string
optional

content document title.
linkurl: string
optional

linkurl associated with the file.
linktype: string
optional

link type.
title: string
optional

content document title.
alttext: string
optional

alt text.
imagemap: string
optional

imagemap.
height: int
optional

image file height.
width: int
optional

image file width.
startdate: long

start date in long integer format by js conversion.
enddate: long

end date in long integer format by js conversion.

POST /api/cms/updateContentDoc

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"imagemap":"delivery man","linktype":"Info","alttext":"SKECHERS Delivery Man","height":160,"locale":"en_US","linkurl":"/info/slip-and-fall-warranty","filename":"delivery-man_2a5a8d49da2a.jpg","title":"SKECHERS Delivery Guy","enddate":2951917525475,"width":320,"startdate":1374044400000}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/cms/updateContentDoc

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"imagemap":"delivery man","linktype":"Info","alttext":"SKECHERS Delivery Man","height":160,"locale":"en_US","linkurl":"/info/slip-and-fall-warranty","filename":"delivery-man_2a5a8d49da2a.jpg","title":"SKECHERS Delivery Guy","enddate":2951917525475,"width":320,"startdate":1374044400000}}

Example Response

{"result":"successful"}

CMS

APIs

Introduction

Error Codes

Response Parameters

errorCode: string

errorMessage: string

Codes

Add Messages to a Message component to all locales

Request Parameters

kvp: map

name: string

Example Request

Example Response

Live Response

Create a content document

Request Parameters

prefixfile: string

filename: string optional

locale: string

title: string optional

linkurl: string optional

linktype: string optional

title: string optional

alttext: string optional

imagemap: string optional

height: int optional

width: int optional

startdate: long

enddate: long

Example Request

Example Response

Live Response

Create a keyword group

Request Parameters

locale: string

keywordtype: string

input: list[string]

output: list[string]

Example Request

Example Response

Live Response

Create a new Group

Request Parameters

locale: string

admin: boolean

Example Request

Example Response

Live Response

Create/Update a Page

Request Parameters

url: string

locale: string

pagetitle: string

metatext: string optional

topnav: boolean

sitemap: boolean

lastmodifiedname: string

lastmodifiedtime: long

startdate: long

enddate: long

rows: list

Example Request

Example Response

Live Response

Create/Update a Page Draft

Request Parameters

url: string

locale: string

template: string

pagetitle: string

metatext: string optional

topnav: boolean

dynamic: boolean

lastmodifiedname: string

lastmodifiedtime: long

droplets: list

Example Request

Example Response

Live Response

filename: string
optional

title: string
optional

linkurl: string
optional

linktype: string
optional

title: string
optional

alttext: string
optional

imagemap: string
optional

height: int
optional

width: int
optional

metatext: string
optional

metatext: string
optional

refid: string
optional

locale: string
optional