# openapi.api.ShopConfigApi ## Load the API package ```dart import 'package:openapi/api.dart'; ``` All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**addDomain**](ShopConfigApi.md#adddomain) | **POST** /api/shop-config/add-domain | [**addGscKey**](ShopConfigApi.md#addgsckey) | **POST** /api/shop-config/add-gsc-key | [**changeDefaultLocation**](ShopConfigApi.md#changedefaultlocation) | **PATCH** /api/shop-config/location/change-default/{id} | Change default location [**changeLocationStatus**](ShopConfigApi.md#changelocationstatus) | **POST** /api/shop-config/location/status/{id} | Change location status [**checkShopUser**](ShopConfigApi.md#checkshopuser) | **POST** /api/shop-config/get/shop-user | [**createLocation**](ShopConfigApi.md#createlocation) | **POST** /api/shop-config/location/create | Create location [**domains**](ShopConfigApi.md#domains) | **GET** /api/shop-config/domains | Get domains [**getConfig**](ShopConfigApi.md#getconfig) | **GET** /api/shop-config/getConfig | Get shop config [**getEditorThemeConfig**](ShopConfigApi.md#geteditorthemeconfig) | **GET** /api/shop-config/get-editor-theme | [**getGsc**](ShopConfigApi.md#getgsc) | **GET** /api/shop-config/gsc | Get Google Search Console [**getModules**](ShopConfigApi.md#getmodules) | **GET** /api/shop-config/modules | Get shop modules [**getShopConfig**](ShopConfigApi.md#getshopconfig) | **POST** /api/shop-config/get/shop-config | Get shop config [**getShopSeo**](ShopConfigApi.md#getshopseo) | **GET** /api/shop-config/shop-seo | Get shop seo [**getThemeConfig**](ShopConfigApi.md#getthemeconfig) | **GET** /api/shop-config/get-theme | [**taxes**](ShopConfigApi.md#taxes) | **POST** /api/shop-config/taxes | Update tax [**updateAddress**](ShopConfigApi.md#updateaddress) | **PATCH** /api/shop-config/address/update | Update address [**updateContactInformation**](ShopConfigApi.md#updatecontactinformation) | **PATCH** /api/shop-config/contact-information/update | Update contact information [**updateCurrencies**](ShopConfigApi.md#updatecurrencies) | **POST** /api/shop-config/currencies | Update currencies [**updateFormat**](ShopConfigApi.md#updateformat) | **PATCH** /api/shop-config/format/update | Update format [**updateGeneralInformation**](ShopConfigApi.md#updategeneralinformation) | **PATCH** /api/shop-config/general-information/update | Update general information [**updateLanguages**](ShopConfigApi.md#updatelanguages) | **POST** /api/shop-config/languages | Update Languages [**updateLocation**](ShopConfigApi.md#updatelocation) | **PATCH** /api/shop-config/location/update/{id} | Update location # **addDomain** > String addDomain(addDomainDto) ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final AddDomainDto addDomainDto = ; // AddDomainDto | try { final response = api.addDomain(addDomainDto); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->addDomain: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **addDomainDto** | [**AddDomainDto**](AddDomainDto.md)| | ### Return type **String** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **addGscKey** > GSCEntity addGscKey(addGSCKey) ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final AddGSCKey addGSCKey = ; // AddGSCKey | try { final response = api.addGscKey(addGSCKey); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->addGscKey: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **addGSCKey** | [**AddGSCKey**](AddGSCKey.md)| | ### Return type [**GSCEntity**](GSCEntity.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **changeDefaultLocation** > OkRes changeDefaultLocation(id) Change default location ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final num id = 8.14; // num | try { final response = api.changeDefaultLocation(id); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->changeDefaultLocation: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **num**| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **changeLocationStatus** > OkRes changeLocationStatus(id) Change location status ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final num id = 8.14; // num | try { final response = api.changeLocationStatus(id); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->changeLocationStatus: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **num**| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **checkShopUser** > ShopUserEntity checkShopUser() ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); try { final response = api.checkShopUser(); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->checkShopUser: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ShopUserEntity**](ShopUserEntity.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **createLocation** > OkRes createLocation(createLocationBody) Create location ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final CreateLocationBody createLocationBody = ; // CreateLocationBody | try { final response = api.createLocation(createLocationBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->createLocation: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createLocationBody** | [**CreateLocationBody**](CreateLocationBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **domains** > DomainEntity domains() Get domains ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); try { final response = api.domains(); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->domains: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**DomainEntity**](DomainEntity.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getConfig** > GetConfigResponse getConfig() Get shop config ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); try { final response = api.getConfig(); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->getConfig: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**GetConfigResponse**](GetConfigResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getEditorThemeConfig** > GetThemeResponse getEditorThemeConfig(templateId) ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final String templateId = templateId_example; // String | try { final response = api.getEditorThemeConfig(templateId); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->getEditorThemeConfig: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **String**| | [optional] ### Return type [**GetThemeResponse**](GetThemeResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getGsc** > GetGSCRes getGsc() Get Google Search Console ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); try { final response = api.getGsc(); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->getGsc: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**GetGSCRes**](GetGSCRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getModules** > GetModuleRes getModules() Get shop modules ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); try { final response = api.getModules(); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->getModules: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**GetModuleRes**](GetModuleRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getShopConfig** > ShopConfigEntity getShopConfig() Get shop config ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); try { final response = api.getShopConfig(); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->getShopConfig: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ShopConfigEntity**](ShopConfigEntity.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getShopSeo** > GetSeoRes getShopSeo() Get shop seo ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); try { final response = api.getShopSeo(); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->getShopSeo: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**GetSeoRes**](GetSeoRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getThemeConfig** > GetThemeResponse getThemeConfig(templateId) ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final String templateId = templateId_example; // String | try { final response = api.getThemeConfig(templateId); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->getThemeConfig: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **String**| | [optional] ### Return type [**GetThemeResponse**](GetThemeResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **taxes** > TaxEntity taxes(taxBody) Update tax ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final TaxBody taxBody = ; // TaxBody | try { final response = api.taxes(taxBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->taxes: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **taxBody** | [**TaxBody**](TaxBody.md)| | ### Return type [**TaxEntity**](TaxEntity.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateAddress** > OkRes updateAddress(updateAddressBody) Update address ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final UpdateAddressBody updateAddressBody = ; // UpdateAddressBody | try { final response = api.updateAddress(updateAddressBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->updateAddress: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateAddressBody** | [**UpdateAddressBody**](UpdateAddressBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateContactInformation** > OkRes updateContactInformation(updateContactInformationBody) Update contact information ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final UpdateContactInformationBody updateContactInformationBody = ; // UpdateContactInformationBody | try { final response = api.updateContactInformation(updateContactInformationBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->updateContactInformation: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateContactInformationBody** | [**UpdateContactInformationBody**](UpdateContactInformationBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateCurrencies** > OkRes updateCurrencies(updateShopCurrenciesBody) Update currencies ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final UpdateShopCurrenciesBody updateShopCurrenciesBody = ; // UpdateShopCurrenciesBody | try { final response = api.updateCurrencies(updateShopCurrenciesBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->updateCurrencies: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateShopCurrenciesBody** | [**UpdateShopCurrenciesBody**](UpdateShopCurrenciesBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateFormat** > OkRes updateFormat(updateConfigFormatBody) Update format ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final UpdateConfigFormatBody updateConfigFormatBody = ; // UpdateConfigFormatBody | try { final response = api.updateFormat(updateConfigFormatBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->updateFormat: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateConfigFormatBody** | [**UpdateConfigFormatBody**](UpdateConfigFormatBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateGeneralInformation** > OkRes updateGeneralInformation(updateGeneralInformationBody) Update general information ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final UpdateGeneralInformationBody updateGeneralInformationBody = ; // UpdateGeneralInformationBody | try { final response = api.updateGeneralInformation(updateGeneralInformationBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->updateGeneralInformation: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateGeneralInformationBody** | [**UpdateGeneralInformationBody**](UpdateGeneralInformationBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateLanguages** > OkRes updateLanguages(updateShopLanguagesBody) Update Languages ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final UpdateShopLanguagesBody updateShopLanguagesBody = ; // UpdateShopLanguagesBody | try { final response = api.updateLanguages(updateShopLanguagesBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->updateLanguages: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateShopLanguagesBody** | [**UpdateShopLanguagesBody**](UpdateShopLanguagesBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateLocation** > OkRes updateLocation(id, updateLocationBody) Update location ### Example ```dart import 'package:openapi/api.dart'; final api = Openapi().getShopConfigApi(); final num id = 8.14; // num | final UpdateLocationBody updateLocationBody = ; // UpdateLocationBody | try { final response = api.updateLocation(id, updateLocationBody); print(response); } catch on DioError (e) { print('Exception when calling ShopConfigApi->updateLocation: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **num**| | **updateLocationBody** | [**UpdateLocationBody**](UpdateLocationBody.md)| | ### Return type [**OkRes**](OkRes.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)