StoreConfig

Type: schema

TypeScript Definition

StoreConfig: {{
            /** @default false */
            is_kyc_enabled: boolean;
            /** @default false */
            is_customer_group_enabled: boolean;
            brand: components["schemas"]["Brand"];
            currency: components["schemas"]["Currency"];
            readonly customer_groups: components["schemas"]["CustomerGroup"][];
            readonly kyc_documents: components["schemas"]["KycDocumentConfig"][];
            measurement: components["schemas"]["MeasurementUnit"];
            terms_of_service: components["schemas"]["StoreTemplate"];
            refund_policy: components["schemas"]["StoreTemplate"];
        };
        /** StoreTemplate */
}

Component References

Reference	Resolves To
components["schemas"]["Brand"]	Brand
components["schemas"]["Currency"]	Currency
components["schemas"]["CustomerGroup"]	CustomerGroup
components["schemas"]["KycDocumentConfig"]	KycDocumentConfig
components["schemas"]["MeasurementUnit"]	MeasurementUnit
components["schemas"]["StoreTemplate"]	StoreTemplate

OpenAPI Schema

{
  "title": "StoreConfig",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/StoreConfig",
    "description": "API reference for the StoreConfig schema"
  },
  "required": [
    "is_kyc_enabled",
    "is_customer_group_enabled",
    "brand",
    "currency",
    "customer_groups",
    "kyc_documents",
    "measurement",
    "terms_of_service",
    "refund_policy"
  ],
  "properties": {
    "is_kyc_enabled": {
      "type": "boolean",
      "default": false
    },
    "is_customer_group_enabled": {
      "type": "boolean",
      "default": false
    },
    "brand": {
      "$ref": "#/components/schemas/Brand"
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "customer_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomerGroup"
      },
      "readOnly": true
    },
    "kyc_documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/KycDocumentConfig"
      },
      "readOnly": true
    },
    "measurement": {
      "$ref": "#/components/schemas/MeasurementUnit"
    },
    "terms_of_service": {
      "$ref": "#/components/schemas/StoreTemplate"
    },
    "refund_policy": {
      "$ref": "#/components/schemas/StoreTemplate"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions