Skip to product menu
Skip to main content

Get All Stores

OAuthScope

ZohoCommerce.sitesIndex.READ

 

HTTP Request

GET https://commerce.zoho.com/zs-site/api/v1/index/sites

 

Attributes

ParameterDescription
zsite_idlong: The unique identifier of the store.
site_titlestring: The title of the store.
primary_domainstring: The primary domain mapped to the store.
zohofinance_orgidlong: The finance organization ID of the store.

 

 

Request Example

Copiedcurl "https://commerce.zoho.com/zs-site/api/v1/index/sites"
-H "Authorization: Zoho-oauthtoken ***"

Response Example

Copied{
"status_code": "0",
"status_message": "success",
"api_kind": "get_sites",
"get_sites":{
"my_sites":[
{
"zsite_id": "6177900",
"user_id": "572120",
"site_title": "test one",
"created_time": "2018-12-13T13:58:33Z",
"primary_domain": "teststore.zohocommerce.com",
"site_type": 0,
"site_scope": 0,
"last_published_time": "2018-12-13T14:12:35Z",
"zohofinance_orgid": "58927961",
"role": 0,
"plan_id": "0",
"cms_site": true,
"store_enabled": true
}
]
}
}
This API retrieves all stores for the current user.