Retrieve store config
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config \
--header 'X-Api-Key: <api-key>'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"store_config": {
"is_kyc_enabled": false,
"is_customer_group_enabled": false,
"brand": {
"name": "<string>",
"logo_url": "<string>",
"social_media_links": {}
},
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"customer_groups": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"is_default": true,
"active": true
}
],
"kyc_documents": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"active": true,
"is_mandatory": true,
"is_attachment_required": true
}
],
"analytics_providers": [
{
"id": "<string>",
"name": "<string>",
"short_description": "<string>",
"features": [
{}
],
"logo_dark": "<string>",
"logo_light": "<string>",
"analytics_provider_slug": "<string>",
"api_credentials": {}
}
],
"payment_providers": [
{
"id": "<string>",
"name": "<string>",
"short_description": "<string>",
"features": [
{}
],
"logo_dark": "<string>",
"logo_light": "<string>",
"payment_provider_slug": "<string>"
}
],
"terms_of_service": {
"id": "<string>",
"name": "<string>",
"content_title": "<string>",
"content": "<string>"
},
"refund_policy": {
"id": "<string>",
"name": "<string>",
"content_title": "<string>",
"content": "<string>"
}
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"error": {}
}{
"message": "<string>",
"success": false,
"code": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>"
}Store Config
Retrieve store config
Retrieve store config detail
GET
/
store
/
config
Retrieve store config
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config \
--header 'X-Api-Key: <api-key>'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/storefront/store/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"store_config": {
"is_kyc_enabled": false,
"is_customer_group_enabled": false,
"brand": {
"name": "<string>",
"logo_url": "<string>",
"social_media_links": {}
},
"currency": {
"name": "<string>",
"code": "<string>",
"symbol": "<string>"
},
"customer_groups": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"is_default": true,
"active": true
}
],
"kyc_documents": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"active": true,
"is_mandatory": true,
"is_attachment_required": true
}
],
"analytics_providers": [
{
"id": "<string>",
"name": "<string>",
"short_description": "<string>",
"features": [
{}
],
"logo_dark": "<string>",
"logo_light": "<string>",
"analytics_provider_slug": "<string>",
"api_credentials": {}
}
],
"payment_providers": [
{
"id": "<string>",
"name": "<string>",
"short_description": "<string>",
"features": [
{}
],
"logo_dark": "<string>",
"logo_light": "<string>",
"payment_provider_slug": "<string>"
}
],
"terms_of_service": {
"id": "<string>",
"name": "<string>",
"content_title": "<string>",
"content": "<string>"
},
"refund_policy": {
"id": "<string>",
"name": "<string>",
"content_title": "<string>",
"content": "<string>"
}
}
}
}{
"message": "<string>",
"success": true,
"code": "<string>",
"error": {}
}{
"message": "<string>",
"success": false,
"code": "<string>"
}{
"message": "<string>",
"success": true,
"code": "<string>"
}Was this page helpful?
⌘I