Skip to product menu
Skip to main content

Store Meta

HTTP Request

GET https://commerce.zoho.com/storefront/api/v1/store-meta

 

Attributes

AttributeDescription
generalobject
orgModestring: Denotes the mode of the organization. Allowed values : LIVE, TEST.
storeIdlong: The unique identifier of the store.
orgIdlong: The corresponding finance organization id of the store.
settingsobject
products_limitint: The limit of products set for pagination purposes.
default_sortbyint: The sort by option set for the store. Allowed values : 0 (popularity), 1 (new), 2 (low to high price), 3 (high to low price), 4 (featured).
commentboxSettingsobject
is_enabledboolean: Denotes whether the commentbox is enabled
allowed_usersint: Allowed values: 1 (registered users), 2 (verified buyers)
is_portal_enabledboolean: Denotes whether member portal is enabled in the store.
moderate_commentsint: Denotes the value of the moderation for comments set in the store. Allowed values: 0 (all comments), 1 (moderation needed for some comments), 2 (moderation needed for all comments).
comments_per_pageint: The number of comments to be shown per page.
spam_protectboolean: Denotes whether captcha is enabled.
email_notifyboolean: Denotes whether email notification is enabled.
portalSettingsobject
zaidlong: The portal id of the store.
statusint: The status of the portal. Allowed values: 0 (Disabled), 1 (Enabled), 2 (Downgraded), 3 (Deleted).
flag_checkout_taxboolean: Denotes whether GST information of the customer should be obtained while checking out.
recommendedProductsboolean: Denotes whether Recommended Products are enabled for the store.
searchBoxint: The value of the search box in the store. Allowed values: 0 (Disabled), 1 (Google Search), 2(Sites Search), 3 (Products Search).
is_gst_registeredboolean: Denotes whether GST is registered for the store.
hostedpage_settingsobject
allow_cod_for_guestboolean: Denotes whether offline payment is allowed for guest users.
multi_currency_view_at_storefrontboolean: Denotes whether multi currency view is enabled for storefront.
terms_of_service_enabledboolean: Denotes whether terms of service is enabled for the store.
allow_order_notes_in_checkoutboolean: Denotes whether order notes are allowed in checkout.
allow_guest_checkoutboolean: Denotes whether guest users are allowed to checkout/
is_online_payment_configuredboolean: Denotes whether online payment gateway is configured for the store.
is_offline_payment_configuredboolean: Denotes whether offline payment gateway is configured for the store.
apply_coupons_at_checkoutboolean: Denotes whether coupons are enabled for the storefront.
terms_of_service_labelstring: Label to be used for the terms of service.
terms_of_service_urlstring: URL of the terms of service page.
restrict_out_of_stock_purchaseboolean: Denotes whether out of stock purchases are restricted for the store.
offline_payment_methodsobject
labelstring: The payment option to be displayed on the storefront.
additional_chargesdouble: The additional charges to be applied for this mode of payment.
minimum_order_amountdouble: The minimum order value that is eligible for offline payments.
maximum_order_amountdouble: The maximum order value that is eligible for offline payments.
instructionstring: The instruction to be displayed for offline payments.
currencyobject
formatstring: The format of the currency.
symbolstring: The symbol of the currency.
codestring: The currency code.
symbol_formattedstring: The formatted symbol of the currency.
symbol_on_leftboolean: Denotes whether the symbol of the currency should be displayed on the left.
code_on_leftboolean: Denotes whether the currency code should be displayed on the left.

 

Request Example

Copiedcurl -i -L -X GET
-H "domain-name:zylkerfashionstore.zohostore.com"
'https://commerce.zoho.com/storefront/api/v1/store-meta'

Success Response

Copied{
"status_code": "0",
"status_message": "success",
"api_kind": "kind#store-meta",
"payload": {
"general": {
"orgMode": "LIVE",
"storeId": "682219938",
"orgId": "682219181"
},
"settings": {
"flag_sorting": true,
"commentboxSettings": {
"is_enabled": true,
"allowed_users": 1,
"scope_id": "1147341000000002044",
"is_portal_enabled": true,
"moderate_comments": 2,
"comments_per_page": 5,
"spam_protect": true,
"email_notify": true
},
"products_limit": 50,
"default_sortby": 0,
"portalSettings": {
"zaid": "10012546840",
"status": 1
},
"flag_checkout_tax": false,
"recommendedProducts": true,
"searchBox": 3
},
"is_gst_registered": false,
"hostedpage_settings": {
"allow_cod_for_guest": true,
"multi_currency_view_at_storefront": true,
"terms_of_service_enabled": false,
"allow_order_notes_in_checkout": false,
"allow_guest_checkout": true,
"is_online_payment_configured": false,
"is_offline_payment_configured": true,
"offline_payment_methods": [
{
"payment_mode": "cash_on_delivery",
"label": "Cash on Delivery",
"additional_charges": "0",
"maximum_order_amount": "10000",
"instruction": "",
"minimum_order_amount": "10"
}
],
"apply_coupons_at_checkout": true,
"terms_of_service_label": "",
"terms_of_service_url": "",
"restrict_out_of_stock_purchase": true
},
"currency": {
"format": "###,##0.00",
"symbol": "$",
"code": "USD",
"symbol_formatted": "$",
"symbol_on_left": true,
"code_on_left": true
}
}
}
Use this API to get meta information of the storefront.