Skip to main content
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>'
{
  "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>",
          "document_type": "gst",
          "title": "<string>",
          "description": "<string>",
          "active": true,
          "is_mandatory": true,
          "is_attachment_required": true,
          "verification_type": "auto"
        }
      ],
      "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>"
        }
      ],
      "measurement": {
        "weight": "gm",
        "dimension": "cm"
      },
      "terms_of_service": {
        "id": "<string>",
        "name": "<string>",
        "content_title": "<string>",
        "content_type": "html",
        "content": "<string>"
      },
      "refund_policy": {
        "id": "<string>",
        "name": "<string>",
        "content_title": "<string>",
        "content_type": "html",
        "content": "<string>"
      }
    }
  }
}

Authorizations

X-Api-Key
string
header
required

API key for your store

Response

OK

message
string
success
boolean
content
object