# Online store detail (deprecated)

This endpoint is deprecated. 
Use the general sales channels endpoint (/api/sales-channels/{guid}) instead.

Information about the detail of the online store. This endpoint is available only when the 'Multishop' module is active.

Endpoint: GET /api/online-stores/{id}
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Path parameters:

  - `id` (integer, required)
    Online store ID
    Example: 1

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.onlineStore` (object, required)

  - `data.onlineStore.id` (integer, required)
    Online store identifier.

  - `data.onlineStore.name` (string)
    Name of online store.

  - `data.onlineStore.status` (string, required)
    Online store status
    Enum: "active", "pending"

  - `data.onlineStore.domain` (string)
    Online store domain.

  - `data.onlineStore.domainSetupMethod` (string,null)
    Online store domain setup method.

  - `data.onlineStore.addressFormat` (string)
    Address format of online store.

  - `data.onlineStore.timezone` (string)
    Timezone of online store.

  - `data.onlineStore.defaultCountry` (object,null)
    Default country of online store.

  - `data.onlineStore.defaultCountry.id` (integer, required)
    Country identifier.

  - `data.onlineStore.defaultCountry.name` (string, required)
    Country name.

  - `data.onlineStore.defaultCountry.code` (string, required)
    Country code.

  - `data.onlineStore.defaultCountry.isoCode` (string)
    Country ISO code.

  - `data.onlineStore.defaultCountry.flagCode` (string)
    Country flag code.

  - `data.onlineStore.defaultCountry.codeAlpha3` (string, required)
    Country alpha-3 code.

  - `data.onlineStore.defaultCountry.currency` (string,null)
    Country currency.

  - `data.onlineStore.defaultCountry.language` (string,null)
    Country language.

  - `data.onlineStore.defaultCountry.regionCount` (integer)
    Region count of country.

  - `data.onlineStore.countries` (array)
    Countries of online store.

  - `data.onlineStore.countries.id` (integer, required)
    Country identifier.

  - `data.onlineStore.countries.name` (string, required)
    Country name.

  - `data.onlineStore.countries.code` (string, required)
    Country code.

  - `data.onlineStore.countries.isoCode` (string)
    Country ISO code.

  - `data.onlineStore.countries.flagCode` (string)
    Country flag code.

  - `data.onlineStore.countries.codeAlpha3` (string, required)
    Country alpha-3 code.

  - `data.onlineStore.countries.currency` (string,null)
    Country currency.

  - `data.onlineStore.countries.language` (string,null)
    Country language.

  - `data.onlineStore.countries.regionCount` (integer)
    Region count of country.

  - `data.onlineStore.salesChannel` (object,null)
    Online store sales channel.

  - `data.onlineStore.salesChannel.guid` (string, required)
    Sales channel GUID.

  - `data.onlineStore.salesChannel.name` (string, required)
    Sales channel name.

  - `data.onlineStore.salesChannel.type` (any, required)
    Type of sales channel.
    Enum: "in_store", "market", "marketplace"

  - `data.onlineStore.salesChannel.defaultCurrency` (string)
    Sales channel default currency.

  - `data.onlineStore.salesChannel.currencies` (array, required)
    Currencies collection.

  - `data.onlineStore.salesChannel.currencies.id` (integer, required)
    Currency id.

  - `data.onlineStore.salesChannel.currencies.code` (string, required)
    Currency code. List of available currencies within the e-shop can be found in endpoint GET /api/eshop.

  - `data.onlineStore.salesChannel.currencies.title` (string, required)
    Currency title.

  - `data.onlineStore.salesChannel.currencies.symbol` (string, required)
    Currency symbol.

  - `data.onlineStore.salesChannel.currencies.isSymbolOnLeft` (boolean, required)
    Whether the currency symbol is on left side.

  - `data.onlineStore.salesChannel.currencies.precision` (integer, required)
    Currency precision.

  - `data.onlineStore.salesChannel.currencies.priority` (integer,null)
    Currency priority.

  - `data.onlineStore.salesChannel.currencies.decimalSeparator` (string, required)
    Currency decimal separator.

  - `data.onlineStore.salesChannel.currencies.thousandSeparator` (string,null, required)
    Currency thousand separator.

  - `data.onlineStore.salesChannel.currencies.documentPrecision` (integer, required)
    Document precision.

  - `data.onlineStore.salesChannel.currencies.rounding` (integer, required)
    Currency rounding.

  - `data.onlineStore.salesChannel.defaultLanguage` (string)
    Sales channel default language.

  - `data.onlineStore.salesChannel.languages` (array, required)
    Languages collection.

  - `data.onlineStore.salesChannel.languages.id` (integer, required)
    Language id.

  - `data.onlineStore.salesChannel.languages.name` (string, required)
    Language name.

  - `data.onlineStore.salesChannel.languages.indexName` (string, required)
    Language index name.

  - `data.onlineStore.salesChannel.languages.dateFormat` (string, required)
    Date format of language.

  - `data.onlineStore.salesChannel.languages.timeFormat` (string, required)
    Time format of language.

  - `data.onlineStore.salesChannel.languages.isVisible` (boolean, required)
    Whether the language is visible.

  - `data.onlineStore.salesChannel.languages.isBlocked` (boolean, required)
    Whether the language is blocked.

  - `data.onlineStore.salesChannel.languages.priority` (integer,null, required)
    Language priority.

  - `data.onlineStore.salesChannel.languages.locale` (string, required)
    Locale of language.

  - `data.onlineStore.salesChannel.createdAt` (string, required)

  - `data.onlineStore.salesChannel.updatedAt` (string,null, required)

  - `data.onlineStore.isPasswordProtected` (boolean, required)
    Whether the online store is protected by password.

  - `data.onlineStore.isPrimary` (boolean, required)
    Whether the online store is primary.

  - `data.onlineStore.design` (object)
    Online store design.

  - `data.onlineStore.design.header` (object, required)

  - `data.onlineStore.design.header.logoUrl` (string,null, required)
    URL of online store logo.

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

  - `metadata` (object, required)

  - `metadata.requestId` (string, required)
    Request identifier. Useful for logging/reporting purposes.

## Response 403 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

  - `metadata` (object)

  - `metadata.requestId` (string, required)
    Request identifier. Useful for logging/reporting purposes.

## Response 404 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

  - `metadata` (object)

  - `metadata.requestId` (string, required)
    Request identifier. Useful for logging/reporting purposes.