StoreConfig
Type: schema
TypeScript Definition
typescript
StoreConfig: {{
/** @default false */
is_kyc_enabled: boolean;
/** @default false */
is_customer_group_enabled: boolean;
/** @default false */
is_loyalty_program_enabled: boolean;
tax?: components["schemas"]["TaxConfig"];
shipping?: components["schemas"]["ShippingConfig"];
customer_groups?: $Read<components["schemas"]["AdminCustomerGroup"][]>;
kyc_documents?: $Read<components["schemas"]["KycDocumentConfig"][]>;
brand?: components["schemas"]["Brand"];
subscription?: components["schemas"]["SubscriptionSetting"] | null;
general?: components["schemas"]["StoreGeneralConfig"];
currency?: $Read<components["schemas"]["AdminCurrency"]>;
credit_line?: components["schemas"]["CreditLineConfig"] | null;
payout?: components["schemas"]["PayoutConfig"];
warehouses?: $Read<components["schemas"]["StoreConfigWarehouse"][]>;
templates?: $Read<components["schemas"]["StoreConfigTemplate"][]>;
service_providers?: $Read<components["schemas"]["StoreConfigServiceProvider"][]>;
shipping_zones?: $Read<components["schemas"]["StoreConfigShippingZone"][]>;
manual_payment_methods?: $Read<components["schemas"]["ManualPaymentMethod"][]>;
/** @description `null` until the store sets a shipping cost policy. */
shipping_cost_policy?: components["schemas"]["ShippingCostPolicy"] | null;
/** @description Store inventory configuration. Falls back to `{ "reservation_strategy": "FEFO" }` when none is set. */
inventory?: $Read<{
/**
* @default FEFO
* @enum {string}
*/
reservation_strategy: "FEFO" | "FMFO";
}>;
};
/**
* StoreConfigSalesChannel
* @description Sales channel summary embedded in `StoreConfig` warehouse listings.
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["TaxConfig"] | TaxConfig |
components["schemas"]["ShippingConfig"] | ShippingConfig |
components["schemas"]["AdminCustomerGroup"] | AdminCustomerGroup |
components["schemas"]["KycDocumentConfig"] | KycDocumentConfig |
components["schemas"]["Brand"] | Brand |
components["schemas"]["SubscriptionSetting"] | SubscriptionSetting |
components["schemas"]["StoreGeneralConfig"] | StoreGeneralConfig |
components["schemas"]["AdminCurrency"] | AdminCurrency |
components["schemas"]["CreditLineConfig"] | CreditLineConfig |
components["schemas"]["PayoutConfig"] | PayoutConfig |
components["schemas"]["StoreConfigWarehouse"] | StoreConfigWarehouse |
components["schemas"]["StoreConfigTemplate"] | StoreConfigTemplate |
components["schemas"]["StoreConfigServiceProvider"] | StoreConfigServiceProvider |
components["schemas"]["StoreConfigShippingZone"] | StoreConfigShippingZone |
components["schemas"]["ManualPaymentMethod"] | ManualPaymentMethod |
components["schemas"]["ShippingCostPolicy"] | ShippingCostPolicy |
OpenAPI Schema
json
{
"title": "StoreConfig",
"type": "object",
"properties": {
"is_kyc_enabled": {
"type": "boolean",
"default": false
},
"is_customer_group_enabled": {
"type": "boolean",
"default": false
},
"is_loyalty_program_enabled": {
"type": "boolean",
"default": false
},
"tax": {
"$ref": "#/components/schemas/TaxConfig"
},
"shipping": {
"$ref": "#/components/schemas/ShippingConfig"
},
"customer_groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminCustomerGroup"
},
"readOnly": true
},
"kyc_documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KycDocumentConfig"
},
"readOnly": true
},
"brand": {
"$ref": "#/components/schemas/Brand"
},
"subscription": {
"anyOf": [
{
"$ref": "#/components/schemas/SubscriptionSetting"
},
{
"type": "null"
}
]
},
"general": {
"$ref": "#/components/schemas/StoreGeneralConfig"
},
"currency": {
"$ref": "#/components/schemas/AdminCurrency",
"readOnly": true
},
"credit_line": {
"anyOf": [
{
"$ref": "#/components/schemas/CreditLineConfig"
},
{
"type": "null"
}
]
},
"payout": {
"$ref": "#/components/schemas/PayoutConfig"
},
"warehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StoreConfigWarehouse"
},
"readOnly": true
},
"templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StoreConfigTemplate"
},
"readOnly": true
},
"service_providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StoreConfigServiceProvider"
},
"readOnly": true
},
"shipping_zones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StoreConfigShippingZone"
},
"readOnly": true
},
"manual_payment_methods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManualPaymentMethod"
},
"readOnly": true
},
"shipping_cost_policy": {
"description": "`null` until the store sets a shipping cost policy.",
"anyOf": [
{
"$ref": "#/components/schemas/ShippingCostPolicy"
},
{
"type": "null"
}
]
},
"inventory": {
"description": "Store inventory configuration. Falls back to `{ \"reservation_strategy\": \"FEFO\" }` when none is set.",
"type": "object",
"properties": {
"reservation_strategy": {
"type": "string",
"default": "FEFO",
"enum": [
"FEFO",
"FMFO"
]
}
},
"readOnly": true
}
},
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions